GoFrame 优化接口的错误码和异常的思路
前言
你是否想在使用 GoFrame 的过程中,拥有一个能打印异常堆栈,能自定义响应状态码,能统一处理响应数据的接口。如果你回答是,那么,请耐心看完本文,或许会对你有所启发。若文中由表达不当之处,恳请不吝赐教。
异常都需要错误堆栈吗
为什么会问这个问题呢,所有的接口错误都会向日志中抛出堆栈信息,这不是好事吗?答案是否定的。
业务开发中,通常有业务异常和系统异常两种 err
,我这里暂且这么称呼,也有的称为业务异常为"错误",系统异常为"异常"。业务异常是由用户输入不当引起的,比如说账号密码错误,这种 err
通常只返回给用户即可,不需要打印堆栈信息。而系统异常是由系统内部自发引起的,比如说 SQL
语句不当,这种错误需要打印堆栈信息,且不能把 err
返回到用户那里,不然会暴露代码结构,严重的可能会暴露数据库结构。
在 GoFrame
中,因为有着强大的 gerror
组件,所以只要接收了任何组件方法中的 err
,不论业务异常和系统异常,都会打印堆栈信息,这与我们的设计目标不符合,需要解决它。
状态码
此处的状态码区别与 HTTP 状态码,它是我们自定义的一套业务码,比如这样:
{
"code": 10001,
"message": "用户名密码错误",
"data": null
}
{
"code": 10002,
"message": "用户不存在",
"data": null
}
它们的 HTTP 状态码都是 200,代表响应成功,但是业务状态码不同,用以区分不同的业务异常。
一个例子
我们来编写一个完整的示例:
接口文件:/api/exception/v1/exception.go:
// 模拟业务异常
type BusinessReq struct {
g.Meta `path:"/business" method:"get"`
}
type BusinessRes struct {
Name string
Age int
}
// 模拟系统异常
type SystemReq struct {
g.Meta `path:"/system" method:"get"`
}
type SystemRes struct {
Name string
Age int
}
控制器文件:/internal/controller/exception/exception_v1_*.go:
func (c *ControllerV1) Business(ctx context.Context, req *v1.BusinessReq) (res *v1.BusinessRes, err error) {
err = service.Exception().Business()
if err != nil {
return nil, err
}
return &v1.BusinessRes{
Name: "business",
Age: 1,
}, nil
}
func (c *ControllerV1) System(ctx context.Context, req *v1.SystemReq) (res *v1.SystemRes, err error) {
err = service.Exception().System()
if err != nil {
return nil, err
}
return &v1.SystemRes{
Name: "system",
Age: 1,
}, nil
}
服务文件:/internal/logic/exception/exception.go:
func (s *sException) Business() error {
return gerror.New("用户名密码错误")
}
// System 这里我们对 gjson.Decode() 传入错误数据,用来模拟组件内部抛出err
func (s *sException) System() error {
_, err := gjson.Decode("")
if err != nil {
return err
}
return nil
}
这个例子模拟了一个完整的接口,从 api
到 controller
到 logic
,然后我们请求它们,分别从响应信息和控制台两个角度看看它们的结果。
业务异常 Business
curl http://127.0.0.1:8000/business
控制台:
接口响应:
{
"code": 50,
"message": "用户名密码错误",
"data": null
}
系统异常 System
curl http://127.0.0.1:8000/system
控制台:
接口响应:
{
"code": 50,
"message": "json Decode failed: EOF",
"data": null
}
优化方案
此时,我们的接口中有三个不足:
- 业务异常不应该抛出堆栈,因为用户名或密码错误的堆栈没有意义;
- 系统异常的响应信息中,
message
不应该抛出 "json Decode failed: EOF",应该使用未知错误
或者系统错误
这类字眼; - 业务异常和系统异常的业务码,也就是响应信息中的
code
,不应该都使用 50,应当做以区分。
设计统一 err
在 GoFrame 的工程目录中,有一个包 /internal/packed
,我们可以在此处编写我们自己的 err
处理,后面的代码可以做为参考,也可以直接复制过去用:
/internal/packed/err.go:
type pErr struct {
maps map[int]string
}
var Err = &pErr{
maps: map[int]string{
0: "请求成功",
10001: "用户名或密码错误",
10002: "用户不存在",
99999: "未知错误",
},
}
// GetMsg 获取code码对应的msg
func (c *pErr) GetMsg(code int) string {
return c.maps[code]
}
// Skip 抛出一个业务级别的错误,不会打印错误堆栈信息
func (c *pErr) Skip(code int, msg ...string) (err error) {
var msgStr string
if len(msg) == 0 {
msgStr = c.GetMsg(code)
} else {
msg = append([]string{c.GetMsg(code)}, msg...)
msgStr = strings.Join(msg, ", ")
}
// NewWithOption 在低版本的 gf 上不存在,请改用 NewOption
return gerror.NewWithOption(gerror.Option{
Stack: false,
Text: msgStr,
Code: gcode.New(code, "", nil),
})
}
// Sys 抛出一个系统级别的错误,使用code码:99999,会打印错误堆栈信息
// msg 接受string和error类型
// !!! 使用该方法传入error类型时,一定要注意不要泄露系统信息
func (c *pErr) Sys(msg ...interface{}) error {
var (
code = 99999
msgSlice = []string{
c.GetMsg(code),
}
)
if len(msg) != 0 {
for _, v := range msg {
switch a := v.(type) {
case error:
msgSlice = append(msgSlice, a.Error())
case string:
msgSlice = append(msgSlice, a)
}
}
}
msgStr := strings.Join(msgSlice, ", ")
return gerror.NewCode(gcode.New(code, "", nil), msgStr)
}
统一响应数据中间件
设计统一响应数据的中间件,并且注入到 HTTP 请求流程中:
/internal/logic/middleware/response.go
type sMiddleware struct {
}
func init() {
service.RegisterMiddleware(New())
}
func New() *sMiddleware {
return &sMiddleware{}
}
type Response struct {
Code int `json:"code" dc:"业务码"`
Message string `json:"message" dc:"业务码说明"`
Data interface{} `json:"data" dc:"返回的数据"`
}
func (s *sMiddleware) Response(r *ghttp.Request) {
r.Middleware.Next()
if r.Response.BufferLength() > 0 {
return
}
// 先过滤掉服务器内部错误
if r.Response.Status >= http.StatusInternalServerError {
// 清除掉缓存区,防止服务器信息泄露到客户端
r.Response.ClearBuffer()
r.Response.Writeln("服务器打盹了,请稍后再来找他!")
}
var (
res = r.GetHandlerResponse()
err = r.GetError()
code = gerror.Code(err)
msg string
)
if err != nil {
msg = err.Error()
} else {
code = gcode.CodeOK
msg = packed.Err.GetMsg(code.Code())
}
r.Response.WriteJson(Response{
Code: code.Code(),
Message: msg,
Data: res,
})
}
/internal/cmd/cmd.go
s.Group("/", func(group *ghttp.RouterGroup) {
group.Middleware(service.Middleware().Response)
group.Bind(
exception.NewV1(),
)
})
结果
然后在服务文件中调用 packed/err
/internal/logic/exception/exception.go:
func (s *sException) Business() error {
return packed.Err.Skip(10001)
}
// System 这里我们对 gjson.Decode() 传入错误数据,用来模拟组件内部抛出err
func (s *sException) System() error {
_, err := gjson.Decode("")
if err != nil {
return packed.Err.Sys("可选自定义信息")
}
return nil
}
结果展示:
Business
{
"code": 10001,
"message": "用户名或密码错误",
"data": null
}
System
{
"code": 99999,
"message": "未知错误, 可选自定义信息",
"data": null
}
用户名或密码错误的业务异常也不会再抛出堆栈异常了:
尾声
上述的代码例子已经开源在:Github
本博客源码使用的也是这种 err
设计,想要了解更多可以查看:Github/oldme-api
GoFrame 优化接口的错误码和异常的思路的更多相关文章
- ErrorCode枚举类型返回错误码信息测试,手动抛出异常信息,在事务中根据错误码来回滚事务的思路。
ErrorCode.java 简单测试代码,具体应用思路:手动抛出异常信息,在事务中根据错误码来回滚事务的思路. public enum ErrorCode { //系统级 SUCCESS(" ...
- Java异常封装(自己定义错误码和描述,附源码)
真正工作了才发现,Java里面的异常在真正工作中使用还是十分普遍的.什么时候该抛出什么异常,这个是必须知道的. 当然真正工作里面主动抛出的异常都是经过分装过的,自己可以定义错误码和异常描述. 下面小宝 ...
- Java异常封装(自定义错误码和描写叙述,附源代码)
真正工作了才发现.Java里面的异常在真正工作中使用还是十分普遍的. 什么时候该抛出什么异常,这个是必须知道的. 当然真正工作里面主动抛出的异常都是经过分装过的,自己能够定义错误码和异常描写叙述. 以 ...
- 写给初学者的Linux errno 错误码机制
不同于Java的异常处理机制, 当你使用C更多的接触到是基于错误码的异常机制, 简单来说就是当调用的函数发生异常时, 程序不会跳转到一个统一处理异常的地方, 取而代之的是返回一个整型错误码. 可能会有 ...
- 使用whistle模拟cgi接口异常:错误码、502、慢网速、超时
绝大多数程序只考虑了接口正常工作的场景,而用户在使用我们的产品时遇到的各类异常,全都丢在看似 ok 的 try catch 中.如果没有做好异常的兼容和兜底处理,会极大的影响用户体验,严重的还会带来安 ...
- Spring/SpringBoot定义统一异常错误码返回
配置 大致说下流程, 首先我们自定义一个自己的异常类CustomException,继承RuntimeException.再写一个异常管理类ExceptionManager,用来抛出自定义的异常. 然 ...
- [2017-08-28]Abp系列——业务异常与错误码设计及提示语的本地化
本系列目录:Abp介绍和经验分享-目录 前言 ABP中有个异常UserFriendlyException经常被使用,但是它所在的命名空间是Abp.UI,总觉得和展现层联系过于紧密,在AppServic ...
- JavaWeb项目中获取对Oracle操作时抛出的异常错误码
最近在项目中碰到了这么一个需求,一个JavaWeb项目,数据库用的是Oracle.业务上有一个对一张表的操作功能,当时设置了两个字段联合的唯一约束.由于前断没有对重复字段的校验,需要在插入时如果碰到唯 ...
- .NET中异常与错误码优劣势对比
.NET之所以选择异常,而不是返回错误码来报告异常,是由于前者有以下几个优势: 1.异常与oop语言的结合性更好.oop语言经常需要对成员签名强加限制,比如c#中的构造函数.操作符重载和属性,开发者对 ...
- Redis Windows 服务启动异常 错误码1067
https://blog.csdn.net/after_you/article/details/62215163 Redis Windows 服务启动异常 错误码1067 下载了Redis 2.8.2 ...
随机推荐
- Flask 实现文件上传下载
Flask 针对文件的上传下载相关代码片段,多种方法,包括限制文件格式,大小等. 实现图片文件上传 # name: 简单的实现文件上传任务. import os from flask import F ...
- 基于.NET+FreeSql实现的仿掘金专栏前后端分离的CMS
前言 今天分享一款基于.NET+FreeSql实现的仿掘金专栏前后端分离.支持Docker部署.集成了OAtuh2授权登录.QQ.Github.Gitee快速登录.简单实用的CMS:lin-cms-d ...
- docker安装oracle数据
docker安装oracle数据库 1️⃣ 通过docker拉取并启动oracle11g(此版本目前主流),docker换源及安装mysql看Springboot创建项目及测试 - $YX$ - 博客 ...
- (C语言)每日代码||2023.12.25||strcpy()函数两个参数中的'\0'
#include <stdio.h> #include <string.h> #define MAX 500 void test() { char arr1[] = { '1' ...
- 【题解】P5461 赦免战俘
一.题目 现有 \(2^n\times2^n\ (n≤10)\) 名作弊者站成一个正方形方阵等候 kkksc03 的发落.kkksc03 决定赦免一些作弊者.他将正方形矩阵均分为 4 个更小的正方形矩 ...
- 听说有 Hugging Face 陪伴的春节,是这样的…
辞旧迎新春节到,家家户户好热闹.Hugging Face 中国团队成员祝各位社区成员们新春快乐,万事如意! 过去的一年我们持续看到 AI 技术的腾飞和发展,以及诸多机构为开源 AI 作出巨大的贡献.非 ...
- 开源.NetCore通用工具库Xmtool使用连载 - 发送短信篇
[Github源码] <上一篇> 介绍了Xmtool工具库中的发送邮件类库,今天我们继续为大家介绍其中的发送短信类库. 发送短信就像发送邮件一样,在软件系统中使用非常普遍,甚至比发送邮件还 ...
- thinkphp集成editormd一系列实战
介绍 最近php搞了个博客,需要集成markdown编辑器(富文本的太low了,效率也低),用的是时下比较火的editormd,除了基本的文档编辑我这里还实现了几个自己的需求: 使用ctrl-v实现将 ...
- SpringCloud Config配置中心实战
介绍 本文以理论结合实践编写,篇幅较长,各位看官保持耐心:),部分内容引用自网络. 什么是配置中心? 当微服务过多的时候,每个微服务的配置很难集中管理.SpringCloud Config通过git代 ...
- Mac技巧之苹果电脑上将一个软件进程的 CPU 占用率限制在指定范围内:cputhrottle
苹果电脑 Mac OS X 系统上,我们可以用 cputhrottle 这个免费工具,配合活动监视器和终端,把一个软件进程的 CPU 占用率限制在指定值(比如 20%)以内,以防止应为它 " ...