exception

package
v2.0.24 Latest Latest
Warning

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

 Go to latest Published: Aug 31, 2024 License: MIT Imports: 5 Imported by: 75

Documentation

Index

Constants

View Source 
const (
	// OtherPlaceLoggedIn 登录登录
	OtherPlaceLoggedIn = 50010
	// OtherIPLoggedIn 异常IP登录
	OtherIPLoggedIn = 50011
	// OtherClientsLoggedIn 用户已经通过其他端登录
	OtherClientsLoggedIn = 50012
	// SessionTerminated 会话中断
	SessionTerminated = 50013
	// AccessTokenExpired token过期
	AccessTokenExpired = 50014
	// RefreshTokenExpired token过期
	RefreshTokenExpired = 50015
	// AccessTokenIllegal 访问token不合法
	AccessTokenIllegal = 50016
	// RefreshTokenIllegal 刷新token不合法
	RefreshTokenIllegal = 50017
	// VerifyCodeRequired 需要验证码
	VerifyCodeRequired = 50018
	// PasswordExired 用户密码过期
	PasswordExired = 50019

	// Unauthorized 未认证
	Unauthorized = http.StatusUnauthorized
	// BadRequest 请求不合法
	BadRequest = http.StatusBadRequest
	// InternalServerError 服务端内部错误
	InternalServerError = http.StatusInternalServerError
	// Forbidden 无权限
	Forbidden = http.StatusForbidden
	// NotFound 接口未找到
	NotFound = http.StatusNotFound
	// Conflict 资源冲突, 已经存在
	Conflict = http.StatusConflict

	// UnKnownException 未知异常
	UnKnownException = 99999
)
View Source 
const (
	// GRPC Trailer 异常转换时定义的key名称
	TRAILER_ERROR_JSON_KEY = "err_json"
)

Variables

This section is empty.

Functions

func IsAPIException added in v2.0.24 

func IsAPIException(err error, code int) bool

func IsConflictError 

func IsConflictError(err error) bool

IsConflictError 判断是否是Conflict

func IsError added in v2.0.15 

func IsError(err error, targetError *APIException) bool

func IsNotFoundError 

func IsNotFoundError(err error) bool

IsNotFoundError 判断是否是NotFoundError

Types

type APIException 

type APIException struct {
	Namespace string `json:"namespace"`
	HttpCode  int    `json:"http_code,omitempty"`
	BizCode   int    `json:"code"`
	Reason    string `json:"reason"`
	Message   string `json:"message"`
	Meta      any    `json:"meta"`
	Data      any    `json:"data"`
}

APIException API异常

func NewAPIException 

func NewAPIException(code int, reason string) *APIException

NewAPIException 创建一个API异常 用于其他模块自定义异常

func NewAPIExceptionFromError 

func NewAPIExceptionFromError(err error) *APIException

{"namespace":"","http_code":404,"error_code":404,"reason":"资源未找到","message":"test","meta":null,"data":null}

func NewAPIExceptionFromString 

func NewAPIExceptionFromString(msg string) *APIException

func NewAccessTokenExpired 

func NewAccessTokenExpired(format string, a ...interface{}) *APIException

NewAccessTokenExpired 访问token过期

func NewAccessTokenIllegal 

func NewAccessTokenIllegal(format string, a ...interface{}) *APIException

NewAccessTokenIllegal 访问token过期

func NewBadRequest 

func NewBadRequest(format string, a ...interface{}) *APIException

NewBadRequest todo

func NewConflict 

func NewConflict(format string, a ...interface{}) *APIException

NewConflict todo

func NewInternalServerError 

func NewInternalServerError(format string, a ...interface{}) *APIException

NewInternalServerError 500

func NewNotFound 

func NewNotFound(format string, a ...interface{}) *APIException

NewNotFound todo

func NewOtherClientsLoggedIn 

func NewOtherClientsLoggedIn(format string, a ...interface{}) *APIException

NewOtherClientsLoggedIn 其他端登录

func NewOtherIPLoggedIn 

func NewOtherIPLoggedIn(format string, a ...interface{}) *APIException

NewOtherIPLoggedIn 异常IP登录

func NewOtherPlaceLoggedIn 

func NewOtherPlaceLoggedIn(format string, a ...interface{}) *APIException

NewOtherPlaceLoggedIn 异地登录

func NewPasswordExired 

func NewPasswordExired(format string, a ...interface{}) *APIException

NewPasswordExired 50019

func NewPermissionDeny 

func NewPermissionDeny(format string, a ...interface{}) *APIException

NewPermissionDeny 没有权限访问

func NewRefreshTokenExpired 

func NewRefreshTokenExpired(format string, a ...interface{}) *APIException

NewRefreshTokenExpired 刷新token过期

func NewRefreshTokenIllegal 

func NewRefreshTokenIllegal(format string, a ...interface{}) *APIException

NewRefreshTokenIllegal 访问token过期

func NewSessionTerminated 

func NewSessionTerminated(format string, a ...interface{}) *APIException

NewSessionTerminated 会话结束

func NewUnauthorized 

func NewUnauthorized(format string, a ...interface{}) *APIException

NewUnauthorized 未认证

func NewVerifyCodeRequiredError 

func NewVerifyCodeRequiredError(format string, a ...interface{}) *APIException

NewVerifyCodeRequiredError 50018

func (*APIException) Error 

func (e *APIException) Error() string

func (*APIException) ErrorCode 

func (e *APIException) ErrorCode() int

Code exception's code, 如果code不存在返回-1

func (*APIException) GetData 

func (e *APIException) GetData() interface{}

func (*APIException) GetHttpCode 

func (e *APIException) GetHttpCode() int

Code exception's code, 如果code不存在返回-1

func (*APIException) GetMeta 

func (e *APIException) GetMeta() interface{}

func (*APIException) GetNamespace 

func (e *APIException) GetNamespace() string

func (*APIException) GetReason 

func (e *APIException) GetReason() string

func (*APIException) Is 

func (e *APIException) Is(t error) bool

func (*APIException) ToJson 

func (e *APIException) ToJson() string

func (*APIException) WithData 

func (e *APIException) WithData(d interface{}) *APIException

func (*APIException) WithHttpCode 

func (e *APIException) WithHttpCode(httpCode int) *APIException

func (*APIException) WithMessage added in v2.0.8 

func (e *APIException) WithMessage(m string) *APIException

func (*APIException) WithMessagef added in v2.0.15 

func (e *APIException) WithMessagef(format string, a ...any) *APIException

func (*APIException) WithMeta 

func (e *APIException) WithMeta(m interface{}) *APIException

WithMeta 携带一些额外信息

func (*APIException) WithNamespace 

func (e *APIException) WithNamespace(ns string) *APIException

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.