code

Documentation

Index

• Constants
• Variables
• func Equal(a, b Codes) bool
• func EqualError(code Codes, err error) bool
• func Register(cm map[int]string)
• func WrapBFRError(requestID string, code int32, err error) *api.Status
• func WrapDetails(details []*any.Any) []zapcore.Field
• func WrapError(err error) error
• type Code
  • func Int(i int) Code
  • func String(e string) Code
  • func (e Code) Code() int
  • func (e Code) Details() []interface{}
  • func (e Code) Error() string
  • func (e Code) Message() string
• type Codes
  • func Cause(e error) Codes

Constants

const HTTPClientErroCode = 400

HTTPClientErroCode 描述错误原因由客户引起的错误 比如登陆用户名/密码错误等行为

const HTTPInnerErrorCode = 500

HTTPInnerErrorCode 描述本不应该存在却出现了的系统错误

const HTTPNonAuthoritative = 203

HTTPNonAuthoritative Head不存在Token信息

const HTTPNotRecognizedError = 500

HTTPNotRecognizedError 描述本不应该存在却出现了的系统错误

const HTTPSuccess = 200

HTTPSuccess 状态码设定

const HTTPUnauthorizedError = 401

HTTPUnauthorizedError JWT解析错误 包括过期/Token解析错误/Token格式错误等等

const Success = 20000 //本次请求完完全全成功

Success 本次请求完完全全成功

Variables

var (
	//DBNotFound 数据库查询返回为空
	DBNotFound = add(20001, "数据库查询返回为空")

	//DBCreateError 数据库创建错误
	DBCreateError = add(20002, "数据库创建错误")

	//DBQueryError 数据库查询错误
	DBQueryError = add(20003, "数据库查询错误")
	//DBUpdateError 数据库更新错误
	DBUpdateError = add(20004, "数据库更新错误")
	//DBDeleteError 数据库删除错误
	DBDeleteError = add(20005, "数据库删除错误")

	//TypeConverionError 类型转化错误
	TypeConverionError = add(20010, "类型转化错误")

	//JWTErrorInvalid Token解析错误
	JWTErrorInvalid = add(20020, "Token解析错误")

	//JWTErrorExpired Token过期
	JWTErrorExpired = add(20021, "Token过期")

	//JWTErrorNotValidYet Token还没有效
	JWTErrorNotValidYet = add(20022, "Token还没有效")

	//JWTErrorMalformed Token格式错误
	JWTErrorMalformed = add(20023, "Token格式错误")
	//JWTErrorNotFound 请求没有携带Token信息
	JWTErrorNotFound = add(20024, "请求没有携带Token信息")
	//JWT Refresh Token Not Found
	JWTRefreshNotFound = add(20028, "请求必须携带refreshToken")

	VeriCodeGenFailure     = add(20025, "验证码生成错误")
	VeriCodeNotRight       = add(20026, "验证码校验错误")
	VeriCodeParamNotEnough = add(20027, "验证码参数不够")

	//RequestParamInCorrect 请求参数错误
	RequestParamInCorrect = add(20030, "请求参数错误")

	//AliOssError alioss相关错误
	AliOssError = add(20050, "alioss相关错误")
	AliSMSError = add(20051, "aliSMS相关错误")
	AliVODError = add(20052, "alivod相关错误")

	//CreateFileError 创建文件错误
	CreateFileError = add(20060, "创建文件错误")

	//ReportCaculate 报告计算错误
	ReportCaculate    = add(20070, "外骨骼报告计算错误")
	TrainRequestError = add(20071, "上传参数错误")

	//MemcacheError 缓存错误
	MemcacheError   = add(20080, "Memcache缓存错误")
	RedisCacheError = add(20081, "Rediscache缓存错误")

	//DeviceMonitor
	DeviceMonitor        = add(20090, "设备监测出错")
	DeviceAiderMockError = add(20091, "外骨骼设备模拟出错")

	//Router
	RouterContrunctError = add(20100, "计算路由数组错误")
)

var (
	OK = add(0, "成功") // 正确

	NotModified        = add(-304, "木有改动")    // 木有改动
	TemporaryRedirect  = add(-307, "撞车跳转")    // 撞车跳转
	RequestErr         = add(-400, "请求错误")    // 请求错误
	Unauthorized       = add(-401, "未认证")     // 未认证
	AccessDenied       = add(-403, "访问权限不足")  // 访问权限不足
	NothingFound       = add(-404, "啥都木有")    // 啥都木有
	MethodNotAllowed   = add(-405, "不支持该方法")  // 不支持该方法
	Conflict           = add(-409, "冲突")      // 冲突
	Canceled           = add(-498, "客户端取消请求") // 客户端取消请求
	ServerErr          = add(-500, "服务器错误")   // 服务器错误
	ServiceUnavailable = add(-503, "服务暂不可用")  // 过载保护,服务暂不可用
	Deadline           = add(-504, "服务调用超时")  // 服务调用超时
	LimitExceed        = add(-509, "超出限制")    // 超出限制
)

var (
	//DBConnectLost 数据库连接丢失
	DBConnectLost = add(10001, "数据库连接丢失")
)

Functions

func Equal

func Equal(a, b Codes) bool

Equal equal a and b by code int.

func EqualError

func EqualError(code Codes, err error) bool

EqualError equal error

func Register

func Register(cm map[int]string)

func WrapBFRError

func WrapBFRError(requestID string, code int32, err error) *api.Status

func WrapDetails

func WrapDetails(details []*any.Any) []zapcore.Field

func WrapError

func WrapError(err error) error

Types

type Code

type Code int

A Code is an int error code spec.

func Int

func Int(i int) Code

Int parse code int to error.

func String

func String(e string) Code

String parse code string to error.

func (Code) Code

func (e Code) Code() int

Code return error code

func (Code) Details

func (e Code) Details() []interface{}

Details return details.

func (Code) Error

func (e Code) Error() string

func (Code) Message

func (e Code) Message() string

Message return error message

type Codes

type Codes interface {
	// sometimes Error return Code in string form
	// NOTE: don't use Error in monitor report even it also work for now
	Error() string
	// Code get error code.
	Code() int
	// Message get code message.
	Message() string
	//Detail get error detail,it may be nil.
	Details() []interface{}
}

Codes code error interface which has a code & message.

func Cause

func Cause(e error) Codes

Cause cause from error to code.