appbox

README

go-blackbox

go集成常用开发框架-快速开发 目前已集成：

1. iris web服务端
2. gorm 数据库持久化操作
3. redis 缓存客户端
4. MongoDB客户端
5. RabiitMq 工具类
6. RSA非对称加密工具类
7. 邮件发送服务

Documentation

Index

• func CronJobSingle() *cron.Cron
• func GlobalCtx() *etc.GlobalContext
• func GormDb() *gorm.DB
• func New() (app *application)
• func RedisCache() cache.Rediser
• type Application
• type ApplicationBuild
  • func (app *ApplicationBuild) EnableCache(ctx context.Context, redConfig cache.RedisOptions) *ApplicationBuild
  • func (app *ApplicationBuild) EnableDb(dbConfig *datasource.PostgresConfig, models []interface{}) *ApplicationBuild
  • func (app *ApplicationBuild) EnableMongoDB(dbConfig *mongodb.MongoDBConfig) *ApplicationBuild
  • func (app *ApplicationBuild) EnableWeb(timeFormat, port, logLevel string, components webiris.PartyComponent) *ApplicationBuild
  • func (app *ApplicationBuild) InitCronJob() *ApplicationBuild
  • func (app *ApplicationBuild) InitLog(outDirPath, level string) *ApplicationBuild
  • func (app *ApplicationBuild) LoadConfig(configStruct interface{}, loaderFun func(loadconf.Loader)) error
  • func (app *ApplicationBuild) SetSeeds(seedFuncs ...seed.SeedFunc) *ApplicationBuild
• type ApplicationBuilder

Functions

func CronJobSingle

func CronJobSingle() *cron.Cron

func GlobalCtx

func GlobalCtx() *etc.GlobalContext

func GormDb

func GormDb() *gorm.DB

func New

func New() (app *application)

func RedisCache

func RedisCache() cache.Rediser

Types

type Application

type Application interface {
	Start(builder func(ctx context.Context, builder *ApplicationBuild) error) error
}

type ApplicationBuild

type ApplicationBuild struct {

	// 是否启动定时服务，在enableCronjob后为true，会自动start()
	IsRunningCronJob bool
	// contains filtered or unexported fields
}

func (*ApplicationBuild) EnableCache

func (app *ApplicationBuild) EnableCache(ctx context.Context, redConfig cache.RedisOptions) *ApplicationBuild

EnableCache 启动缓存

func (*ApplicationBuild) EnableDb

func (app *ApplicationBuild) EnableDb(dbConfig *datasource.PostgresConfig, models []interface{}) *ApplicationBuild

EnableDb 启动数据库操作对象

func (*ApplicationBuild) EnableMongoDB

func (app *ApplicationBuild) EnableMongoDB(dbConfig *mongodb.MongoDBConfig) *ApplicationBuild

EnableMongoDB 启动MongoDB客户端

func (*ApplicationBuild) EnableWeb

func (app *ApplicationBuild) EnableWeb(timeFormat, port, logLevel string, components webiris.PartyComponent) *ApplicationBuild

EnableWeb 启动Web服务

func (*ApplicationBuild) InitCronJob

func (app *ApplicationBuild) InitCronJob() *ApplicationBuild

InitCronJob 初始化定时任务对象，存放入IOC

func (*ApplicationBuild) InitLog

func (app *ApplicationBuild) InitLog(outDirPath, level string) *ApplicationBuild

InitLog 初始化自定义日志

func (*ApplicationBuild) LoadConfig

func (app *ApplicationBuild) LoadConfig(configStruct interface{}, loaderFun func(loadconf.Loader)) error

LoadConfig 加载配置文件、环境变量值

func (*ApplicationBuild) SetSeeds

func (app *ApplicationBuild) SetSeeds(seedFuncs ...seed.SeedFunc) *ApplicationBuild

SetSeeds 设置启动项目时，要执行的一些钩子函数

type ApplicationBuilder

type ApplicationBuilder interface {
	EnableWeb(timeFormat, port, logLevel string, components webiris.PartyComponent) *ApplicationBuild
	EnableDb(dbConfig *datasource.PostgresConfig, models []interface{}) *ApplicationBuild
	EnableCache(ctx context.Context, redConfig cache.RedisOptions) *ApplicationBuild
	LoadConfig(configStruct interface{}, loaderFun func(loadconf.Loader)) error
	InitLog(outDirPath, level string) *ApplicationBuild
	EnableMongoDB(dbConfig *mongodb.MongoDBConfig) *ApplicationBuild
	InitCronJob() *ApplicationBuild
}