componentKit

Documentation

Index

• Variables
• func GetAddress() (string, error)
• func GetGinConfig() (*ginKit.GinConfig, error)
• func GetIp() (string, error)
• func GetLogrusConfig() (*logrusKit.LogrusConfig, error)
• func GetRedisClient() *redisKit.Client
• func GetRedisConfig() (*redisKit.RedisConfig, error)
• func GetRocketmq5Config() (*rocketmq5Kit.Config, error)
• func GetStartingTime() time.Time
• func InitializeEnvironment() error
• func InitializeGinComponent(recoveryMiddleware gin.HandlerFunc, business func(engine *gin.Engine) error) error
• func InitializeJsonComponent(messageFilePath string, messageHook jsonKit.MessageHook, ...) error
• func InitializeRedisComponent() error
• func InitializeRocketMQ5Component() error
• func NewProducerOfRocketmq5(logConfig *rocketmq5Kit.LogConfig) (rmq_client.Producer, error)
• func NewSimpleConsumerOfRocketmq5(logConfig *rocketmq5Kit.LogConfig, consumerGroup, topic, tag string) (rmq_client.SimpleConsumer, error)
• type EnvConfig
• type RuntimeConfig
  • func GetRuntimeConfig() (*RuntimeConfig, error)

Variables

var (
	EnvNotLoadedError     = errorKit.Simple("env file hasn't been loaded")
	EnvAlreadyLoadedError = errorKit.Simple("env file has already been loaded")
)

Functions

func GetAddress

func GetAddress() (string, error)

GetAddress 获取当前服务的地址

func GetGinConfig

func GetGinConfig() (*ginKit.GinConfig, error)

GetGinConfig

@return 两个返回值中必定有一个不为nil（因为有默认值）

func GetIp

func GetIp() (string, error)

func GetLogrusConfig

func GetLogrusConfig() (*logrusKit.LogrusConfig, error)

GetLogrusConfig

@return 两个返回值中必定有一个不为nil（因为有默认值）

func GetRedisClient

func GetRedisClient() *redisKit.Client

GetRedisClient

@return 如果Redis组件未被初始化，将返回nil

func GetRedisConfig

func GetRedisConfig() (*redisKit.RedisConfig, error)

GetRedisConfig

@return 两个返回值有可能都为nil（因为没有默认值）

func GetRocketmq5Config

func GetRocketmq5Config() (*rocketmq5Kit.Config, error)

GetRocketmq5Config

@return 两个返回值有可能都为nil（因为没有默认值）

func GetStartingTime

func GetStartingTime() time.Time

func InitializeEnvironment

func InitializeEnvironment() error

InitializeEnvironment 加载 env.yaml; 初始化组件: logrus、runtime

@param pathArgs 第1个值代表（如果有的话）: env.yaml的相对路径

func InitializeGinComponent

func InitializeGinComponent(recoveryMiddleware gin.HandlerFunc, business func(engine *gin.Engine) error) error

InitializeGinComponent 初始化Gin组件（可选）

PS: 由于会阻塞当前goroutine，建议在业务的最后调用此方法.

@param recoveryMiddleware 可以为nil，将采用默认值 gin.Recovery() @param businessLogic 可以为nil；会在启动Gin服务前调用（非nil的话）

func InitializeJsonComponent

func InitializeJsonComponent(messageFilePath string, messageHook jsonKit.MessageHook, responseHook jsonKit.ResponseHook) error

InitializeJsonComponent 初始化json组件（可选）

@param messageFilePath （存储code和msg映射关系的）文件的路径（相对 || 绝对），如果为空则不读取message文件 @param msgProcessor 可以为nil，对响应结构体中的message进行二开，比如可以加上: 是哪台服务响应的 @param respProcess 可以为nil，对响应结构体进行二开，以修改序列化为json字符串时的key

func InitializeRedisComponent

func InitializeRedisComponent() error

InitializeRedisComponent 初始化Redis组件（可选）

func InitializeRocketMQ5Component

func InitializeRocketMQ5Component() error

func NewProducerOfRocketmq5

func NewProducerOfRocketmq5(logConfig *rocketmq5Kit.LogConfig) (rmq_client.Producer, error)

NewProducerOfRocketmq5

!!!: 返回的 rmq_client.Producer 实例要手动调用 Start()（error为nil的情况）.

@param logConfig 可以为nil

func NewSimpleConsumerOfRocketmq5

func NewSimpleConsumerOfRocketmq5(logConfig *rocketmq5Kit.LogConfig, consumerGroup, topic, tag string) (rmq_client.SimpleConsumer, error)

NewSimpleConsumerOfRocketmq5

!!!: 返回的 rmq_client.SimpleConsumer 实例要手动调用 Start()（error为nil的情况）.

@param logConfig 可以为nil

Types

type EnvConfig

type EnvConfig struct {
	Ip string

	Runtime *RuntimeConfig
	Logrus  *logrusKit.LogrusConfig
	Gin     *ginKit.GinConfig
	Redis   *redisKit.RedisConfig

	RocketMQ5 *rocketmq5Kit.Config
}

type RuntimeConfig

type RuntimeConfig struct {
	// 软内存限制（如果remove space后为""或"-1"，将不进行设置）
	SoftMemoryLimit string
}

func GetRuntimeConfig

func GetRuntimeConfig() (*RuntimeConfig, error)

GetRuntimeConfig

@return 有可能2个返回值都为nil