Documentation ¶
Index ¶
- func DecodeGRPCRuntimeKey(ctx context.Context, runtimeKey []truntime.RuntimeKey) map[string]string
- func DecodeHTTPRuntimeKey(c *gin.Context, runtimeKey []truntime.RuntimeKey) map[string]string
- func DiAllFields(dest interface{}, tctx Context, app Application, c *gin.Context, ...) map[reflect.Type]interface{}
- func DiFree(dest interface{})
- type Application
- type ContainerPool
- func (s *ContainerPool) GetContainer(containerType reflect.Type, tctx Context, app Application, c *gin.Context) (interface{}, map[reflect.Type]interface{})
- func (s *ContainerPool) GetContainerType() []reflect.Type
- func (s *ContainerPool) NewContainer(containerType reflect.Type, containerPool *sync.Pool)
- func (s *ContainerPool) Release(container interface{})
- type Context
- type ContextImpl
- func (c *ContextImpl) Application() Application
- func (c *ContextImpl) DB() *gorm.DB
- func (c *ContextImpl) DBTx() *gorm.DB
- func (c *ContextImpl) DBTxIsOpen() bool
- func (c *ContextImpl) GinCtx() *gin.Context
- func (c *ContextImpl) HTTPResponse(status int, res interface{}, err error)
- func (c *ContextImpl) HTTPResponseCreated(res interface{}, err error)
- func (c *ContextImpl) HTTPResponseErr(status int, err error)
- func (c *ContextImpl) HTTPResponseInternalErr(err error)
- func (c *ContextImpl) HTTPResponseOk(res interface{}, err error)
- func (c *ContextImpl) HTTPResponseUnauthorizedErr(err error)
- func (c *ContextImpl) Runtime() map[string]string
- func (c *ContextImpl) SafeCommit()
- func (c *ContextImpl) SafeRollback()
- type ContextPool
- type ControllerPool
- func (s *ControllerPool) ControllSelfCheck(controllerName string) bool
- func (s *ControllerPool) GetController(controllerName string, tctx Context, app Application, c *gin.Context) (interface{}, map[reflect.Type]interface{})
- func (s *ControllerPool) GetControllerFuncName(controllerName string) (string, bool)
- func (s *ControllerPool) GetControllerMap() []string
- func (s *ControllerPool) GetControllerValidators(controllerName string) []Validator
- func (s *ControllerPool) NewController(controllerType string, controllerPool *sync.Pool)
- func (s *ControllerPool) NewControllerFunc(controllerType string, funcName string)
- func (s *ControllerPool) NewControllerValidators(controllerType string, validator ...Validator)
- func (s *ControllerPool) Release(controllerName string, controller interface{})
- type DBLogger
- type LogConfig
- type Logger
- type RequestMap
- type SkipperFunc
- type Validator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DecodeGRPCRuntimeKey ¶
DecodeGRPCRuntimeKey decode runtime key from ctx
func DecodeHTTPRuntimeKey ¶
DecodeHTTPRuntimeKey decode http runtime
func DiAllFields ¶
func DiAllFields(dest interface{}, tctx Context, app Application, c *gin.Context, isController bool) map[reflect.Type]interface{}
DiAllFields di service pool
Types ¶
type Application ¶
type Application interface { Logger() *golog.Logger RuntimeKeys() []truntime.RuntimeKey Conf() conf.Conf ContextPool() *ContextPool DB() *gorm.DB InstallDB(f func() *gorm.DB) ControllerPool() *ControllerPool ContainerPool() *ContainerPool UseInterceptor(interceptor ...grpc.UnaryServerInterceptor) Application UseMiddleware(middleware ...gin.HandlerFunc) Application RegRuntimeKey(runtime ...truntime.RuntimeKey) Application InitGRPC() InitHTTP() InitRouter() GetGRPCServer() *grpc.Server ServeGRPC() ServeHTTP() }
Application global app interface
type ContainerPool ¶
type ContainerPool struct {
// contains filtered or unexported fields
}
ContainerPool service pool
func NewContainerPool ¶
func NewContainerPool() *ContainerPool
NewContainerPool new pool with init map
func (*ContainerPool) GetContainer ¶
func (s *ContainerPool) GetContainer(containerType reflect.Type, tctx Context, app Application, c *gin.Context) (interface{}, map[reflect.Type]interface{})
GetContainer get service with di
func (*ContainerPool) GetContainerType ¶
func (s *ContainerPool) GetContainerType() []reflect.Type
GetContainerType get all service type
func (*ContainerPool) NewContainer ¶
func (s *ContainerPool) NewContainer(containerType reflect.Type, containerPool *sync.Pool)
NewContainer add new container
func (*ContainerPool) Release ¶
func (s *ContainerPool) Release(container interface{})
Release release service
type Context ¶
type Context interface { Application() Application Runtime() map[string]string DB() *gorm.DB DBTx() *gorm.DB SafeCommit() SafeRollback() DBTxIsOpen() bool GinCtx() *gin.Context HTTPResponseInternalErr(error) HTTPResponseErr(int, error) HTTPResponseOk(interface{}, error) HTTPResponseCreated(interface{}, error) HTTPResponse(int, interface{}, error) // contains filtered or unexported methods }
Context record all thing inside one request
func MockContext ¶
MockContext used for unittest , don't use in production
type ContextImpl ¶
type ContextImpl struct {
// contains filtered or unexported fields
}
ContextImpl Context impl
func (*ContextImpl) Application ¶
func (c *ContextImpl) Application() Application
Application get app
func (*ContextImpl) DBTxIsOpen ¶
func (c *ContextImpl) DBTxIsOpen() bool
DBTxIsOpen return is transactioon is open
func (*ContextImpl) HTTPResponse ¶
func (c *ContextImpl) HTTPResponse(status int, res interface{}, err error)
HTTPResponse handle respoonse
func (*ContextImpl) HTTPResponseCreated ¶
func (c *ContextImpl) HTTPResponseCreated(res interface{}, err error)
HTTPResponseCreated handle http http.StatusCreated 201 response
func (*ContextImpl) HTTPResponseErr ¶
func (c *ContextImpl) HTTPResponseErr(status int, err error)
HTTPResponseErr handle http 400 response
func (*ContextImpl) HTTPResponseInternalErr ¶
func (c *ContextImpl) HTTPResponseInternalErr(err error)
HTTPResponseInternalErr handle http 400 response
func (*ContextImpl) HTTPResponseOk ¶
func (c *ContextImpl) HTTPResponseOk(res interface{}, err error)
HTTPResponseOk handle http http.StatusOK 200 response
func (*ContextImpl) HTTPResponseUnauthorizedErr ¶
func (c *ContextImpl) HTTPResponseUnauthorizedErr(err error)
HTTPResponseUnauthorizedErr handle http 400 response
func (*ContextImpl) Runtime ¶
func (c *ContextImpl) Runtime() map[string]string
Runtime get runtime info
type ContextPool ¶
type ContextPool struct {
// contains filtered or unexported fields
}
ContextPool is the context pool, it's used inside router and the framework by itself.
It's the only one real implementation inside this package because it used widely.
func New ¶
func New(newFunc func() Context) *ContextPool
New creates and returns a new context pool.
func (*ContextPool) Acquire ¶
func (c *ContextPool) Acquire(app Application, runtime map[string]string, db *gorm.DB, ginCtx *gin.Context) Context
Acquire returns a Context from pool. See Release.
func (*ContextPool) Attach ¶
func (c *ContextPool) Attach(newFunc func() Context)
Attach changes the pool's return value Context.
func (*ContextPool) Release ¶
func (c *ContextPool) Release(ctx Context)
Release puts a Context back to its pull, this function releases its resources. See Acquire.
func (*ContextPool) ReleaseLight ¶
func (c *ContextPool) ReleaseLight(ctx Context)
ReleaseLight will just release the object back to the pool, but the clean method is caller's responsibility now
type ControllerPool ¶
type ControllerPool struct {
// contains filtered or unexported fields
}
ControllerPool service pool if grpc string is the full method of method if http os the GET@/ping/:id need to filter controllerFuncMap to filter funcname
func NewControllerPool ¶
func NewControllerPool() *ControllerPool
NewControllerPool new pool with init map
func (*ControllerPool) ControllSelfCheck ¶
func (s *ControllerPool) ControllSelfCheck(controllerName string) bool
ControllSelfCheck self check http request registered func exist or not
func (*ControllerPool) GetController ¶
func (s *ControllerPool) GetController(controllerName string, tctx Context, app Application, c *gin.Context) (interface{}, map[reflect.Type]interface{})
GetController from pool
func (*ControllerPool) GetControllerFuncName ¶
func (s *ControllerPool) GetControllerFuncName(controllerName string) (string, bool)
GetControllerFuncName get controller func name
func (*ControllerPool) GetControllerMap ¶
func (s *ControllerPool) GetControllerMap() []string
GetControllerMap get controller map
func (*ControllerPool) GetControllerValidators ¶
func (s *ControllerPool) GetControllerValidators(controllerName string) []Validator
GetControllerValidators get controller func name
func (*ControllerPool) NewController ¶
func (s *ControllerPool) NewController(controllerType string, controllerPool *sync.Pool)
NewController add new service
func (*ControllerPool) NewControllerFunc ¶
func (s *ControllerPool) NewControllerFunc(controllerType string, funcName string)
NewControllerFunc register funcname for controllertype
func (*ControllerPool) NewControllerValidators ¶
func (s *ControllerPool) NewControllerValidators(controllerType string, validator ...Validator)
NewControllerValidators register funcname for controllertype
func (*ControllerPool) Release ¶
func (s *ControllerPool) Release(controllerName string, controller interface{})
Release release controller to pool
type DBLogger ¶
type DBLogger struct {
// contains filtered or unexported fields
}
DBLogger db logger
func NewDBLogger ¶
func NewDBLogger(app Application, runtime map[string]string, config ...*LogConfig) *DBLogger
NewDBLogger new db logger
type LogConfig ¶
type LogConfig struct { ProjectName bool ProjectVersion bool // Method displays the request path (bool). // Defaults to true. Path bool // used in http request , show http method // default true Method bool // ClientIP // default true ClientIP bool // used in http request , show http status Status bool // used in http request , show body size BodySize bool // Req show request info // Defaults to true. Request bool // Response show response einfo // Defaults to true. Response bool // Error show error messagee // Defaults to true. Error bool // Latency show latency // Defaulte to true Latency bool // Runtime // Defaulte to true Runtime bool // Defaults nil LogFunc func(now time.Time, projectName, projectVersion, method string, latency time.Duration, runtimeValue map[string]string) // Skippers will according method to see if skip the logger middleware Skippers []SkipperFunc }
LogConfig middleware config
func DefaultLogConfig ¶
func DefaultLogConfig() *LogConfig
DefaultLogConfig default log miiddleware setting
type Logger ¶
type Logger interface { Interceptor() func(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) Middleware() gin.HandlerFunc }
Logger for log middleware
func NewLogLogger ¶
func NewLogLogger(app Application, config *LogConfig) Logger
NewLogLogger new log logger
type RequestMap ¶
type RequestMap struct { Method httputil.RequestMethod SubPath string FuncName string Validators []Validator }
RequestMap request map to register request
func NewRequestMapping ¶
func NewRequestMapping(method httputil.RequestMethod, path string, funcName string, validators ...Validator) *RequestMap
NewRequestMapping request mapping @funcName if funcname is "" , trinitygoo will use the default http method name to find the method e.g : http method "GET" ==> find method "GET"
type SkipperFunc ¶
SkipperFunc check if method need to be skip