完善错误码的用法

This commit is contained in:
yun
2026-07-22 00:05:37 +08:00
parent 8eaa8a6933
commit 4e81b83ab6
6 changed files with 620 additions and 211 deletions
+59 -23
View File
@@ -1,9 +1,11 @@
package main
import (
"context"
"embed"
"fmt"
"github.com/yuninks/errorx"
"github.com/yuninks/langx"
)
@@ -11,44 +13,78 @@ import (
var assetsFs embed.FS
func main() {
langx.InitLangx(
langx.SetDefaultCode(0),
langx.SetDefaultLanguage("zh"),
)
fmt.Println("=== 方式1:逐条追加(适合少量错误码) ===")
regByAppend()
fmt.Println()
fmt.Println("=== 方式2embed 导入 JSON 文件(适合中型项目) ===")
regByEmbed()
fmt.Println()
fmt.Println("=== 方式3:目录文件导入(适合部署时外部管理) ===")
regByDir()
}
// 导入语言包 基于Append
// 方式1:逐条追加 — 适合少量错误码或动态注册场景。
func regByAppend() {
langx.AppendCode(map[string]int{
"success": 200,
})
langx.AppendTrans("zh-CN", map[string]string{
"success": "成功",
})
// 先用 langx 注册语言包
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)
// 然后用 errorx.NewCode 创建错误码(会自动调用 langx.Append*
loginErr := errorx.NewCode("login_err", 401, "用户名或密码错误")
langx.AppendTrans("en", map[string]string{"login_err": "Invalid username or password"})
ctx := context.Background()
err := loginErr.New(ctx)
fmt.Printf(" code=%d, msg=%s\n", err.Code(), err.Error())
}
// 导入语言包 基于Embed
// 方式2embed 导入 — JSON 文件编译进二进制,适合中型项目。
func regByEmbed() {
err := langx.RegisterEmbed(assetsFs)
fmt.Println(err)
if err := langx.RegisterEmbed(assetsFs); err != nil {
fmt.Println("embed 导入失败:", err)
return
}
code, msg := langx.GetTransFormat("zh", "success", map[string]string{})
fmt.Println(code, msg)
code, msg = langx.GetTransFormat("en", "error", map[string]string{
"msg": "这是失败的原因",
// JSON 中已声明的 error/success,直接用 key 创建 errorx 实例
ctx := context.Background()
err1 := errorx.NewError(ctx, "error")
fmt.Printf(" error: code=%d, msg(zh)=%s\n", err1.Code(), err1.Error())
err2 := errorx.NewError(ctx, "success")
fmt.Printf(" success: code=%d, msg(zh)=%s\n", err2.Code(), err2.Error())
// 带占位符
err3 := errorx.NewErrorf(ctx, "error", map[string]string{
"msg": "数据库连接超时",
})
fmt.Println(code, msg)
fmt.Printf(" error+format(zh): %s\n", err3.Error())
// 切换到英文
err4 := errorx.NewErrorf(ctx, "error", map[string]string{
"msg": "database connection timeout",
}).WithLang("en")
fmt.Printf(" error+format(en): %s\n", err4.Error())
}
// 导入语言包 基于文件
// 方式3:目录文件导入 — 语言文件放在外部目录,支持运行时热加载。
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": "这是失败的原因",
ctx := context.Background()
err := errorx.NewErrorf(ctx, "error", map[string]string{
"msg": "磁盘空间不足",
})
fmt.Println(code, msg)
fmt.Printf(" code=%d, msg=%s\n", errorx.CodeFrom(err), err.Error())
}
+44 -4
View File
@@ -1,7 +1,47 @@
# 导入资源
# 语言包导入
# 通过embed导入
errorx 支持三种方式导入多语言资源。
# 通过文件导入
## 方式1:逐条追加(Append
# 追加导入
适合错误码较少、运行时动态注册的场景。
```go
langx.AppendCode(map[string]int{"success": 200})
langx.AppendTrans("zh", map[string]string{"success": "成功"})
```
## 方式2Embed 导入
适合中型项目,JSON 文件编译进可执行文件。
目录结构:
```
lang/
code.json → {"success": 200, "error": 400}
zh.json → {"success": "成功", "error": "失败 #msg#"}
en.json → {"success": "Success", "error": "Error #msg#"}
```
Go 代码:
```go
//go:embed lang
var assetsFs embed.FS
langx.RegisterEmbed(assetsFs)
```
## 方式3:目录导入
适合部署时外部管理语言包,支持不重启更新。
```go
langx.RegisterDir("./lang")
```
## JSON 格式
- `code.json`:错误码映射 `key → int`
- `{lang}.json`:翻译映射 `key → 翻译文本`,支持 `#placeholder#` 占位符