136 lines
3.0 KiB
Go
136 lines
3.0 KiB
Go
package response
|
|
|
|
import (
|
|
"base-go-v2/internal/logx"
|
|
"base-go-v2/internal/router"
|
|
"base-go-v2/internal/routinex"
|
|
"base-go-v2/internal/utils/strutil"
|
|
"net/http"
|
|
)
|
|
|
|
// Result 是最终响应结构体
|
|
type Result struct {
|
|
IsSuccess bool `json:"isSuccess"` // 是否成功
|
|
Code string `json:"code"` // 状态码
|
|
Message string `json:"message"` // 提示信息
|
|
Data interface{} `json:"data,omitempty"` // 数据
|
|
TrackId string `json:"trackId,omitempty"` // 请求追踪ID
|
|
}
|
|
|
|
// Code 定义状态码
|
|
type Code struct {
|
|
Value string
|
|
Message string
|
|
}
|
|
|
|
// 常用状态码
|
|
var (
|
|
CodeSuccess = Code{"0000", "请求成功"}
|
|
CodeFail = Code{"0001", "请求失败"}
|
|
CodeNoLogin = Code{"1001", "未登录"}
|
|
CodeLoginExpired = Code{"1002", "登录已过期"}
|
|
CodeInvalidToken = Code{"1003", "Token 无效"}
|
|
CodeInvalidAccount = Code{"1005", "账号或密码错误"}
|
|
)
|
|
|
|
const defaultMessage = "未知错误"
|
|
|
|
// Builder 用于构建响应
|
|
type Builder struct {
|
|
c *router.Context
|
|
result Result
|
|
}
|
|
|
|
// ---------------- 构造函数 ----------------
|
|
|
|
// Success 创建成功响应
|
|
func Success(c *router.Context) *Builder {
|
|
return &Builder{
|
|
c: c,
|
|
result: Result{
|
|
IsSuccess: true,
|
|
Code: CodeSuccess.Value,
|
|
Message: CodeSuccess.Message,
|
|
},
|
|
}
|
|
}
|
|
|
|
// Error 创建失败响应
|
|
func Error(c *router.Context) *Builder {
|
|
return &Builder{
|
|
c: c,
|
|
result: Result{
|
|
IsSuccess: false,
|
|
Code: CodeFail.Value,
|
|
Message: CodeFail.Message,
|
|
},
|
|
}
|
|
}
|
|
|
|
// ---------------- 链式方法 ----------------
|
|
|
|
// 设置 IsSuccess 字段
|
|
func (b *Builder) IsSuccess(IsSuccess bool) *Builder {
|
|
b.result.IsSuccess = IsSuccess
|
|
return b
|
|
}
|
|
|
|
// 设置 Code，并根据 Code 自动设置 IsSuccess
|
|
func (b *Builder) Code(code string) *Builder {
|
|
b.result.Code = code
|
|
b.result.Message = GetMessage(code)
|
|
b.result.IsSuccess = code == CodeSuccess.Value
|
|
return b
|
|
}
|
|
|
|
// 设置 Code 对象，并自动设置 IsSuccess
|
|
func (b *Builder) CodeObj(code Code) *Builder {
|
|
b.result.Code = code.Value
|
|
b.result.Message = code.Message
|
|
b.result.IsSuccess = code.Value == CodeSuccess.Value
|
|
return b
|
|
}
|
|
|
|
// 自定义提示信息
|
|
func (b *Builder) Message(msg string) *Builder {
|
|
b.result.Message = msg
|
|
return b
|
|
}
|
|
|
|
// 设置返回数据
|
|
func (b *Builder) Data(data interface{}) *Builder {
|
|
b.result.Data = data
|
|
return b
|
|
}
|
|
|
|
// 发送响应
|
|
func (b *Builder) Send() error {
|
|
// 默认 Data 为空
|
|
if b.result.Data == nil {
|
|
b.result.Data = ""
|
|
}
|
|
|
|
// 从 routinex 获取 trackId
|
|
trackId := routinex.Get(logx.TrackID)
|
|
if trackId != nil {
|
|
b.result.TrackId = strutil.ToString(trackId)
|
|
}
|
|
|
|
return b.c.JSON(http.StatusOK, b.result)
|
|
}
|
|
|
|
// ---------------- 辅助函数 ----------------
|
|
|
|
// 根据 Code 获取默认提示信息
|
|
func GetMessage(value string) string {
|
|
for _, c := range []Code{
|
|
CodeSuccess, CodeFail, CodeNoLogin,
|
|
CodeLoginExpired, CodeInvalidToken, CodeInvalidAccount,
|
|
} {
|
|
if c.Value == value {
|
|
return c.Message
|
|
}
|
|
}
|
|
return defaultMessage
|
|
}
|