common

Documentation

Index

• func GetMsg(code RetCode) string
• func GetValidator() *validator.Validate
• func InitTrans(locale string) (err error)
• type BaseController
  • func (c *BaseController) CheckParams(ctx *gin.Context, params interface{}) bool
  • func (c *BaseController) Response(ctx *gin.Context, data interface{}, err error)
• type CodeWithErr
  • func NewCodeWithErr(code RetCode, err error) *CodeWithErr
  • func (c CodeWithErr) Error() string
• type ListData
• type Response
• type RetCode
  • func BindAndValid(c *gin.Context, form interface{}) (RetCode, error)

Functions

func GetMsg

func GetMsg(code RetCode) string

func GetValidator

func GetValidator() *validator.Validate

GetValidator gin 集成了 validator，但是标签用的是 binding，这里获取的 validator 是为标签为 validate 准备的

func InitTrans

func InitTrans(locale string) (err error)

Types

type BaseController

type BaseController struct{}

func (*BaseController) CheckParams

func (c *BaseController) CheckParams(ctx *gin.Context, params interface{}) bool

CheckParams check params, params must be a pointer

func (*BaseController) Response

func (c *BaseController) Response(ctx *gin.Context, data interface{}, err error)

type CodeWithErr

type CodeWithErr struct {
	RetCode RetCode
	Err     error
}

func NewCodeWithErr

func NewCodeWithErr(code RetCode, err error) *CodeWithErr

func (CodeWithErr) Error

func (c CodeWithErr) Error() string

type ListData

type ListData struct {
	Counts     int64       `json:"counts"`
	Data       interface{} `json:"data"`
	PageOffset int         `json:"page_offset"`
	PageLimit  int         `json:"page_limit"`
}

type Response

type Response struct {
	RetCode RetCode     `json:"ret_code"`
	Message string      `json:"message"`
	DataSet interface{} `json:"data_set"`
}

type RetCode

type RetCode int

const (
	SUCCESS   RetCode = 0
	FORBIDDEN RetCode = 4030
	FAILED    RetCode = 5000 + iota
	ErrorDatabaseRead
	ErrorDatabaseWrite
	ErrorDatabaseNotFound
	ErrInvalidParams
	ErrInvalidJSONParams
	ErrorPrivilege
	ErrorResourceNotExist
	ErrorCallOtherSrv
)

func BindAndValid

func BindAndValid(c *gin.Context, form interface{}) (RetCode, error)