response

README

gylib, stdresp

统一定义返回值结构，以及相关常用方法

{
  "code": "RC00000",
  "info": "Success"
}

Documentation

Index

• Variables
• func ErrorHandler(resp *ResponseCode, errMsg string, c *gin.Context, abort bool)
• func GeneralDBHandler(err error, c *gin.Context)
• func GeneralErrorHandler(err error, c *gin.Context)
• func GeneralErrorMessageHandler(errMsg string, c *gin.Context)
• func GeneralParamHandler(err error, c *gin.Context)
• func GeneralParamMessageHandler(errMsg string, c *gin.Context)
• func GeneralResultHandler(result interface{}, err error, c *gin.Context)
• func GeneralSuccessHandler(result interface{}, c *gin.Context)
• func GeneralSuccessMessageHandler(message string, c *gin.Context)
• func SystemErrorHandler(err error, c *gin.Context)
• type PageInfo
• type PageResult
• type Response
  • func (re *Response) Init(code *ResponseCode, hint string, result interface{})
  • func (re *Response) InitError(code *ResponseCode, hint string)
  • func (re *Response) InitFromResp(srcResp *Response)
  • func (re *Response) InitPageSuccess(totalPages, pageNo, pageSize int, results interface{})
  • func (re *Response) InitSuccess()
  • func (re *Response) InitSuccessFull(hint string, result interface{})
  • func (re *Response) InitSuccessHint(hint string)
  • func (re *Response) InitSuccessResult(result interface{})
  • func (re *Response) IsSuccess() bool
• type ResponseCode

Variables

var CacheError = &ResponseCode{Code: "RC81001", Info: "缓存操作失败"}

var DB_ERROR = &ResponseCode{Code: "RC80000", Info: "DBError"}

var DB_NOT_FOUND = &ResponseCode{Code: "RC80404", Info: "DBError: record not found"}

var GENERAL_ERROR = &ResponseCode{Code: "RC60000", Info: "FAILURE"}

var MGMT_TOKEN_DISABLE_ERROR = &ResponseCode{Code: "RC50090", Info: "MgmtTokenDisabled"}

var MGMT_TOKEN_EXPIRE_ERROR = &ResponseCode{Code: "RC50099", Info: "MgmtTokenExpireOrInvalid: %s"}

var PARAM_ERROR = &ResponseCode{Code: "RC70000", Info: "ParamError"}

var SUCCESS = &ResponseCode{Code: "RC00000", Info: "SUCCESS"}

var SYS_ERROR = &ResponseCode{Code: "RC90000", Info: "SysError"}

var TOKEN_EXPIRE_ERROR = &ResponseCode{Code: "RC50000", Info: "TokenExpireOrInvalid"}

Functions

func ErrorHandler

func ErrorHandler(resp *ResponseCode, errMsg string, c *gin.Context, abort bool)

func GeneralDBHandler

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

func GeneralErrorHandler

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

func GeneralErrorMessageHandler

func GeneralErrorMessageHandler(errMsg string, c *gin.Context)

func GeneralParamHandler

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

func GeneralParamMessageHandler

func GeneralParamMessageHandler(errMsg string, c *gin.Context)

func GeneralResultHandler

func GeneralResultHandler(result interface{}, err error, c *gin.Context)

func GeneralSuccessHandler

func GeneralSuccessHandler(result interface{}, c *gin.Context)

func GeneralSuccessMessageHandler

func GeneralSuccessMessageHandler(message string, c *gin.Context)

func SystemErrorHandler

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

Types

type PageInfo

type PageInfo struct {
	TotalPages int `json:"totalPages"`
	PageNo     int `json:"pageNo"`
	PageSize   int `json:"pageSize"`
}

type PageResult

type PageResult struct {
	PageInfo *PageInfo   `json:"pageInfo,omitempty"`
	Data     interface{} `json:"data,omitempty"`
}

type Response

type Response struct {
	Code   string      `json:"code"`
	Info   string      `json:"info"`
	Result interface{} `json:"result,omitempty"`
}

func (*Response) Init

func (re *Response) Init(code *ResponseCode, hint string, result interface{})

func (*Response) InitError

func (re *Response) InitError(code *ResponseCode, hint string)

func (*Response) InitFromResp

func (re *Response) InitFromResp(srcResp *Response)

func (*Response) InitPageSuccess

func (re *Response) InitPageSuccess(totalPages, pageNo, pageSize int, results interface{})

func (*Response) InitSuccess

func (re *Response) InitSuccess()

func (*Response) InitSuccessFull

func (re *Response) InitSuccessFull(hint string, result interface{})

func (*Response) InitSuccessHint

func (re *Response) InitSuccessHint(hint string)

func (*Response) InitSuccessResult

func (re *Response) InitSuccessResult(result interface{})

func (*Response) IsSuccess

func (re *Response) IsSuccess() bool

type ResponseCode

type ResponseCode struct {
	Code string
	Info string
}