调整日志

gin.go

@@ -8,18 +8,30 @@ func GinError(ctx *gin.Context, err error) {
 	Error(ctx, ctx.Writer, err)
 }
 
+func GinErrorData(ctx *gin.Context, err error, data any) {
+	ErrorWithData(ctx, ctx.Writer, err, data)
+}
+
 func GinErrorStr(ctx *gin.Context, msg string) {
 	ErrorStr(ctx, ctx.Writer, msg)
 }
 
-func GinSuccess(ctx *gin.Context, data interface{}, info ...interface{}) {
+func GinSuccess(ctx *gin.Context, data any) {
-	Success(ctx, ctx.Writer, data, info)
+	Success(ctx, ctx.Writer, data)
 }
 
-func GinSuccessWithPage(ctx *gin.Context, data interface{}, page pagination) {
+func GinSuccessWithPage(ctx *gin.Context, data any, page pagination) {
-	SuccessWithPage(ctx, ctx.Writer, data, page)
+	SuccessWithPage(ctx, ctx.Writer, data, &page)
 }
 
-func GinFormatMessage(ctx *gin.Context, message string, format map[string]string, data interface{}) {
+func GinOptions(ctx *gin.Context, ops ...Option) {
-	FormatMessage(ctx, ctx.Writer, message, format, data)
+	ResponseCtx(ctx, ctx.Writer, ops...)
+}
+
+func GinMsgMapData(ctx *gin.Context, msgKey string, format map[string]string, data any) {
+	FormatMessage(ctx, ctx.Writer, msgKey, format, data)
+}
+
+func GinMsgKV(ctx *gin.Context, msgKey string, k string, v string) {
+	FormatMessage(ctx, ctx.Writer, msgKey, map[string]string{k: v}, nil)
 }

go.mod

@@ -1,10 +1,11 @@
 module code.yun.ink/pkg/responsex
 
-go 1.20
+go 1.22.4
 
 require (
 	github.com/gin-gonic/gin v1.9.1
-	github.com/yuninks/langx v0.0.1
+	github.com/yuninks/errorx v0.0.1
+	github.com/yuninks/langx v0.0.7
 	github.com/zeromicro/go-zero v1.6.4
 	gorm.io/gorm v1.25.9
 )
@@ -58,6 +59,5 @@ require (
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20240227224415-6ceb2ff114de // indirect
 	google.golang.org/grpc v1.63.0 // indirect
 	google.golang.org/protobuf v1.33.0 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -23,6 +23,7 @@ github.com/go-logr/logr v1.3.0/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ4
 github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
 github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
 github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s=
+github.com/go-playground/assert/v2 v2.2.0/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
 github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA=
 github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY=
 github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY=
@@ -32,9 +33,10 @@ github.com/go-playground/validator/v10 v10.14.0/go.mod h1:9iXMNT7sEkjXb0I+enO7QX
 github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU=
 github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
 github.com/golang/glog v1.2.0 h1:uCdmnmatrKCgMBlM4rMuJZWOkPDqdbZPnrMXDY4gI68=
+github.com/golang/glog v1.2.0/go.mod h1:6AhwSGph0fcJtXVM/PEHPqZlFeoLxhs7/t5UDAwmO+w=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
-github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/grpc-ecosystem/grpc-gateway/v2 v2.18.0 h1:RtRsiaGvWxcwd8y3BiRZxsylPT8hLWZ5SPcfI+3IDNk=
 github.com/grpc-ecosystem/grpc-gateway/v2 v2.18.0/go.mod h1:TzP6duP4Py2pHLVPPQp42aoYI92+PCrVotyR5e8Vqlk=
 github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
@@ -47,7 +49,9 @@ github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa02
 github.com/klauspost/cpuid/v2 v2.2.4 h1:acbojRNwl3o09bUq+yDCtZFc1aiwaAAxtcn8YkZXnvk=
 github.com/klauspost/cpuid/v2 v2.2.4/go.mod h1:RVVoqg1df56z8g3pUjL/3lE5UfnlrJX8tyFgg4nqhuY=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/leodido/go-urn v1.2.4 h1:XlAE/cm/ms7TE/VMVoduSpNBoyc2dOxHs5MZSwAN63Q=
 github.com/leodido/go-urn v1.2.4/go.mod h1:7ZrI8mTSeBSHl/UaRyKQW1qZeMgak41ANeCNaVckg+4=
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
@@ -67,7 +71,9 @@ github.com/pelletier/go-toml/v2 v2.2.0/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/prashantv/gostub v1.1.0 h1:BTyx3RfQjRHnUWaGF9oQos79AlQ5k8WNktv7VGvVH4g=
+github.com/prashantv/gostub v1.1.0/go.mod h1:A5zLQHz7ieHGG7is6LLXLz7I8+3LZzsrV0P1IAHhP5U=
 github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
+github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
 github.com/spaolacci/murmur3 v1.1.0 h1:7c1g84S4BPRrfL5Xrdp6fOJ206sU9y293DDHaoy0bLI=
 github.com/spaolacci/murmur3 v1.1.0/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
@@ -88,8 +94,10 @@ github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS
 github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08=
 github.com/ugorji/go/codec v1.2.11 h1:BMaWp1Bb6fHwEtbplGBGJ498wD+LKlNSl25MjdZY4dU=
 github.com/ugorji/go/codec v1.2.11/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg=
-github.com/yuninks/langx v0.0.1 h1:Ee4vXAVcyXSCms0qtEd/jANYlKO7IIGVTD5NOLdpCJo=
+github.com/yuninks/errorx v0.0.1 h1:QFSSHnlCfRPPefzspgksGU+eYW5cSr/jkSG1IalM6yM=
-github.com/yuninks/langx v0.0.1/go.mod h1:nAylzjNIjCThhEQSJsIKP8Vhja0aJlcyig+NsNPZLSk=
+github.com/yuninks/errorx v0.0.1/go.mod h1:N9e4ShfCTkLjHnGShAG0x9n2SYtCDKhKDMxRmyr05hU=
+github.com/yuninks/langx v0.0.7 h1:QUt27h/FjnT7//759GoM/+p4ew+HBr10ZN/fkqeQfyA=
+github.com/yuninks/langx v0.0.7/go.mod h1:nAylzjNIjCThhEQSJsIKP8Vhja0aJlcyig+NsNPZLSk=
 github.com/zeromicro/go-zero v1.6.4 h1:GvZXxxwl1Lby/gIHxHwN/ZNmXl1WFJa1DvoVgqgttUs=
 github.com/zeromicro/go-zero v1.6.4/go.mod h1:dQ39Zoz20/6x/SUhFXyEEg8lWjl+CO3dzg8Je2xG63Q=
 go.opentelemetry.io/otel v1.19.0 h1:MuS/TNf4/j4IXsZuJegVzI1cwut7Qc00344rgH7p8bs=
@@ -117,6 +125,7 @@ go.opentelemetry.io/proto/otlp v1.0.0/go.mod h1:Sy6pihPLfYHkr3NkUbEhGHFhINUSI/v8
 go.uber.org/automaxprocs v1.5.3 h1:kWazyxZUrS3Gs4qUpbwo5kEIMGe/DAvi5Z4tl2NW4j8=
 go.uber.org/automaxprocs v1.5.3/go.mod h1:eRbA25aqJrxAbsLO0xy5jVwPt7FQnRgjW+efnwa1WM0=
 go.uber.org/goleak v1.2.1 h1:NBol2c7O1ZokfZ0LEU9K6Whx/KnwvepVetCUhtKja4A=
+go.uber.org/goleak v1.2.1/go.mod h1:qlT2yGI9QafXHhZZLxlSuNsMw3FFLxBr+tBRlmO1xH4=
 golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
 golang.org/x/arch v0.3.0 h1:02VY4/ZcO/gBOH6PUaoiptASxtXU10jazRCP865E97k=
 golang.org/x/arch v0.3.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
@@ -132,6 +141,7 @@ golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 google.golang.org/genproto v0.0.0-20240227224415-6ceb2ff114de h1:F6qOa9AZTYJXOUEr4jDysRDLrm4PHePlge4v4TGAlxY=
+google.golang.org/genproto v0.0.0-20240227224415-6ceb2ff114de/go.mod h1:VUhTRKeHn9wwcdrk73nvdC9gF178Tzhmt/qyaFcPLSo=
 google.golang.org/genproto/googleapis/api v0.0.0-20240227224415-6ceb2ff114de h1:jFNzHPIeuzhdRwVhbZdiym9q0ory/xY3sA+v2wPg8I0=
 google.golang.org/genproto/googleapis/api v0.0.0-20240227224415-6ceb2ff114de/go.mod h1:5iCWqnniDlqZHrd3neWVTOwvh/v6s3232omMecelax8=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20240227224415-6ceb2ff114de h1:cZGRis4/ot9uVm639a+rHCUaG0JJHEsdyzSQTMX+suY=
@@ -142,12 +152,10 @@ google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGm
 google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
-gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
-gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gorm.io/gorm v1.25.9 h1:wct0gxZIELDk8+ZqF/MVnHLkA1rvYlBWUMv2EdsK1g8=
 gorm.io/gorm v1.25.9/go.mod h1:hbnx/Oo0ChWMn1BIhpy1oYozzpM15i4YPuHDmfYtwg8=
-k8s.io/utils v0.0.0-20230726121419-3b25d923346b h1:sgn3ZU783SCgtaSJjpcVVlRqd6GSnlTLKgpAAttJvpI=
 rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=

options.go

@@ -6,9 +6,16 @@ import (
 )
 
 type options struct {
-	logger    Logger
+	logger             Logger
-	ignoreLog bool
+	ignoreLog          bool
-	traceId   string
+	traceId            string
+	defaultSuccessCode int
+	defaultErrorCode   int
+
+	code       int
+	data       any
+	message    string
+	pagination *pagination
 }
 
 var op *options = nil
@@ -25,12 +32,56 @@ func InitOptions(ops ...Option) {
 
 func defaultOptions() *options {
 	return &options{
-		logger: &defaultLogger{},
+		logger:             &defaultLogger{},
+		defaultSuccessCode: 200,
+		defaultErrorCode:   400,
+
+		code:    200,
+		data:    nil, // 默认为nil
+		message: "请求成功",
 	}
 }
 
 type Option func(*options)
 
+func SetCode(code int) Option {
+	return func(o *options) {
+		o.code = code
+	}
+}
+
+func SetData(data any) Option {
+	return func(o *options) {
+		o.data = data
+	}
+}
+
+func SetMessage(message string) Option {
+	return func(o *options) {
+		o.message = message
+	}
+}
+
+func SetPage(page *pagination) Option {
+	return func(o *options) {
+		o.pagination = page
+	}
+}
+
+// 设置默认的成功code
+func SetDefaultSuccessCode(code int) Option {
+	return func(o *options) {
+		o.defaultSuccessCode = code
+	}
+}
+
+// 设置默认的失败code
+func SetDefaultErrorCode(code int) Option {
+	return func(o *options) {
+		o.defaultErrorCode = code
+	}
+}
+
 // 是否需要打印日志
 func SetIgnoreLog() Option {
 	return func(o *options) {
@@ -45,7 +96,7 @@ func SetLogger(logger Logger) Option {
 	}
 }
 
-// 是否需要响应trace_id
+// 是否需要响应trace_id,&ctx里面的字段
 func SetTraceId(traceId string) Option {
 	return func(o *options) {
 		o.traceId = traceId

readme.md

@@ -0,0 +1,6 @@
+# 功能说明
+
+1. 这个是API响应封装组件
+2. 支持多多语言的错误码和错误提示
+3. 优化了gin框架的响应体验
+4. 支持gozero框架的traceid

response.go

@@ -9,10 +9,19 @@ import (
 	"math"
 	"net/http"
 
+	"github.com/yuninks/errorx"
 	"github.com/yuninks/langx"
 	"github.com/zeromicro/go-zero/core/trace"
 )
 
+type response struct {
+	Code       int         `json:"code"`
+	Message    string      `json:"message"`
+	Data       any         `json:"data,omitempty"`
+	Pagination *pagination `json:"pagination,omitempty"`
+	TraceId    string      `json:"trace_id,omitempty"`
+}
+
 type pagination struct {
 	Page       int64 `json:"page"`
 	Size       int64 `json:"size"`
@@ -49,80 +58,83 @@ func GetPage(page, size, totalCount int64) pagination {
 }
 
 // Msg格式化响应
-func FormatMessage(ctx context.Context, w http.ResponseWriter, message string, format map[string]string, data interface{}) {
+func FormatMessage(ctx context.Context, w http.ResponseWriter, msgKey string, format map[string]string, data interface{}) {
-	code, msg := langx.GetTrans(message, message, format)
+	code, msg := langx.GetTransFormatCtx(ctx, msgKey, format)
-	ResponseCtx(ctx, w, code, msg, data)
+	ResponseCtx(ctx, w, SetCode(code), SetMessage(msg), SetData(data))
 }
 
 // 成功的响应
-func Success(ctx context.Context, w http.ResponseWriter, data interface{}, info ...interface{}) {
+func Success(ctx context.Context, w http.ResponseWriter, data any) {
-	ResponseCtx(ctx, w, 200, "请求成功", data, info)
+	ResponseCtx(ctx, w, SetCode(op.defaultSuccessCode), SetMessage("请求成功"), SetData(data))
 }
 
-func SuccessWithPage(ctx context.Context, w http.ResponseWriter, data interface{}, page pagination) {
+func SuccessWithPage(ctx context.Context, w http.ResponseWriter, data any, page *pagination) {
-	ResponseCtx(ctx, w, 200, "请求成功", data, page)
+	ResponseCtx(ctx, w, SetCode(op.defaultSuccessCode), SetMessage("请求成功"), SetData(data), SetPage(page))
 }
 
 // 失败的响应
 func Error(ctx context.Context, w http.ResponseWriter, err error) {
-	code := 400
+	ErrorWithData(ctx, w, err, "")
+}
+
+func ErrorWithData(ctx context.Context, w http.ResponseWriter, err error, data interface{}) {
+	code := op.defaultErrorCode
 	msg := "请求失败"
 	if err != nil {
-		val, ok := err.(*langx.LangError)
+		val, ok := err.(errorx.ErrorInterface)
 		if ok {
-			code = val.Code()
+			if langx.GetDefaultCode() != val.GetCode() {
-			msg = err.Error()
+				code = val.GetCode()
+			}
 		}
+		msg = err.Error()
 	}
-	ResponseCtx(ctx, w, code, msg, "")
+	ResponseCtx(ctx, w, SetCode(code), SetMessage(msg), SetData(data))
 }
 
 func ErrorStr(ctx context.Context, w http.ResponseWriter, msg string) {
-	code, msg := langx.GetTrans("zh-CN", msg, nil)
+	msg = langx.GetMsgCtx(ctx, msg)
-	ResponseCtx(ctx, w, code, msg, "")
+	code := langx.GetCode(msg)
+	if code == langx.GetDefaultCode() {
+		code = op.defaultErrorCode
+	}
+	ResponseCtx(ctx, w, SetCode(code), SetMessage(msg))
 }
 
 // 基础的响应
-func ResponseCtx(ctx context.Context, w http.ResponseWriter, code int, message string, data interface{}, other ...interface{}) {
+func ResponseCtx(ctx context.Context, w http.ResponseWriter, ops ...Option) {
 
-	res := make(map[string]interface{})
+	def := defaultOptions() // 默认值
-	res["code"] = code
+	for _, o := range ops {
-	res["message"] = message
+		o(def)
-
-	// 分页的内容
-	var page *pagination
-	for _, value := range other {
-		vv, ok := value.(pagination)
-		if ok {
-			page = &vv
-		}
 	}
 
-	if page == nil {
+	resp := response{}
-		// 不需要分页
+	resp.Code = def.code
-		res["data"] = data
+	resp.Message = def.message
-	} else {
+	resp.Data = def.data
-		res["data"] = data
+	resp.Pagination = def.pagination
-		res["pagination"] = page
-	}
 
 	// 获取trace_id
-	if op.traceId != "" {
+	if def.traceId != "" {
-		t := ctx.Value(op.traceId)
+		t := ctx.Value(def.traceId)
 		if t != nil {
-			res["trace_id"] = t
+			val, ok := t.(string)
+			if ok {
+				resp.TraceId = val
+			}
 		} else {
 			// go-zero
-			res["trace_id"] = trace.TraceIDFromContext(ctx)
+			resp.TraceId = trace.TraceIDFromContext(ctx)
 		}
 	}
 
-	if !op.ignoreLog {
+	bs, _ := json.Marshal(resp)
-		// 记录日志
-		op.logger.Info(ctx, res)
-	}
 
-	bs, _ := json.Marshal(res)
+	if !def.ignoreLog {
+		// 记录日志
+		def.logger.Info(ctx, "response:", string(bs))
+	}
 
 	w.Header().Set("Content-Type", "application/json; charset=utf-8")
 	w.WriteHeader(200)