frame

package

v1.3.0 Latest Latest Go to latest Published: Jan 4, 2026 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/boloc/go-frame-server

Links

Open Source Insights

Documentation ¶

Index ¶

func ClickHouse(name string) driver.Conn
func ClickHouseDB(name string) *gorm.DB
func DefaultClickHouse() driver.Conn
func DefaultClickHouseDB() *gorm.DB
func DefaultDB() *gorm.DB
func DefaultSlaveDB() *gorm.DB
func GetRedis() *redis.Client
func GetRedisCluster() *redis.ClusterClient
func GetRedisCmdable() redis.Cmdable
func MasterDB(name string) *gorm.DB
func SlaveDB(name string) *gorm.DB
type Component
type Frame
- func New(opts ...Option) *Frame
type FrameConfig
type Hook
type Option
- func WithConfigFile(configFile string) Option
- func WithShutdownTimeout(timeout time.Duration) Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ClickHouse ¶ added in v1.1.7

func ClickHouse(name string) driver.Conn

ClickHouse 获取指定名称的ClickHouse原生连接

func ClickHouseDB ¶ added in v1.1.9

func ClickHouseDB(name string) *gorm.DB

ClickHouseDB 获取指定名称的ClickHouse GORM DB

func DefaultClickHouse ¶ added in v1.1.7

func DefaultClickHouse() driver.Conn

DefaultClickHouse 获取默认ClickHouse原生连接

func DefaultClickHouseDB ¶ added in v1.1.9

func DefaultClickHouseDB() *gorm.DB

DefaultClickHouseDB 获取默认ClickHouse GORM DB

func DefaultDB ¶

func DefaultDB() *gorm.DB

DefaultDB 获取默认实例的主库连接

func DefaultSlaveDB ¶

func DefaultSlaveDB() *gorm.DB

DefaultSlaveDB 获取默认实例的从库连接

func GetRedis ¶

func GetRedis() *redis.Client

获取全局Redis单机实例

func GetRedisCluster ¶

func GetRedisCluster() *redis.ClusterClient

获取全局Redis集群实例

func GetRedisCmdable ¶ added in v1.3.0

func GetRedisCmdable() redis.Cmdable

获取通用Redis接口（自动适配单机/集群）

优先返回集群实例，其次返回单机实例业务代码使用此方法无需关心底层是单机还是集群

func MasterDB ¶ added in v1.3.0

func MasterDB(name string) *gorm.DB

MasterDB 获取指定实例的主库连接

func SlaveDB ¶

func SlaveDB(name string) *gorm.DB

SlaveDB 获取指定实例的从库连接

Types ¶

type Component ¶

type Component interface {
	// Start 启动组件
	Start(ctx context.Context) error
	// Stop 停止组件
	Stop(ctx context.Context) error
}

Component 定义组件接口

type Frame ¶

type Frame struct {
	// contains filtered or unexported fields
}

Frame 框架核心结构

func New ¶

func New(opts ...Option) *Frame

New 创建新的框架实例

func (*Frame) AfterStart ¶ added in v1.0.6

func (f *Frame) AfterStart(hook Hook) *Frame

AfterStart 注册启动后的钩子函数

func (*Frame) BeforeStop ¶ added in v1.0.6

func (f *Frame) BeforeStop(hook Hook) *Frame

BeforeStop 注册停止前的钩子函数

func (*Frame) Config ¶ added in v1.3.0

func (f *Frame) Config() *config.ConfigComponent

Config 获取应用配置

func (*Frame) RegisterComponent ¶

func (f *Frame) RegisterComponent(component Component)

RegisterComponent 注册组件

func (*Frame) Run ¶

func (f *Frame) Run() error

Run 运行框架并处理信号

func (*Frame) SetLogger ¶

func (f *Frame) SetLogger(logger *zap.Logger)

SetLogger 设置日志记录器

func (*Frame) Start ¶

func (f *Frame) Start(ctx context.Context) error

Start 启动框架

func (*Frame) Stop ¶

func (f *Frame) Stop(ctx context.Context) error

Stop 停止框架

type FrameConfig ¶

type FrameConfig struct {
	ShutdownTimeout time.Duration
	ConfigFile      string // 配置文件路径
}

FrameConfig 框架配置

type Hook ¶ added in v1.0.6

type Hook func(ctx context.Context) error

Hook 定义钩子函数类型

type Option ¶

type Option func(*Frame)

Option 定义框架选项函数类型

func WithConfigFile ¶ added in v1.3.0

func WithConfigFile(configFile string) Option

WithConfigFile 设置配置文件路径（可被 -c 命令行参数覆盖）

func WithShutdownTimeout ¶

func WithShutdownTimeout(timeout time.Duration) Option

WithShutdownTimeout 设置关闭超时时间

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
client
components
config
content
middleware
pagination

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL