错误消息
This commit is contained in:
@@ -0,0 +1,62 @@
|
|||||||
|
package errorx
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
|
||||||
|
"github.com/yuninks/langx"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 定义错误常量
|
||||||
|
|
||||||
|
type ErrorLanguage struct {
|
||||||
|
langx.LangError
|
||||||
|
}
|
||||||
|
|
||||||
|
// 生成错误常量
|
||||||
|
func NewLanguage(uniKey string, code int, defaultValue string) ErrorLanguage {
|
||||||
|
langx.AppendCode(map[string]int{uniKey: code})
|
||||||
|
langx.AppendTrans(langx.GetDefaultLang(), map[string]string{uniKey: defaultValue})
|
||||||
|
|
||||||
|
l := langx.NewStruct(context.Background(), uniKey, nil)
|
||||||
|
|
||||||
|
return ErrorLanguage{l}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Key生成错误信息
|
||||||
|
func (l ErrorLanguage) Err() error {
|
||||||
|
return l
|
||||||
|
}
|
||||||
|
|
||||||
|
// Key生成错误信息
|
||||||
|
func (l ErrorLanguage) Errf(format map[string]string) error {
|
||||||
|
newLang := l.Copy()
|
||||||
|
newLang.SetFormat(format)
|
||||||
|
return newLang
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l ErrorLanguage) ErrfKV(key, value string) error {
|
||||||
|
newLang := l.Copy()
|
||||||
|
newLang.SetFormatKV(key, value)
|
||||||
|
return newLang
|
||||||
|
}
|
||||||
|
|
||||||
|
// 获取翻译后的错误信息
|
||||||
|
func (l ErrorLanguage) Msg(ctx context.Context) string {
|
||||||
|
newLang := l.Copy()
|
||||||
|
newLang.SetCtx(ctx)
|
||||||
|
return newLang.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 获取翻译后的错误信息
|
||||||
|
func (l ErrorLanguage) Msgf(ctx context.Context, format map[string]string) string {
|
||||||
|
newLang := l.Copy()
|
||||||
|
newLang.SetCtx(ctx)
|
||||||
|
newLang.SetFormat(format)
|
||||||
|
return newLang.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
Success ErrorLanguage = NewLanguage("success", 200, "操作成功")
|
||||||
|
Error ErrorLanguage = NewLanguage("error", 400, "操作失败")
|
||||||
|
ErrWithMsg ErrorLanguage = NewLanguage("error_with_msg", 400, "操作失败: #msg#")
|
||||||
|
)
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
package errorx_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
"github.com/yuninks/langx"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestError(t *testing.T) {
|
||||||
|
var err error
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
langx.InitLangx(
|
||||||
|
langx.SetDefaultCode(0),
|
||||||
|
langx.SetDefaultLanguage("zh"),
|
||||||
|
)
|
||||||
|
langx.RegisterCode(map[string]int{
|
||||||
|
"login_success": 200,
|
||||||
|
"error": 400,
|
||||||
|
"username": 201,
|
||||||
|
})
|
||||||
|
langx.RegisterTrans("zh", map[string]string{
|
||||||
|
"login_success": "成功",
|
||||||
|
"error": "错误",
|
||||||
|
"username": "你好 #name#", // 有占位符
|
||||||
|
})
|
||||||
|
langx.RegisterTrans("en", map[string]string{
|
||||||
|
"login_success": "success",
|
||||||
|
"error": "error",
|
||||||
|
"username": "Hello #name#", // 有占位符
|
||||||
|
})
|
||||||
|
|
||||||
|
err = langx.NewError(ctx, "error")
|
||||||
|
// fmt.Printf("err: %v\n", err)
|
||||||
|
t.Log(err.Error())
|
||||||
|
val, ok := err.(langx.LangError)
|
||||||
|
if ok {
|
||||||
|
t.Log(val.GetCode())
|
||||||
|
}
|
||||||
|
|
||||||
|
err = langx.NewErrorf(ctx, "username", map[string]string{
|
||||||
|
"name": "yuninks",
|
||||||
|
})
|
||||||
|
t.Log(err.Error())
|
||||||
|
val, ok = err.(langx.LangError)
|
||||||
|
if ok {
|
||||||
|
t.Log(val.GetCode())
|
||||||
|
|
||||||
|
// 设置输出语言
|
||||||
|
val.SetLang("en")
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Log(val.Error())
|
||||||
|
|
||||||
|
}
|
||||||
@@ -1,135 +1,97 @@
|
|||||||
package errorx
|
package errorx
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"context"
|
||||||
"errors"
|
|
||||||
|
|
||||||
"google.golang.org/grpc/codes"
|
"github.com/yuninks/langx"
|
||||||
status "google.golang.org/grpc/status"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const defaultCode = 400
|
// Key生成错误信息
|
||||||
|
|
||||||
type Errorx struct {
|
type LangError interface {
|
||||||
list []CodeError
|
Copy() LangError // 复制一个新的错误信息
|
||||||
|
Error() string // 实现error接口&获取翻译后的错误信息
|
||||||
|
GetCode() int // 获取翻译后的Code
|
||||||
|
GetKey() string // 获取原Key值
|
||||||
|
GetFormat() map[string]string // 获取附加数据
|
||||||
|
SetFormat(format map[string]string) // 设置附加数据
|
||||||
|
SetCtx(ctxHttp context.Context) // 设置上下文
|
||||||
|
SetLang(lang string) // 设置语言
|
||||||
|
SetFormatKV(key, value string) // 设置附加数据键值对
|
||||||
}
|
}
|
||||||
|
|
||||||
type CodeError struct {
|
type langError struct {
|
||||||
*status.Status
|
ctx context.Context
|
||||||
// Code int `json:"code"`
|
key string
|
||||||
// Message string `json:"message"`
|
format map[string]string
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewCodeError(code int, msg string) error {
|
func (l *langError) Copy() LangError {
|
||||||
return &Errorx{
|
return &langError{
|
||||||
list: []CodeError{
|
ctx: l.ctx,
|
||||||
{
|
key: l.key,
|
||||||
status.New(codes.Code(code), msg),
|
format: l.format,
|
||||||
// Code: code,
|
|
||||||
// Message: msg,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func New(msg string) error {
|
func (e *langError) SetFormat(format map[string]string) {
|
||||||
return NewCodeError(defaultCode, msg)
|
e.format = format
|
||||||
}
|
}
|
||||||
|
|
||||||
func WithError(err error, msg string) error {
|
func (l *langError) SetFormatKV(key, value string) {
|
||||||
if err == nil {
|
if l.format == nil {
|
||||||
return NewCodeError(defaultCode, msg)
|
l.format = make(map[string]string)
|
||||||
}
|
}
|
||||||
e, ok := err.(*Errorx)
|
l.format[key] = value
|
||||||
if ok {
|
}
|
||||||
e.list = append(e.list, CodeError{
|
|
||||||
status.New(codes.Code(defaultCode), msg),
|
func (e *langError) SetCtx(ctxHttp context.Context) {
|
||||||
// Code: defaultCode,
|
e.ctx = ctxHttp
|
||||||
// Message: msg,
|
}
|
||||||
})
|
|
||||||
return e
|
func (l *langError) Error() string {
|
||||||
} else {
|
errLang := langx.GetCtxLang(l.ctx)
|
||||||
return &Errorx{
|
return langx.GetFormat(errLang, l.key, l.format)
|
||||||
list: []CodeError{
|
}
|
||||||
{
|
|
||||||
status.New(codes.Code(defaultCode), msg),
|
func (e *langError) GetCode() int {
|
||||||
// Code: defaultCode,
|
return langx.GetCode(e.key)
|
||||||
// Message: err.Error(),
|
}
|
||||||
},
|
|
||||||
{
|
func (e *langError) GetKey() string {
|
||||||
status.New(codes.Code(defaultCode), msg),
|
return e.key
|
||||||
// Code: defaultCode,
|
}
|
||||||
// Message: msg,
|
|
||||||
},
|
func (e *langError) GetFormat() map[string]string {
|
||||||
},
|
if e.format == nil {
|
||||||
}
|
e.format = make(map[string]string)
|
||||||
|
}
|
||||||
|
return e.format
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *langError) SetLang(lang string) {
|
||||||
|
e.ctx = langx.SetCtxLang(e.ctx, lang)
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewErrorf(ctx context.Context, key string, format map[string]string) error {
|
||||||
|
return &langError{
|
||||||
|
ctx: ctx,
|
||||||
|
key: key,
|
||||||
|
format: format,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (e *Errorx) Error() string {
|
func NewError(ctx context.Context, key string) error {
|
||||||
c := len(e.list)
|
return &langError{
|
||||||
if c == 0 {
|
ctx: ctx,
|
||||||
return ""
|
key: key,
|
||||||
}
|
}
|
||||||
|
|
||||||
return e.list[c-1].Message()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (e *Errorx) Code() int {
|
func NewStruct(ctx context.Context, key string, format map[string]string) LangError {
|
||||||
c := len(e.list)
|
return &langError{
|
||||||
if c == 0 {
|
ctx: ctx,
|
||||||
return 200
|
key: key,
|
||||||
|
format: format,
|
||||||
}
|
}
|
||||||
return int(e.list[c-1].Code())
|
|
||||||
}
|
|
||||||
|
|
||||||
func FromError(err error) (s *status.Status, ok bool) {
|
|
||||||
if err == nil {
|
|
||||||
return nil, true
|
|
||||||
}
|
|
||||||
type grpcstatus interface{ GRPCStatus() *status.Status }
|
|
||||||
if gs, ok := err.(grpcstatus); ok {
|
|
||||||
if gs.GRPCStatus() == nil {
|
|
||||||
// Error has status nil, which maps to codes.OK. There
|
|
||||||
// is no sensible behavior for this, so we turn it into
|
|
||||||
// an error with codes.Unknown and discard the existing
|
|
||||||
// status.
|
|
||||||
return status.New(codes.Unknown, err.Error()), false
|
|
||||||
}
|
|
||||||
return gs.GRPCStatus(), true
|
|
||||||
}
|
|
||||||
var gs grpcstatus
|
|
||||||
if errors.As(err, &gs) {
|
|
||||||
if gs.GRPCStatus() == nil {
|
|
||||||
// Error wraps an error that has status nil, which maps
|
|
||||||
// to codes.OK. There is no sensible behavior for this,
|
|
||||||
// so we turn it into an error with codes.Unknown and
|
|
||||||
// discard the existing status.
|
|
||||||
return status.New(codes.Unknown, err.Error()), false
|
|
||||||
}
|
|
||||||
p := gs.GRPCStatus().Proto()
|
|
||||||
p.Message = err.Error()
|
|
||||||
return status.FromProto(p), true
|
|
||||||
}
|
|
||||||
return status.New(codes.Unknown, err.Error()), false
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Errorx) GRPCStatus() *status.Status {
|
|
||||||
c := len(e.list)
|
|
||||||
if c == 0 {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return e.list[c-1].Status
|
|
||||||
}
|
|
||||||
func (e *Errorx) Is(target error) bool {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Errorx) Data() []CodeError {
|
|
||||||
return e.list
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Errorx) String() string {
|
|
||||||
b, _ := json.Marshal(e.list)
|
|
||||||
return string(b)
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,48 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
|
||||||
|
"github.com/yuninks/langx"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
|
||||||
|
err := ErrorWithMsg.Error()
|
||||||
|
|
||||||
|
// 输出：错误
|
||||||
|
println(err.Error())
|
||||||
|
|
||||||
|
err = ErrorWithMsg.Errorf(map[string]string{"msg": "错误"})
|
||||||
|
// 输出：错误
|
||||||
|
println(err.Error())
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
type Language string
|
||||||
|
|
||||||
|
// 添加key+默认语言
|
||||||
|
func newLanguage(uniKey string, code int, defaultValue string) Language {
|
||||||
|
langx.AppendCode(map[string]int{uniKey: code})
|
||||||
|
langx.AppendTrans("zh_hans", map[string]string{uniKey: defaultValue})
|
||||||
|
return Language(uniKey)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l Language) String() string {
|
||||||
|
return string(l)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l Language) Error() error {
|
||||||
|
return langx.NewError(context.Background(), l.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l Language) Errorf(format map[string]string) error {
|
||||||
|
return langx.NewErrorf(context.Background(), l.String(), format)
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
Success Language = newLanguage("success", 200, "成功")
|
||||||
|
|
||||||
|
Error Language = newLanguage("error", 400, "错误")
|
||||||
|
ErrorWithMsg Language = newLanguage("error_with_msg", 400, "错误 #msg#")
|
||||||
|
)
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"success":200,
|
||||||
|
"error":400
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"success":"Success",
|
||||||
|
"error":"Error #msg#"
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"success":"成功",
|
||||||
|
"error":"失败 #msg#"
|
||||||
|
}
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"embed"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/yuninks/langx"
|
||||||
|
)
|
||||||
|
|
||||||
|
//go:embed lang
|
||||||
|
var assetsFs embed.FS
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
regByAppend()
|
||||||
|
}
|
||||||
|
|
||||||
|
// 导入语言包 基于Append
|
||||||
|
func regByAppend() {
|
||||||
|
langx.AppendCode(map[string]int{
|
||||||
|
"success": 200,
|
||||||
|
})
|
||||||
|
langx.AppendTrans("zh-CN", map[string]string{
|
||||||
|
"success": "成功",
|
||||||
|
})
|
||||||
|
|
||||||
|
code, msg := langx.GetTransFormat("zh-CN", "success", map[string]string{})
|
||||||
|
fmt.Println(code, msg)
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// 导入语言包 基于Embed
|
||||||
|
func regByEmbed() {
|
||||||
|
err := langx.RegisterEmbed(assetsFs)
|
||||||
|
fmt.Println(err)
|
||||||
|
|
||||||
|
code, msg := langx.GetTransFormat("zh", "success", map[string]string{})
|
||||||
|
fmt.Println(code, msg)
|
||||||
|
code, msg = langx.GetTransFormat("en", "error", map[string]string{
|
||||||
|
"msg": "这是失败的原因",
|
||||||
|
})
|
||||||
|
fmt.Println(code, msg)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 导入语言包 基于文件
|
||||||
|
func regByDir() {
|
||||||
|
langx.RegisterDir("./lang")
|
||||||
|
|
||||||
|
code, msg := langx.GetTransFormat("zh", "success", map[string]string{})
|
||||||
|
fmt.Println(code, msg)
|
||||||
|
code, msg = langx.GetTransFormat("en", "error", map[string]string{
|
||||||
|
"msg": "这是失败的原因",
|
||||||
|
})
|
||||||
|
fmt.Println(code, msg)
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# 导入资源
|
||||||
|
|
||||||
|
# 通过embed导入
|
||||||
|
|
||||||
|
# 通过文件导入
|
||||||
|
|
||||||
|
# 追加导入
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
module github.com/yuninks/errorx
|
||||||
|
|
||||||
|
go 1.22.4
|
||||||
|
|
||||||
|
require github.com/yuninks/langx v0.0.6
|
||||||
Reference in New Issue
Block a user