errcode

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 11, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// CodeOK 请求成功业务状态码
	CodeOK = 0
	// MsgOK 请求成功消息
	MsgOK = "ok"

	// CodeCommon 通用错误业务状态码
	CodeCommon = 97
	// MsgCommon 通用错误业务消息
	MsgCommon = "通用错误"

	// CodeRecordNotFound 记录不存在错误业务状态码
	CodeRecordNotFound = 98
	// MsgRecordNotFound 记录不存在错误业务消息
	MsgRecordNotFound = "记录不存在"

	// CodeUnexpected 意外错误业务状态码
	CodeUnexpected = 99
	// MsgUnexpected 意外错误业务消息
	MsgUnexpected = "服务器繁忙,请稍后重试"

	// CodeInvalidParams 请求参数错误业务状态码
	CodeInvalidParams = 100
	// MsgInvalidParams 请求参数错误业务消息
	MsgInvalidParams = "请求参数错误"

	// GrpcMaxCode grpc 最大错误码
	GrpcMaxCode = 17
)

业务状态码与消息

业务错误码恒大于等于 0,与 grpc code 兼容
业务状态码等于 0 时,代表成功
业务状态码大于 0 时,代表错误
自定义业务状态码请大于等于 17,与 grpc 默认 code 区分开
97 代表通用错误,98 代表记录不存在错误,99 代表意外错误,100 代表请求参数错误,均已被占用,建议之后业务状态码从 200 开始

Variables

View Source
var (
	// OK 成功
	OK = New(CodeOK, MsgOK)
	// ErrCommon 通用错误
	ErrCommon = New(CodeCommon, MsgCommon)
	// ErrRecordNotFound 记录不存在错误
	ErrRecordNotFound = New(CodeRecordNotFound, MsgRecordNotFound)
	// ErrUnexpected 意外错误
	ErrUnexpected = New(CodeUnexpected, MsgUnexpected)
	// ErrInvalidParams 请求参数错误
	ErrInvalidParams = New(CodeInvalidParams, MsgInvalidParams)
)

Functions

func Is

func Is(err, target error) bool

Is 判断业务错误是否相同

target 须为业务错误,用于和 err 进行比对

func IsErr

func IsErr(err error) bool

IsErr 判断是否为业务错误

func New

func New(code uint32, msg string, httpCode ...int) error

New 新建业务错误

func NewCommon

func NewCommon(msg string, httpCode ...int) error

NewCommon 新建通用业务错误

与 New 效果相同,只是 Code 硬性指定为 CodeCommon,主要适用于该业务错误不确定指定什么业务状态码的情况

func NewInvalidParams

func NewInvalidParams(msg string, httpCode ...int) error

NewInvalidParams 新建请求参数错误

与 New 效果相同,只是 Code 硬性指定为 CodeInvalidParams,主要适用于该业务错误为请求参数错误的情况

Types

type Err

type Err struct {
	Code     uint32
	HTTPCode int
	Msg      string
}

Err 业务错误

func FromError

func FromError(err error) (*Err, bool)

FromError 解析错误对应的业务错误

func FromMessage

func FromMessage(msg string) (*Err, bool)

FromMessage 解析业务消息对应的业务错误

func (*Err) Error

func (e *Err) Error() string

Error Err 实现 Error 方法

func (*Err) Format

func (e *Err) Format(s fmt.State, verb rune)

Format Err 实现 Format 方法

func (*Err) GRPCStatus

func (e *Err) GRPCStatus() *status.Status

GRPCStatus Err 实现 GRPCStatus 方法

func (*Err) String

func (e *Err) String() string

String Err 实现 String 方法

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL