ginshared

Documentation

Index

• Constants
• Variables
• func CloneRequestBody(c *gin.Context) []byte
• func DropDuplicated(raw []string) []string
• func GetContainer() *dig.Container
• func GetFullUrl(c *gin.Context) string
• func NewErrorReport(replyCode int, logger *zap.Logger) gin.HandlerFunc
• func Provide(constructor interface{}, opts ...dig.ProvideOption) error
• func ProvideController(constructor interface{}) error
• func RegisterComponent(comp Component)
• func ReportBadrequest(c *gin.Context, err error)
• func RequestLocker(params ...string) gin.HandlerFunc
• func Start() error
• type Component
• type Components
  • func (cs *Components) InitAll(r *gin.Engine)
• type CorsComponent
  • func (c CorsComponent) OnEngineInited(r *gin.Engine) error
• type DefaultComponent
  • func (dc *DefaultComponent) Priority() int
• type DiController
• type ErrorCode
• type GeneralResp
• type ParamComponents
• type Params
• type Prom
  • func (p Prom) OnEngineInited(r *gin.Engine) error
• type ReportError
  • func (handle *ReportError) Middleware(c *gin.Context)
  • func (h *ReportError) OnEngineInited(r *gin.Engine) error
  • func (h *ReportError) Priority() int
  • func (handle *ReportError) RespErrorToClient(c *gin.Context, err interface{})
• type Tlssettings
  • func CheckAndSetupTLS(logger *zap.Logger) (tls *Tlssettings)
  • func (s *Tlssettings) Middleware() gin.HandlerFunc

Constants

const (
	KeyAddress  = "address"
	KeyShutdown = "shutdown"
	KeyInitDB   = "database.initDB"
)

Variables

var ComponentsOptions = dig.Group("components")

var ControllerOptions = dig.Group("controllers")

var MD5 = core.MD5

var ToWebsocket = websocket.Upgrader{
	ReadBufferSize:  1024,
	WriteBufferSize: 1024,
	CheckOrigin: func(r *http.Request) bool {
		return true
	},
}

Functions

func CloneRequestBody

func CloneRequestBody(c *gin.Context) []byte

func DropDuplicated

func DropDuplicated(raw []string) []string

func GetContainer

func GetContainer() *dig.Container

func GetFullUrl

func GetFullUrl(c *gin.Context) string

func NewErrorReport

func NewErrorReport(replyCode int, logger *zap.Logger) gin.HandlerFunc

deprecated

func Provide

func Provide(constructor interface{}, opts ...dig.ProvideOption) error

func ProvideController

func ProvideController(constructor interface{}) error

func RegisterComponent

func RegisterComponent(comp Component)

func ReportBadrequest

func ReportBadrequest(c *gin.Context, err error)

func RequestLocker

func RequestLocker(params ...string) gin.HandlerFunc

func Start

func Start() error

Types

type Component

type Component interface {
	Priority() int
	OnEngineInited(r *gin.Engine) error
}

type Components

type Components struct {
	Components []Component
}

func (*Components) InitAll

func (cs *Components) InitAll(r *gin.Engine)

type CorsComponent

type CorsComponent struct {
	DefaultComponent
	Enabled bool
}

func (CorsComponent) OnEngineInited

func (c CorsComponent) OnEngineInited(r *gin.Engine) error

type DefaultComponent

type DefaultComponent struct{}

func (*DefaultComponent) Priority

func (dc *DefaultComponent) Priority() int

type DiController

type DiController interface{}

type ErrorCode

type ErrorCode interface {
	ErrorCode() string
}

type GeneralResp

type GeneralResp struct {
	Succ         bool
	ErrorCode    string
	ErrorMessage string
}

type ParamComponents

type ParamComponents struct {
	dig.In
	Components []Component `group:"components"`
}

type Params

type Params struct {
	dig.In
	Logger      *zap.Logger
	Router      *gin.Engine
	Bus         EventBus.Bus
	Tls         *Tlssettings
	Startups    []core.Startup `group:"startups"`
	Controllers []DiController `group:"controllers"`
}

type Prom

type Prom struct {
	DefaultComponent
}

func (Prom) OnEngineInited

func (p Prom) OnEngineInited(r *gin.Engine) error

type ReportError

type ReportError struct {
	ReplyCode int
}

func (*ReportError) Middleware

func (handle *ReportError) Middleware(c *gin.Context)

func (*ReportError) OnEngineInited

func (h *ReportError) OnEngineInited(r *gin.Engine) error

func (*ReportError) Priority

func (h *ReportError) Priority() int

func (*ReportError) RespErrorToClient

func (handle *ReportError) RespErrorToClient(c *gin.Context, err interface{})

type Tlssettings

type Tlssettings struct {
	Enabled bool
	Pem     string
	Key     string
}

func CheckAndSetupTLS

func CheckAndSetupTLS(logger *zap.Logger) (tls *Tlssettings)

func (*Tlssettings) Middleware

func (s *Tlssettings) Middleware() gin.HandlerFunc