fserr/v2alpha/code.go

package fserr

import (
	"fmt"
	"net/http"
)

const (
	ErrBasic = iota + 1
	ErrDb
	ErrParam
)

// ErrCode 产生error所包含的错误码信息
// 支持http错误码、业务错误码
// 可通过下方快捷函数快速创建指定http码的错误码
type ErrCode struct {
	// HttpCode 该错误码建议的HTTP响应码
	HttpCode int `json:"httpCode,omitempty"`
	// BusinessCode 该错误码对应的业务码
	// +optional
	BusinessCode string `json:"businessCode,omitempty"`
	// Message 该错误码对应的错误信息
	// +optional
	Message string `json:"message,omitempty"`
}

// SetDefault 设置默认错误码
// 当错误码匹配失败时，提供的备选方案，已内置默认错误码，
// 它的HTTP码为200，业务码和信息均为零值
func SetDefault(httpCode, businessCode int, message string) {
	defaultErrCode = ErrCode{httpCode, fmt.Sprintf("%06d", businessCode), message}
}

// NewCode 创建指定信息的错误码
func NewCode(httpCode, businessCode int, message string) ErrCode {
	code := ErrCode{httpCode, fmt.Sprintf("%06d", businessCode), message}
	register(businessCode, code)
	return code
}

// === 以下均为见名知意的业务码构建方式 ===

func NewOK(businessCode int, message string) ErrCode {
	return NewCode(http.StatusOK, businessCode, message)
}

func NewNotFound(businessCode int, message string) ErrCode {
	return NewCode(http.StatusNotFound, businessCode, message)
}

func NewAlreadyExists(businessCode int, message string) ErrCode {
	return NewCode(http.StatusConflict, businessCode, message)
}

func NewGenerateNameConflict(businessCode int, message string) ErrCode {
	return NewCode(http.StatusConflict, businessCode, message)
}

func NewUnauthorized(businessCode int, message string) ErrCode {
	return NewCode(http.StatusUnauthorized, businessCode, message)
}

func NewForbidden(businessCode int, message string) ErrCode {
	return NewCode(http.StatusForbidden, businessCode, message)
}

func NewConflict(businessCode int, message string) ErrCode {
	return NewCode(http.StatusConflict, businessCode, message)
}

func NewGone(businessCode int, message string) ErrCode {
	return NewCode(http.StatusGone, businessCode, message)
}

func NewBadRequest(businessCode int, message string) ErrCode {
	return NewCode(http.StatusBadRequest, businessCode, message)
}

func NewTooManyRequests(businessCode int, message string) ErrCode {
	return NewCode(http.StatusTooManyRequests, businessCode, message)
}

func NewServiceUnavailable(businessCode int, message string) ErrCode {
	return NewCode(http.StatusServiceUnavailable, businessCode, message)
}

func NewMethodNotSupported(businessCode int, message string) ErrCode {
	return NewCode(http.StatusMethodNotAllowed, businessCode, message)
}

func NewInternalError(businessCode int, message string) ErrCode {
	return NewCode(http.StatusInternalServerError, businessCode, message)
}

func NewTimeoutError(businessCode int, message string) ErrCode {
	return NewCode(http.StatusGatewayTimeout, businessCode, message)
}

func NewTooManyRequestsError(businessCode int, message string) ErrCode {
	return NewCode(http.StatusTooManyRequests, businessCode, message)
}

func NewRequestEntityTooLargeError(businessCode int, message string) ErrCode {
	return NewCode(http.StatusRequestEntityTooLarge, businessCode, message)
}