cherryGin

Documentation

Overview

Package cherryGin from https://github.com/gin-contrib/zap/

Index

• func GinDefaultZap() gin.HandlerFunc
• func GinZap(timeFormat string, utc bool) gin.HandlerFunc
• func RecoveryWithZap(stack bool) gin.HandlerFunc
• type BaseController
  • func (b *BaseController) Any(relativePath string, handlers ...HandlerFunc)
  • func (b *BaseController) BindHandle(handler func(ctx *Context)) gin.HandlerFunc
  • func (b *BaseController) GET(relativePath string, handlers ...HandlerFunc)
  • func (b *BaseController) Init()
  • func (b *BaseController) POST(relativePath string, handlers ...HandlerFunc)
  • func (b *BaseController) PreInit(app cherryFacade.IApplication, engine *gin.Engine)
  • func (b *BaseController) Stop()
• type Component
  • func New(address string, middleware ...gin.HandlerFunc) *Component
  • func NewHttp(name, address string, middleware ...gin.HandlerFunc) *Component
  • func NewHttps(name, address, certFile, keyFile string, middleware ...gin.HandlerFunc) *Component
  • func NewWithOptions(name string, options Options) *Component
  • func (g *Component) Init()
  • func (g *Component) Name() string
  • func (g *Component) OnAfterInit()
  • func (g *Component) OnBeforeStop()
  • func (g *Component) OnStop()
  • func (g *Component) Register(controllers ...IController) *Component
  • func (g *Component) StaticFS(relativePath string, staticDir string)
  • func (g *Component) StaticFile(relativePath string, staticDir string)
• type Context
  • func (g *Context) GetInt(name string, defaultValue int) int
  • func (g *Context) GetInt64(name string, defaultValue int64) int64
  • func (g *Context) GetString(name string, defaultValue string) string
  • func (g *Context) PostInt(name string, defaultValue int) int
  • func (g *Context) PostInt64(name string, defaultValue int64) int64
  • func (g *Context) PostString(name string, defaultValue string) string
  • func (g *Context) RenderError(code int, msg string)
  • func (g *Context) RenderHTML(html string)
  • func (g *Context) RenderJSON(value interface{})
• type HandlerFunc
• type IController
• type Options

Functions

func GinDefaultZap

func GinDefaultZap() gin.HandlerFunc

func GinZap

func GinZap(timeFormat string, utc bool) gin.HandlerFunc

GinZap returns a gin.HandlerFunc (middleware) that logs requests using uber-go/zap.

Requests with errors are logged using zap.Error(). Requests without errors are logged using zap.Info().

It receives:

1. A time package format string (e.g. time.RFC3339).
2. A boolean stating whether to use UTC time zone or local.

func RecoveryWithZap

func RecoveryWithZap(stack bool) gin.HandlerFunc

RecoveryWithZap returns a gin.HandlerFunc (middleware) that recovers from any panics and logs requests using uber-go/zap. All errors are logged using zap.Error(). stack means whether output the stack info. The stack info is easy to find where the error occurs but the stack info is too large.

Types

type BaseController

type BaseController struct {
	App    cherryFacade.IApplication
	Engine *gin.Engine
}

func (*BaseController) Any

func (b *BaseController) Any(relativePath string, handlers ...HandlerFunc)

func (*BaseController) BindHandle

func (b *BaseController) BindHandle(handler func(ctx *Context)) gin.HandlerFunc

func (*BaseController) GET

func (b *BaseController) GET(relativePath string, handlers ...HandlerFunc)

func (*BaseController) Init

func (b *BaseController) Init()

func (*BaseController) POST

func (b *BaseController) POST(relativePath string, handlers ...HandlerFunc)

func (*BaseController) PreInit

func (b *BaseController) PreInit(app cherryFacade.IApplication, engine *gin.Engine)

func (*BaseController) Stop

func (b *BaseController) Stop()

type Component

type Component struct {
	cherryFacade.Component
	*gin.Engine
	// contains filtered or unexported fields
}

Component wrapper gin

func New

func New(address string, middleware ...gin.HandlerFunc) *Component

func NewHttp

func NewHttp(name, address string, middleware ...gin.HandlerFunc) *Component

func NewHttps

func NewHttps(name, address, certFile, keyFile string, middleware ...gin.HandlerFunc) *Component

func NewWithOptions

func NewWithOptions(name string, options Options) *Component

func (*Component) Init

func (g *Component) Init()

func (*Component) Name

func (g *Component) Name() string

Name unique components name

func (*Component) OnAfterInit

func (g *Component) OnAfterInit()

func (*Component) OnBeforeStop

func (g *Component) OnBeforeStop()

func (*Component) OnStop

func (g *Component) OnStop()

func (*Component) Register

func (g *Component) Register(controllers ...IController) *Component

func (*Component) StaticFS

func (g *Component) StaticFS(relativePath string, staticDir string)

func (*Component) StaticFile

func (g *Component) StaticFile(relativePath string, staticDir string)

type Context

type Context struct {
	*gin.Context
}

func (*Context) GetInt

func (g *Context) GetInt(name string, defaultValue int) int

func (*Context) GetInt64

func (g *Context) GetInt64(name string, defaultValue int64) int64

func (*Context) GetString

func (g *Context) GetString(name string, defaultValue string) string

func (*Context) PostInt

func (g *Context) PostInt(name string, defaultValue int) int

func (*Context) PostInt64

func (g *Context) PostInt64(name string, defaultValue int64) int64

func (*Context) PostString

func (g *Context) PostString(name string, defaultValue string) string

func (*Context) RenderError

func (g *Context) RenderError(code int, msg string)

func (*Context) RenderHTML

func (g *Context) RenderHTML(html string)

func (*Context) RenderJSON

func (g *Context) RenderJSON(value interface{})

type HandlerFunc

type HandlerFunc func(ctx *Context)

type IController

type IController interface {
	PreInit(app cherryFacade.IApplication, engine *gin.Engine)

	Init()

	Stop()
}

type Options

type Options struct {
	ReadTimeout       time.Duration // http server parameter
	ReadHeaderTimeout time.Duration
	WriteTimeout      time.Duration
	IdleTimeout       time.Duration
	MaxHeaderBytes    int
	Address           string
	CertFile          string
	KeyFile           string
}