go-zero(四) 错误处理(统一响应信息)

go-zero 错误处理(统一响应信息)

在实现注册逻辑时,尝试重复注册可能会返回 400 状态码,显然不符合正常设计思维。我们希望状态码为 200,并在响应中返回错误信息。

一、使用第三方库

1.下载库

目前 go-zero官方的 zeromicro 下有一个 x 仓库,可以实现统一响应格式,我们先安装下:

bash 复制代码
go get github.com/zeromicro/x

它会自动帮我们把响应信息改为下面这种格式:

json 复制代码
{
  "code": 0,
  "msg": "ok",
  "data": {
    ...
  }
}

2.修改handler

接着我们修改internal/handler/register/registerhandler.go文件,把原来的响应处理,替换成这个库的:

go 复制代码
//导入zeromicro库并设置别名,避免和原生的http冲突
import (
	xhttp "github.com/zeromicro/x/http"  
)

//修改RegisterHandler的返回信息
func RegisterHandler(svcCtx *svc.ServiceContext) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		var req types.RegisterRequest
		if err := httpx.Parse(r, &req); err != nil {
			//使用xhttp.JsonBaseResponseCtx 替换掉httpx.ErrorCtx
			xhttp.JsonBaseResponseCtx(r.Context(), w, err)
			//httpx.ErrorCtx(r.Context(), w, err)
			return
		}

		l := register.NewRegisterLogic(r.Context(), svcCtx)
		resp, err := l.Register(&req)
		if err != nil {
			//使用xhttp.JsonBaseResponseCtx 替换掉httpx.ErrorCtx
			xhttp.JsonBaseResponseCtx(r.Context(), w, err)
			//httpx.ErrorCtx(r.Context(), w, err)
		} else {
			//使用xhttp.JsonBaseResponseCtx 替换掉httpx.OkJsonCtx
			xhttp.JsonBaseResponseCtx(r.Context(), w, resp)
			//httpx.OkJsonCtx(r.Context(), w, resp)
		}
	}
}

3.修改返回错误

internal/logic/user/registerlogic.go 文件中,把原来的err 修改成 errors.New() ,它的参数有两个,一个是用来返回 code码 ,还有一个是message消息:

go 复制代码
func (l *RegisterLogic) Register(req *types.RegisterRequest) (resp *types.RegisterResponse, err error) {
	// todo: add your logic here and delete this line
	/*
	.....
	*/
	
	if user != nil {
		//return nil, err
		return nil, errors.New(1, "用户已注册")
	}
	//插入新的数据
	/*
	.....
	*/
	if err != nil {
		//return nil, err
		return nil, errors.New(2, "用户注册失败")
	}


}

接着我们运行项目,使用Postman重新测试,结果如下:

二、自定义错误管理

如果你不想使用这个库,或者想自己实现一些自定义错误,那么你也可以自己设置错误管理

1.自定义错误结构与格式化

我们在internal目录下新建biz目录,用于业务处理,然后再这个目录下分别创建3个文件

创建biz.go 文件

go 复制代码
package biz

type Error struct {
	Code int    `json:"code"`
	Msg  string `json:"msg"`
}

func NewError(code int, msg string) *Error {
	return &Error{
		Code: code,
		Msg:  msg,
	}
}

func (e *Error) Error() string {
	return e.Msg
}

创建resp.go 文件

go 复制代码
package biz

type Result struct {
	Code int    `json:"code"`
	Msg  string `json:"msg"`
	Data any    `json:"data"`
}

func Success(data any) *Result {
	return &Result{
		Code: Ok,
		Msg:  "success",
		Data: data,
	}
}

func Fail(err *Error) *Result {
	return &Result{
		Code: err.Code,
		Msg:  err.Msg,
	}
}

创建vars.go 文件

go 复制代码
package biz

const Ok = 200

var (
	AlreadyRegister = NewError(1, "用户已注册")
	PasswordErr     = NewError(2, "密码错误")
	InsertErr       = NewError(3, "用户注册失败")
)

2. 使用 httpx.Error 和 httpx.SetErrorHandler

接着修改user.go 文件:

go 复制代码
	/*
	....
	*/
	defer server.Stop()
	
	//httpx.SetErrorHandler 函数可以帮助你定义一个全局的错误处理逻辑,
	//该逻辑会在 HTTP handler 中捕获到的所有错误中执行。
	//它将允许你统一处理各类错误,返回更加一致和用户友好的响应。
	//httpx.SetErrorHandler 仅在调用了 httpx.Error 处理响应时才有效。
	httpx.SetErrorHandler(func(err error) (int, any) {
		switch e := err.(type) {
		case *biz.Error:
			// 自定义一个 错误返回类型
			return http.StatusOK, biz.Fail(e)
		default:
			return http.StatusInternalServerError, nil
		}
	})

	ctx := svc.NewServiceContext(c)
		/*
	....
	*/

修改internal/handler/register/registerhandler.go文件:

go 复制代码
func RegisterHandler(svcCtx *svc.ServiceContext) http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
		var req types.RegisterRequest
		if err := httpx.Parse(r, &req); err != nil {
			//httpx.SetErrorHandler 仅在调用了 httpx.Error 处理响应时才有效。
			//所以我们现在还是使用原来的httpx.ErrorCtx
			httpx.ErrorCtx(r.Context(), w, err)
			return
		}

		l := register.NewRegisterLogic(r.Context(), svcCtx)
		resp, err := l.Register(&req)
		if err != nil {
			//httpx.SetErrorHandler 仅在调用了 httpx.Error 处理响应时才有效。
			//所以我们现在还是使用原来的httpx.ErrorCtx
			httpx.ErrorCtx(r.Context(), w, err)
		} else {
			//成功的请求,httpx.SetErrorHandler 是捕获不到的
			// 所以需要我们自定义返回信息
			httpx.OkJsonCtx(r.Context(), w, biz.Success(resp))
		}
	}
}

3.实现统一的错误响应机制

接下来,修改 internal/user/register/registerlogic.go文件:

go 复制代码
func (l *RegisterLogic) Register(req *types.RegisterRequest) (resp *types.RegisterResponse, err error) {
	// todo: add your logic here and delete this line
	/*
	...
	*/
	if user != nil {
		
		//return nil, errors.New(1, "用户已注册")
		return nil, biz.AlreadyRegister
	}
	//插入新的数据
	/*
	...
	*/
	if err != nil {
		//return nil, errors.New(2, "用户注册失败")
		return nil, biz.InsertErr
	}

}

接着运行测试

相关推荐
源码哥_博纳软云5 分钟前
JAVA同城服务场馆门店预约系统支持H5小程序APP源码
java·开发语言·微信小程序·小程序·微信公众平台
学会沉淀。13 分钟前
Docker学习
java·开发语言·学习
西猫雷婶43 分钟前
python学opencv|读取图像(二十一)使用cv2.circle()绘制圆形进阶
开发语言·python·opencv
kiiila44 分钟前
【Qt】对象树(生命周期管理)和字符集(cout打印乱码问题)
开发语言·qt
小_太_阳1 小时前
Scala_【2】变量和数据类型
开发语言·后端·scala·intellij-idea
直裾1 小时前
scala借阅图书保存记录(三)
开发语言·后端·scala
唐 城2 小时前
curl 放弃对 Hyper Rust HTTP 后端的支持
开发语言·http·rust
码银3 小时前
【python】银行客户流失预测预处理部分,独热编码·标签编码·数据离散化处理·数据筛选·数据分割
开发语言·python
从善若水3 小时前
【2024】Merry Christmas!一起用Rust绘制一颗圣诞树吧
开发语言·后端·rust
2401_858286114 小时前
115.【C语言】数据结构之排序(希尔排序)
c语言·开发语言·数据结构·算法·排序算法