引言

本篇文章主要探讨关于统一错误码的设计,并提供笔者的实现

欢迎大家讨论,指正。

该错误码的设计在仓库:

github:github.com/valarchie/A…

gitee:gitee.com/valarchie/A…

统一的错误码管理的优点

  • 统一的错误码描述,如果没有统一的错误码的话,错误描述散落在项目内的不同地方,同一个错误码却产生不同的错误描述,会导致歧义。
  • 错误码的层级,在与客户端的交互过程中,我们可能需要根据错误的层级,来做不同的显示。例如系统内部的错误,我们产生红色的警告框。业务上操作类型的错误(例如用户名不能超过64位),我们 则以正常的黄色提示框来提醒用户。
  • i18n的处理。统一的错误码管理,才使得国际化更好实现。我们可以给每一种错误码定义唯一的key,来找到对应不同语言的错误描述。
  • 集中的错误码管理便于形成文档供调用者参考。例如我们提供接口给其他团队调用,可以提供给他们详细的错误码列表。

无错误码设计的缺陷

Ruoyi项目

  • 错误描述散落在项目的各个地方,一旦有改变错误描述的需求,要满项目去寻找关联的错误描述,然后逐一修改。这种情形很容易造成疏漏。
  • 如果需要翻译的话,这种随意的字符串形式也很难去做国际化翻译。
  • 没有准确的错误码,在一些情形下,调用方需要根据你返回的错误码进行不同的处理。如果没有准确的错误码,仅凭错误描述,比较难以实现。

错误码的层级

错误码的层级有助于客户端对于不同级别的错误进行处理。比如有的错误进行隐藏,有的错误直接暴露给用户。这边我规划了四层错误码。 错误码集合

  • 1~9999 为保留错误码 或者 常用错误码
  • 10000~19999 为内部错误码
  • 20000~29999 客户端错误码 (客户端异常调用之类的错误)
  • 30000~39999 为第三方错误码 (代码正常,但是第三方异常)
  • 40000~49999 为业务逻辑 错误码 (无异常,代码正常流转,并返回提示给用户)

错误码的模块

为了更好的分门别类,笔者给错误码设定了模块,便于客户端的特殊处理。例如客户端可以专门给某一个模块的错误进行一个统一的处理。 模块对应的数字在千位和百位。例如1XX01,XX代表了模块的意义。

/**
 * 系统内的模块
 */
public enum Module {
    /**
     * 普通模块
     */
    COMMON(0),
    /**
     * 权限模块
     */
    PERMISSION(1),
    /**
     * 登录模块
     */
    LOGIN(2),
    /**
     * 数据库模块
     */
    DB(3),
    /**
     * 上传
     */
    UPLOAD(4),
    /**
     * 用户
     */
    USER(5),
    /**
     * 配置
     */
    CONFIG(6),
    /**
     * 职位
     */
    POST(7),
    ;
    private final int code;
    Module(int code) { this.code = code * 100; }
    public int code() {return code; }
}

错误码代码例子

/**
     * 10000~19999是内部错误码  例如 框架有问题之类的
     */
    public enum Internal implements ErrorCodeInterface {
        /**
         * 内部错误码
         */
        INVALID_PARAMETER(Module.COMMON, 1, "参数异常"),
        UNKNOWN_ERROR(Module.COMMON, 2, "未知异常, 请查看系统日志"),
        GET_ENUM_FAILED(Module.COMMON, 3, "获取枚举类型失败, 枚举类: {}"),
        GET_CACHE_FAILED(Module.COMMON, 4, "获取缓存失败"),
        LOGIN_CAPTCHA_GENERATE_FAIL(Module.LOGIN, 1, "验证码生成失败"),
        INVALID_TOKEN(Module.PERMISSION, 1, "token异常"),
        DB_INTERNAL_ERROR(Module.DB, 1, "数据库异常: {}"),
        ;
        private final int code;
        private final String msg;
        private static final int BASE_CODE = 10000;
        Internal(Module module, int code, String msg) {
            this.code = BASE_CODE   module.code()   code;
            this.msg = msg;
        }
        @Override
        public int code() {
            return this.code;
        }
        @Override
        public String message() {
            return this.msg;
        }
    }

错误码的使用

为了便于错误码在编写代码时方便使用,我创建了ErrorCode这个类,并将四个层级的错误类一并放进这个类当中。

代码中的例子

 if (roleService.checkRoleNameUnique(getRoleId(), getRoleName())) {
            throw new ApiException(ErrorCode.Business.ROLE_NAME_IS_NOT_UNIQUE, getRoleName());
 }

通过这样的形式进行调用:ErrorCode.Business.ROLE_NAME_IS_NOT_UNIQUE

该错误码的设计缺陷

缺陷在于:

  • 一个模块内的错误码上线是100个。 解决该问题的话,有两种形式。一是:尽量设计比较通用的错误码,粒度过细会导致错误码不够用。二是:使用重复的模块,比如原来User模块,再起一个User2模块。

探讨关于错误码的设计,欢迎小伙伴留言评论指正。

Any corrections or suggestions are appreciated.

Agileboot是一个致力于规范、质量,健壮的前后端开发脚手架。

以上就是AgileBoot 项目内统一的错误码设计分析的详细内容,更多关于AgileBoot 项目内统一错误码的资料请关注Devmax其它相关文章!

AgileBoot 项目内统一的错误码设计分析的更多相关文章

  1. 一文学会处理SpringBoot统一返回格式

    这篇文章主要介绍了一文学会处理SpringBoot统一返回格式,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下

  2. SpringBoot统一功能处理的方式详解

    这篇文章主要为大家详细介绍了SpringBoot统一功能处理的方式,文中的示例代码讲解详细,对我们学习或工作有一定借鉴价值,需要的可以参考一下

  3. Laravel手动返回错误码示例

    今天小编就为大家分享一篇Laravel手动返回错误码示例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧

  4. 详解如何在SpringBoot项目中使用统一返回结果

    在一个完整的项目中,如果每一个控制器的方法都返回不同的结果,那么对项目的维护和扩展都会很麻烦。因此,本文为大家准备了SpringBoot项目中使用统一返回结果的方法,需要的可以参考一下

  5. springboot 全局异常处理和统一响应对象的处理方式

    这篇文章主要介绍了springboot 全局异常处理和统一响应对象,主要包括SpringBoot 默认的异常处理机制和SpringBoot 全局异常处理,本文给大家介绍的非常详细,需要的朋友可以参考下

  6. AgileBoot 项目内统一的错误码设计分析

    这篇文章主要为大家介绍了AgileBoot 项目内统一的错误码设计分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  7. SpringBoot统一返回格式的方法详解

    今天小编主要是和大家分享一个让代码变得更简洁的小技巧:统一返回格式,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

  8. PHP+MYSQL的文章管理系统(一)

    index.php显示manager.php添加,管理文章。change.php对已存在文章的操作。edit_article.php文章修改commend.php推荐文章给朋友。ping.php发表文章评论。search.php文章搜索type_manager.php类型管理login.php管理员登陆。$host="localhost";#数据库主机$database_usn="cfeng.net";##数据库用户$database_pwd="cfeng.net";##数据库密码$database="c

  9. PHP.MVC的模板标签系统(一)

    PHP.MVC版本beta0.4.0以上ActionDispatcher类用来负责使FormBean,Errors,Value和ViewResourcesConfig对象在我们的VIEW(模板)中可以使用.在检查模板标签系统之前我们应该快速的看一下ActionObjects和ViewResourcesConfig类,当在使用标准的ActionDispatcher时.ActionDispatcher也能暴露ViewResourcesConfig对象到我们的模板页面中.ViewResourcesConfig对

  10. 一个简单的自动发送邮件系统(一)

    一个简单的自动发送邮件系统php的另一个强大的特征就是他有能通过html的表单修改变量的能力,通过这些变量,我们可以实现很多任务,包括象:发送wed-based的邮件,把信息输出给屏幕,从数据库中读取和传递数据。下面让我们构建一个小型的自动发送邮件系统,来演示这个能力。为了减少用手工发送标准email的负担,我们可以使用php的mail()命令。这样的数据库有很多种,其中最快之一的就是mysql。

随机推荐

  1. 基于EJB技术的商务预订系统的开发

    用EJB结构开发的应用程序是可伸缩的、事务型的、多用户安全的。总的来说,EJB是一个组件事务监控的标准服务器端的组件模型。基于EJB技术的系统结构模型EJB结构是一个服务端组件结构,是一个层次性结构,其结构模型如图1所示。图2:商务预订系统的构架EntityBean是为了现实世界的对象建造的模型,这些对象通常是数据库的一些持久记录。

  2. Java利用POI实现导入导出Excel表格

    这篇文章主要为大家详细介绍了Java利用POI实现导入导出Excel表格,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

  3. Mybatis分页插件PageHelper手写实现示例

    这篇文章主要为大家介绍了Mybatis分页插件PageHelper手写实现示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  4. (jsp/html)网页上嵌入播放器(常用播放器代码整理)

    网页上嵌入播放器,只要在HTML上添加以上代码就OK了,下面整理了一些常用的播放器代码,总有一款适合你,感兴趣的朋友可以参考下哈,希望对你有所帮助

  5. Java 阻塞队列BlockingQueue详解

    本文详细介绍了BlockingQueue家庭中的所有成员,包括他们各自的功能以及常见使用场景,通过实例代码介绍了Java 阻塞队列BlockingQueue的相关知识,需要的朋友可以参考下

  6. Java异常Exception详细讲解

    异常就是不正常,比如当我们身体出现了异常我们会根据身体情况选择喝开水、吃药、看病、等 异常处理方法。 java异常处理机制是我们java语言使用异常处理机制为程序提供了错误处理的能力,程序出现的错误,程序可以安全的退出,以保证程序正常的运行等

  7. Java Bean 作用域及它的几种类型介绍

    这篇文章主要介绍了Java Bean作用域及它的几种类型介绍,Spring框架作为一个管理Bean的IoC容器,那么Bean自然是Spring中的重要资源了,那Bean的作用域又是什么,接下来我们一起进入文章详细学习吧

  8. 面试突击之跨域问题的解决方案详解

    跨域问题本质是浏览器的一种保护机制,它的初衷是为了保证用户的安全,防止恶意网站窃取数据。那怎么解决这个问题呢?接下来我们一起来看

  9. Mybatis-Plus接口BaseMapper与Services使用详解

    这篇文章主要为大家介绍了Mybatis-Plus接口BaseMapper与Services使用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  10. mybatis-plus雪花算法增强idworker的实现

    今天聊聊在mybatis-plus中引入分布式ID生成框架idworker,进一步增强实现生成分布式唯一ID,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

返回
顶部