errcode

Documentation

Index

• Constants
• Variables
• func CodeFromGrpcCode(code codes.Code) int
• func CodeFromGrpcError(err error) int
• func Is(err, target error) bool
• func IsErr(err error) bool
• func IsGrpcError(err error) bool
• func New(code int, msg string, httpCode ...int) error
• type Err
  • func FromError(err error) (*Err, bool)
  • func FromMessage(msg string) (*Err, bool)
  • func (e *Err) Error() string
  • func (e *Err) Format(s fmt.State, verb rune)
  • func (e *Err) GRPCStatus() *status.Status
  • func (e *Err) String() string

Constants

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

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

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

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

业务状态码与消息

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

Variables

var (
	// NoErr 无错误
	NoErr = New(CodeOK, MsgOK)
	// ErrUnexpected 意外错误
	ErrUnexpected = New(CodeUnexpected, MsgUnexpected)
	// ErrInvalidParams 请求参数错误
	ErrInvalidParams = New(CodeInvalidParams, MsgInvalidParams)
)

业务错误

Functions

func CodeFromGrpcCode

func CodeFromGrpcCode(code codes.Code) int

CodeFromGrpcCode converts the gRPC code to an HTTP status code. See: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto

func CodeFromGrpcError

func CodeFromGrpcError(err error) int

CodeFromGrpcError converts the gRPC error to an HTTP status code. See: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto

func Is

func Is(err, target error) bool

Is 判断业务错误是否相同

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

func IsErr

func IsErr(err error) bool

IsErr 判断是否为业务错误

func IsGrpcError

func IsGrpcError(err error) bool

IsGrpcError checks if the error is a gRPC error.

func New

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

New 新建业务错误

Types

type Err

type Err struct {
	Code     int
	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 方法