sail

Documentation

Index

• func GetDB() (read *gorm.DB, write *gorm.DB)
• func GetDBR() *gorm.DB
• func GetDBW() *gorm.DB
• func GetEtcdInstance() *clientv3.Client
• func GetKafkaConnections() []*kafkaLib.Conn
• func GetKafkaInstance() *kafka.Instance
• func GetKafkaReader() *kafkaLib.Reader
• func GetKafkaWriter() *kafkaLib.Writer
• func GetLogger(module ...string) *zap.Logger
• func GetNats() *natsLib.Conn
• func GetRedis() *redisLib.Client
• func GetRedisCluster() *redisLib.ClusterClient
• func Response(c *gin.Context) api.Responder
• type Launcher
  • func (l *Launcher) Launch()
• type Launchpad
• type Sail
  • func (s *Sail) EnableWebsocket(ws *websocket.Conn, handler func(ws *websocket.Conn), ...) Sailor
  • func (s *Sail) Hook(registerRoutes func(ginEngine *gin.Engine), beforeFunc, afterFunc func()) Launchpad
  • func (s *Sail) SetupApiOption(opt *api.Option) Sailor
• type Sailor
  • func WakeupHttp(appName string, conf *config.Config) Sailor

Functions

func GetDB

func GetDB() (read *gorm.DB, write *gorm.DB)

GetDB 获取数据库实例

该方法依次返回读实例、写实例

注意，使用前请确保db组件已初始化成功。

func GetDBR

func GetDBR() *gorm.DB

GetDBR 获取数据库读实例

注意，使用前请确保db组件已初始化成功。

func GetDBW

func GetDBW() *gorm.DB

GetDBW 获取数据库写实例

注意，使用前请确保db组件已初始化成功。

func GetEtcdInstance

func GetEtcdInstance() *clientv3.Client

GetEtcdInstance 获取etcd连接实例

注意，使用前请确保etcd组件已初始化成功。

func GetKafkaConnections

func GetKafkaConnections() []*kafkaLib.Conn

GetKafkaConnections 获取kafka连接

注意，使用前请确保kafka组件已初始化成功。

func GetKafkaInstance

func GetKafkaInstance() *kafka.Instance

GetKafkaInstance 获取kafka完整实例

注意，使用前请确保kafka组件已初始化成功。

func GetKafkaReader

func GetKafkaReader() *kafkaLib.Reader

GetKafkaReader 获取kafka读实例

注意，使用前请确保kafka组件已初始化成功。

func GetKafkaWriter

func GetKafkaWriter() *kafkaLib.Writer

GetKafkaWriter 获取kafka写实例

注意，使用前请确保kafka组件已初始化成功。

func GetLogger

func GetLogger(module ...string) *zap.Logger

GetLogger 获取日志实例

注意，使用前请确保logger组件已初始化成功。

func GetNats

func GetNats() *natsLib.Conn

GetNats 获取nats连接实例

注意，使用前请确保nats组件已初始化成功。

func GetRedis

func GetRedis() *redisLib.Client

GetRedis 获取redis连接(standalone)

单实例模式

注意，使用前请确保redis(standalone)组件已初始化成功。

func GetRedisCluster

func GetRedisCluster() *redisLib.ClusterClient

GetRedisCluster 获取redis连接(cluster)

cluster集群模式

注意，使用前请确保redis(cluster)组件已初始化成功。

func Response

func Response(c *gin.Context) api.Responder

Response http响应组件

Types

type Launcher

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

Launcher 启动器

func (*Launcher) Launch

func (l *Launcher) Launch()

Launch 启动

type Launchpad

type Launchpad interface {
	// Launch 启动
	Launch()
}

Launchpad 启动台

type Sail

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

Sail 框架配置

func (*Sail) EnableWebsocket

func (s *Sail) EnableWebsocket(ws *websocket.Conn, handler func(ws *websocket.Conn), middlewares ...gin.HandlerFunc) Sailor

EnableWebsocket 启动websocket服务

routePath 路由地址

ws websocket连接实例，若为空，则启动默认的连接实例

handler 处理函数，若为空，则启动`defaultWebsocketHandlerFunc`默认处理函数

func (*Sail) Hook

func (s *Sail) Hook(registerRoutes func(ginEngine *gin.Engine), beforeFunc, afterFunc func()) Launchpad

Hook 挂载相关方法

registerRoutes 注册路由函数

beforeFunc 前置自定义处理函数（可选），在框架函数之前执行

注意beforeFunc是异步执行的，另外此时组件尚未初始化，因此在此函数内调用组件将会出现空指针异常（panic）。

afterFunc 后置自定义处理函数（可选），在框架函数之后执行

注意afterFunc是异步执行的，另外此时组件已经按配置初始化完成，可以按需调用。

func (*Sail) SetupApiOption

func (s *Sail) SetupApiOption(opt *api.Option) Sailor

SetupApiOption

设置统一返回配置

type Sailor

type Sailor interface {
	// SetupApiOption
	//
	// 设置统一返回配置
	SetupApiOption(opt *api.Option) Sailor
	// EnableWebsocket 启动websocket服务
	//
	// ws websocket连接实例，若为空，则启动默认配置连接
	//
	// handler 处理函数，若为空，则启用默认处理函数（仅打印接收到的message信息）
	//
	// middlewares 路由中间件
	EnableWebsocket(ws *websocket.Conn, handler func(ws *websocket.Conn), middlewares ...gin.HandlerFunc) Sailor
	// Hook 挂载相关方法
	//
	// registerRoutes 注册路由函数
	//
	// beforeFunc 前置自定义处理函数（可选），在框架函数之前执行
	//
	// 注意beforeFunc是异步执行的，另外此时组件尚未初始化，因此在此函数内调用组件将会出现空指针异常（panic）。
	//
	// afterFunc 后置自定义处理函数（可选），在框架函数之后执行
	//
	// 注意afterFunc是异步执行的，另外此时组件已经按配置初始化完成，可以按需调用。
	Hook(registerRoutes func(ginEngine *gin.Engine), beforeFunc, afterFunc func()) Launchpad
}

Sailor 船员就位

func WakeupHttp

func WakeupHttp(appName string, conf *config.Config) Sailor

WakeupHttp 唤醒http

启动前的配置准备

appName 应用名称

conf 配置文件