frame

package

v1.0.7 Latest Latest Go to latest Published: Mar 25, 2025 License: MIT Imports: 11 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 DB(name string) *gorm.DB
func DefaultDB() *gorm.DB
func DefaultSlaveDB() *gorm.DB
func GetRedis() *redis.Client
func GetRedisCluster() *redis.ClusterClient
func SlaveDB(name string) *gorm.DB
type Component
type Frame
- func New(opts ...Option) *Frame
type FrameConfig
type Hook
type Option
- func WithShutdownTimeout(timeout time.Duration) Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DB ¶

func DB(name string) *gorm.DB

保留原有的命名实例访问方法

func DefaultDB ¶

func DefaultDB() *gorm.DB

默认实例的全局访问方法

func DefaultSlaveDB ¶

func DefaultSlaveDB() *gorm.DB

默认实例的从库访问方法

func GetRedis ¶

func GetRedis() *redis.Client

GetRedis 获取全局Redis单机实例

func GetRedisCluster ¶

func GetRedisCluster() *redis.ClusterClient

GetRedisCluster 获取全局Redis集群实例

func SlaveDB ¶

func SlaveDB(name string) *gorm.DB

ReplicaDB 获取从库连接

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) 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
}

FrameConfig 框架配置

type Hook ¶ added in v1.0.6

type Hook func(ctx context.Context) error

Hook 定义钩子函数类型

type Option ¶

type Option func(*Frame)

Option 定义框架选项函数类型

func WithShutdownTimeout ¶

func WithShutdownTimeout(timeout time.Duration) Option

WithShutdownTimeout 设置关闭超时时间

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
components
config
content
middleware

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