SpringBoot定义优雅全局统一Restful API 响应框架四

如果没有看前面几篇文章请先看前面几篇

目前我们好像似乎解决所有问题，达到了我们理想的效果如下

但是在业务错误返回时候不太理想如下

没有必要返回 reuqest和errorMsg

还有如果业务非常复杂的时候，会不会出现错误码分配使用混乱和重复问题这个问题应该如何避免和解决呢?

这个时候我想到使用业务错误常量来代替错误码，这样更加见字识意，进一步抽象错误常量公共接口模块

1package cn.soboys.springbootrestfulapi.common.error;
2
3import java.util.List;
4
5/**
6 * @author 公众号 程序员三时
7 * @version 1.0
8 * @date 2023/5/9 20:14
9 * @webSite https://github.com/coder-amiao
10 * 定义错误常量 代替错误码,避免业务复杂错误码分配重复等问题
11 */
12public interface CommonErrorConstant {
13    /**
14     * 公共错误码定义
15     */
16    public static final String InvalidRequest = "InvalidRequest";
17    public static final String InvalidArgument = "InvalidArgument";
18    public static final String NotFound = "NotFound";
19    public static final String UnknownError = "UnknownError";
20    public static final String OK = "OK";
21    public static final String FAIL = "FAIL";
22
23
24
25    /**
26     * 其他自定义业务错误码
27     */
28
29
30
31}
32

通用错误码

1package cn.soboys.springbootrestfulapi.common.error;
2
3import cn.soboys.springbootrestfulapi.common.resp.ResultCode;
4
5/**
6 * @author 公众号 程序员三时
7 * @version 1.0
8 * @date 2023/5/2 21:36
9 * @webSite https://github.com/coder-amiao
10 */
11public enum CommonErrorCode implements ResultCode {
12
13    /**
14     * 错误请求
15     */
16    INVALID_REQUEST(false, CommonErrorConstant.InvalidRequest, "Invalid request, for reason: "),
17    /**
18     * 参数验证错误
19     */
20    INVALID_ARGUMENT(false, CommonErrorConstant.InvalidArgument, "Validation failed for argument "),
21    /**
22     * 未找到资源
23     */
24    NOT_FOUND(false, CommonErrorConstant.NotFound, "Resource  not found."),
25    /**
26     * 未知错误
27     */
28    UNKNOWN_ERROR(false, CommonErrorConstant.UnknownError, "Unknown server internal error.");
29
30
31    CommonErrorCode(Boolean success, String code, String message) {
32        this.success = success;
33        this.code = code;
34        this.message = message;
35
36    }
37
38    /**
39     * 响应是否成功
40     */
41    private Boolean success;
42    /**
43     * 响应状态码
44     */
45    private String code;
46    /**
47     * 响应信息
48     */
49    private String message;
50
51
52    @Override
53    public String getCode() {
54        return code;
55    }
56
57    @Override
58    public String getMessage() {
59        return message;
60    }
61
62    @Override
63    public boolean getSuccess() {
64        return success;
65    }
66
67
68}
69

正常请求

错误请求

调整后的业务异常
调整未知错误异常

对应代码已经上传更新github

在留一下一个思考问题，如果接口错误需要国际化应该如何实现？

如果你觉得对您有帮助关注公众号，程序员三时 我会给大家不定期分享热门技术，做开源项目，技术交流，面试，学习，分享自己入行多年一些感受和经验

SpringBoot定义优雅全局统一Restful API 响应框架四

评论区

相关推荐