errx

Documentation

Index

• Constants
• func Equal(err error, code Code) bool
• func IsCodeErr(code Code) bool
• func SetErrorMessageWithError(codeErrs ...*Error)
• func SetErrorMessgeWithMap(data map[Code]string)
• type Code
• type Error
  • func New(code Code, opts ...ErrorOption) *Error
  • func (e *Error) Error() string
  • func (e *Error) GetErrCode() Code
  • func (e *Error) GetMsg() string
  • func (e *Error) InnerError() error
• type ErrorOption
  • func WithCodeOption(code Code) ErrorOption
  • func WithErrorOption(err error) ErrorOption
  • func WithMsgOption(msg string) ErrorOption

Constants

const (
	// 业务错误
	BIZ_INFO = Code(100_00)
	// SERVER_COMMON_ERROR 通用服务编码
	SERVER_COMMON_ERROR Code = 100_01
	// REUQEST_PARAM_ERROR 请求参数错误
	REUQEST_PARAM_ERROR Code = 100_02
	// TOKEN_EXPIRE_ERROR Token过期
	TOKEN_EXPIRE_ERROR Code = 100_03
	// TOKEN_GENERATE_ERROR Token生成错误
	TOKEN_GENERATE_ERROR Code = 100_04
	// DB_ERROR 数据库错误
	DB_ERROR Code = 100_05
	// DB_QUERY_ERROR 数据库查询错误
	DB_QUERY_ERROR Code = 100_06
	// DB_LAST_INSERT_ID_ERROR 获取新书编号错误
	DB_LAST_INSERT_ID_ERROR Code = 100_07
	// DB_INSERT_ERROR 数据库创建错误
	DB_INSERT_ERROR Code = 100_08
	// DB_NOT_FOUND_ERROR 记录不存在
	DB_NOT_FOUND_ERROR Code = 100_09
	// DB_ALREADY_EXISTS_ERROR 记录已经存在
	DB_ALREADY_EXISTS_ERROR Code = 100_10
	// REQUEST_PARAM_REQUIRED_ERROR 删除必填
	PARAM_REQUIRED_ERROR Code = 100_11
	// DB_UPDATE_ERROR 更新错误
	DB_UPDATE_ERROR Code = 100_12
	// SQL_BUILD_ERROR sql构建错误
	SQL_BUILD_ERROR = Code(100_13)
	// MARSHAL_ERROR json解析错误
	MARSHAL_ERROR = Code(100_14)
	// TOKEN_PARSER_ERROR Token解析错误
	TOKEN_PARSER_ERROR = Code(100_15)
	// CACHE_EXPIRE_ERROR 缓存过期
	CACHE_EXPIRE_ERROR = Code(100_16)
	// CACHE_ERROR 缓存错误
	CACHE_ERROR = Code(100_17)
	// LOGIN_TIMEOUT 登录超时
	LOGIN_TIMEOUT = Code(100_18)
	// SIGNED_IN_ELSE_WHERE 在其他地方登录
	SIGNED_IN_ELSE_WHERE = Code(100_19)
	// REQUIRE_TOKEN
	REQUIRED_TOKEN_ERROR = Code(100_20)
	// CAPTCHA_ERROR 验证码错误
	CAPTCHA_ERROR = Code(100_21)
	// RECORD_DISABLED 禁用
	RECORD_DISABLED = Code(100_22)
	// CACHE_NOT_FOUND 缓存不存在
	CACHE_NOT_FOUND = Code(100_23)
	// DB_DELETE_EROR 数据库删除错误
	DB_DELETE_EROR     = Code(100_24)
	CACHE_DELETE_ERROR = Code(100_25)

	// 未授权
	UNAUTHORIZED = Code(100_31)
	// 密码错误
	PASSWORD_ERROR = Code(100_32)

	PASSWORD_INCONSISTENT = Code(100_33)

	// 未实现
	UNIMPLEMENTED = Code(100_34)
	// 未登录认证
	UNAUTHENTICATION = Code(100_35)

	DB_CONCURRENT_UPDATE_FAILED = Code(100_36)
	// 系统配置范围格式错误
	CONFIG_RANGE_FORMAT         = Code(100_37)
	NOT_IMPLEMENTED             = Code(100_38)
	NOT_SUPPORTED               = Code(100_39)
	JWT_TOKEN_FORMAT            = Code(100_40)
	TOKEN_IS_REQUIRED           = Code(100_41)
	USER_CONTEXT_NOT_EXIST      = Code(100_42)
	UUID_GENERATE               = Code(100_43)
	PASSWORD_NEW_OLD_CONSISTENT = Code(100_44)
	PASSWORD_USER_ERROR         = Code(100_45)
)

Functions

func Equal

func Equal(err error, code Code) bool

Equal 对比错误码是否相等

func IsCodeErr

func IsCodeErr(code Code) bool

IsCodeErr 是否自定义错误

func SetErrorMessageWithError

func SetErrorMessageWithError(codeErrs ...*Error)

SetErrorMessageWithError 全局错误码消息

func SetErrorMessgeWithMap

func SetErrorMessgeWithMap(data map[Code]string)

SetErrorMessgeWithMap

Types

type Code

type Code uint32

ErrCode 错误编码 ErrCode:100_00~199_99 100_xx:为预定义错误码 规则：业务编码(3位)+功能编码(2位)

const OK Code = 200

type Error

type Error struct {
	// contains filtered or unexported fields
}

func New

func New(code Code, opts ...ErrorOption) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) GetErrCode

func (e *Error) GetErrCode() Code

func (*Error) GetMsg

func (e *Error) GetMsg() string

错误消息

func (*Error) InnerError

func (e *Error) InnerError() error

type ErrorOption

type ErrorOption func(*Error)

func WithCodeOption

func WithCodeOption(code Code) ErrorOption

func WithErrorOption

func WithErrorOption(err error) ErrorOption

func WithMsgOption

func WithMsgOption(msg string) ErrorOption