app

package module
v1.20.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 31, 2024 License: MIT Imports: 22 Imported by: 83

README

App Starter

Go project version issues Go Report Card Source graph License

Delete tag

$ git tag -d v0.4.0
Deleted tag 'v0.4.0' (was f74dcae)

$ git push origin :v0.4.0
To https://github.com/lishimeng/app-starter.git
 - [deleted]         3.3.0.1492

Documentation

Index

Constants

View Source 
const (
	Disable = iota
	Enable
)

Variables

View Source 
var WithDefaultCallback = func(configName string) (f func(loader etc.Loader)) {
	return func(loader etc.Loader) {
		loader.SetFileSearcher(configName, ".").SetEnvPrefix("").SetEnvSearcher()
	}
}

Functions

func AmqpPub added in v1.10.4 

func AmqpPub(m rabbit.Message) error

func GetAmqp added in v1.8.0 

func GetAmqp() (session rabbit.Session)

func GetCache added in v1.4.0 

func GetCache() (c cache.C)

func GetMqtt added in v1.10.0 

func GetMqtt() (session mqtt.Session)

func GetNamedOrm added in v1.6.9 

func GetNamedOrm(aliaName string) *persistence.OrmContext

func GetOrm 

func GetOrm() *persistence.OrmContext

func GetWebServer added in v1.20.0 

func GetWebServer() (s *server.Server)

func MqttPub added in v1.10.4 

func MqttPub(topic string, qos byte, retained bool, data []byte) error

func MqttPublish added in v1.10.4 

func MqttPublish(topic string, data []byte) error

func Query added in v1.6.6 

func Query(h func(ctx persistence.OrmContext) (err error)) (err error)

func QueryPage added in v1.20.3 

func QueryPage[Model any, Dto any](pager *SimplePager[Model, Dto]) (err error)

QueryPage 单表分页查询(默认pageNo=1 pageSize=10)

func Transaction added in v1.6.6 

func Transaction(h func(ctx persistence.TxContext) error) (err error)

Types

type Application 

type Application interface {
	Start(buildHandler func(ctx context.Context, builder *ApplicationBuilder) error, onTerminate ...func(string)) error
}

func New 

func New() (instance Application)

type ApplicationBuilder added in v1.2.1 

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

func (*ApplicationBuilder) ComponentAfter added in v1.2.1 

func (h *ApplicationBuilder) ComponentAfter(component func(context.Context) (err error)) *ApplicationBuilder

func (*ApplicationBuilder) ComponentBefore added in v1.2.1 

func (h *ApplicationBuilder) ComponentBefore(component func(context.Context) (err error)) *ApplicationBuilder

func (*ApplicationBuilder) EnableAmqp added in v1.8.0 

func (h *ApplicationBuilder) EnableAmqp(c amqp.Connector, options ...rabbit.SessionOption) *ApplicationBuilder

func (*ApplicationBuilder) EnableCache added in v1.4.0 

func (h *ApplicationBuilder) EnableCache(redisOpts cache.RedisOptions, cacheOpts cache.Options) *ApplicationBuilder

func (*ApplicationBuilder) EnableDatabase added in v1.2.1 

func (h *ApplicationBuilder) EnableDatabase(config persistence.BaseConfig,
	models ...interface{}) *ApplicationBuilder

func (*ApplicationBuilder) EnableDatabaseLog added in v1.20.5 

func (h *ApplicationBuilder) EnableDatabaseLog() *ApplicationBuilder

EnableDatabaseLog 打开orm log输出

func (*ApplicationBuilder) EnableMqtt added in v1.10.0 

func (h *ApplicationBuilder) EnableMqtt(options ...mqtt.ClientOption) *ApplicationBuilder

func (*ApplicationBuilder) EnableOrmLog added in v1.7.3 

func (h *ApplicationBuilder) EnableOrmLog() *ApplicationBuilder

func (*ApplicationBuilder) EnableStaticWeb added in v1.2.1 

func (h *ApplicationBuilder) EnableStaticWeb(assetFile func() http.FileSystem) *ApplicationBuilder

func (*ApplicationBuilder) EnableTokenValidator added in v1.9.0 

func (h *ApplicationBuilder) EnableTokenValidator(builder TokenValidatorBuilder) *ApplicationBuilder

EnableTokenValidator 验证Token，使用RedisTokenValidator前需要enableCache

func (*ApplicationBuilder) EnableWeb added in v1.2.1 

func (h *ApplicationBuilder) EnableWeb(listen string, components ...server.Component) *ApplicationBuilder

func (*ApplicationBuilder) HealthyHandler added in v1.5.0 

func (h *ApplicationBuilder) HealthyHandler(handler func() int) *ApplicationBuilder

func (*ApplicationBuilder) LoadConfig added in v1.2.1 

func (h *ApplicationBuilder) LoadConfig(config interface{}, callback func(etc.Loader)) (err error)

func (*ApplicationBuilder) PrintVersion added in v1.7.3 

func (h *ApplicationBuilder) PrintVersion() *ApplicationBuilder

func (*ApplicationBuilder) ReadyHandler added in v1.5.0 

func (h *ApplicationBuilder) ReadyHandler(handler func() int) *ApplicationBuilder

func (*ApplicationBuilder) RegisterAmqpHandlers added in v1.10.2 

func (h *ApplicationBuilder) RegisterAmqpHandlers(handlers ...amqp.Handler) *ApplicationBuilder

RegisterAmqpHandlers 注册amqp handler

业务类任务使用延时执行策略，在连接型任务之后执行

func (*ApplicationBuilder) SetMonitorPrefix added in v1.5.0 

func (h *ApplicationBuilder) SetMonitorPrefix(prefix string) *ApplicationBuilder

func (*ApplicationBuilder) SetWebLogLevel added in v1.3.3 

func (h *ApplicationBuilder) SetWebLogLevel(lvl string) *ApplicationBuilder

type BasePager added in v1.20.3 

type BasePager struct {
	TotalPage int `json:"totalPage"` // 总页数
	PageSize  int `json:"pageSize"`  // 页面大小
	PageNum   int `json:"pageNum"`   // 页号
	More      int `json:"more"`      // 是否有下一页
}

func (*BasePager) Offset added in v1.20.3 

func (p *BasePager) Offset() int

func (*BasePager) Total added in v1.20.3 

func (p *BasePager) Total(count int64) int

type OperatorChangeInfo added in v1.10.15 

type OperatorChangeInfo struct {
	OperatorInfo
	UpdateOperator int `orm:"column(moperator)"`
}

OperatorChangeInfo 不可与 OperatorInfo 同时使用

type OperatorInfo added in v1.10.15 

type OperatorInfo struct {
	CreateOperator int `orm:"column(coperator)"`
}

type Pager added in v1.1.3 

type Pager[Dto any] struct {
	BasePager
	Data []Dto `json:"items,omitempty"`
}

type PagerResponse added in v1.1.3 

type PagerResponse struct {
	Response
}

type Pk added in v1.9.11 

type Pk struct {
	// ID
	Id int `orm:"pk;auto;column(id)"`
}

type Response added in v1.1.3 

type Response struct {
	Code    int         `json:"code,omitempty"`
	Success string      `json:"success,omitempty"`
	Message string      `json:"message,omitempty"`
	Status  interface{} `json:"status,omitempty"`
}

type ResponseWrapper added in v1.11.4 

type ResponseWrapper struct {
	Response
	Data any `json:"data,omitempty"`
}

type SimplePager added in v1.20.2 

type SimplePager[DbModel any, Dto any] struct {
	Pager[Dto]
	DataSet      []DbModel
	Transform    func(src DbModel, dst *Dto)
	OrderByExp   []string
	QueryBuilder func(tx persistence.TxContext) any
}

type TableChangeInfo added in v1.9.11 

type TableChangeInfo struct {
	// 状态
	Status int `orm:"column(status)"`
	// 创建时间
	TableInfo
	// 修改时间
	UpdateTime time.Time `orm:"auto_now;type(datetime);column(mtime)"`
}

TableChangeInfo 不可与 TableInfo 同时使用

type TableInfo added in v1.9.11 

type TableInfo struct {
	// 创建时间
	CreateTime time.Time `orm:"auto_now_add;type(datetime);column(ctime)"`
}

type Tenant added in v1.10.15 

type Tenant struct {
	Org int `orm:"column(org)"` // org为tenant标记
}

Tenant 多租户

type TenantPk added in v1.10.15 

type TenantPk struct {
	Pk
	Tenant
}

TenantPk 不可与 Pk 同时使用

type TokenValidatorBuilder added in v1.9.0 

type TokenValidatorBuilder func(injectFunc TokenValidatorInjectFunc)

type TokenValidatorInjectFunc added in v1.9.0 

type TokenValidatorInjectFunc func(storage token.Storage)

Source Files

View all Source files

Directories

Path Synopsis
alg
astar
rabbit
application
api
repo
contrib
office
midware
auth
auth/bearer
oauth/wx/miniwx
oauth/wx/qiyewx
template

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.