JAVA轻量级错误码设计最佳实践

概述

目前公司团队项目中返回异常都没有错误码，如果遇到错误提示只会返回一个错误信息。随着微服务组件越来越多，这样给不同团队之间沟通交流、排查错误带来了极大的困难。于是在网上搜索了一番以后，决心要重新设计下错误码机制.

设计目标

先谈公司现状，我们目前就是通过抛出Java异常，将异常信息Message返回给其他服务或者前端，这样有什么问题？

1. 不好交流沟通，本来只要通过一个明确的错误码就能沟通清楚，用异常信息会带来模糊性。
2. 只有异常消息，很难定位具体是哪个服务的原因，具体原因是什么，因为异常消息比较灵活，可能是不同服务、同服务不同模块都有相似的。

因此，我们需要设计一套错误码机制，那一个优秀的错误码设计应该达到什么目标或者有什么原则呢？

我们可以参考下阿里巴巴《Java 开发手册》- 异常日志-错误码的内容。

错误码的制定原则：快速溯源、简单易记、沟通标准化。

说明：错误码想得过于完美和复杂，就像康熙字典中的生僻字一样，用词似乎精准，但是字典不容易随身携带并且简单易懂。

正例：错误码回答的问题是谁的错？错在哪？

1）错误码必须能够快速知晓错误来源，可快速判断是谁的问题。

2）错误码易于记忆和比对（代码中容易 equals）。

3）错误码能够脱离文档和系统平台达到线下轻量化地自由沟通的目的。

错误码设计

错误码设计，主要考虑下面几个点：

1. 错误码的格式该是什么样？
2. 错误码在java中该如何表示，枚举，常量？
3. 错误码怎么保证唯一性，开发可能不知道已经被占用了，该如何避免？
4. 错误码该如何返回?

错误码格式

错误码格式一方面要求精简，同时也要体现出它的服务组件和模块信息。

错误码的数据类型可以是字符串，比如"SDM_USER_001", 也可以用数值表示10203等，他们可以利弊，用字符串可能比较直观，用数字比较精简,但是使用纯数字来进行错误码编排不利于感性记忆和分类。

我们本例采用了6位数字的方式演示，前面两位是项目编码，中间两位是模块编码，最后3位是错编码：

错误码在项目中表示

错误码在项目中该如何呈现呢？

1. 错误码统一通过枚举类表现，可以轻松的表示枚举的代码和对应的含义，易于维护。
2. 按照项目+模块粒度定义成多个错误码枚举类，也就是一个模块一个错误码的枚举类。
3. 定义出公共的错误码的接口，让各个服务组件、模块实现，统一错误码的参数。
4. 分离出项目模块编码，增加模块编码枚举的复用性。

模块接口代码如下：

public interface ProjectModule {

    /**
     * 项目编码
     */
    int getProjectCode();

    /**
     * 模块编码
     */
    int getModuleCode();

    /**
     * 项目名称
     */
    String getProjectName();

    /**
     * 模块名称
     */
    String getModuleName();
}

 具体的模块：

@Getter
@AllArgsConstructor
public enum UserProjectCodes implements ProjectModule {
    /**
     * 登录模块
     */
    LOGIN(1, 1, "用户中心", "登录模块"),
    /**
     * 用户管理模块
     */
    USER(1, 2, "用户中心", "用户模块");

    private int projectCode;
    private int moduleCode;
    private String projectName;
    private String moduleName;

}

错误码接口代码如下：

public interface ErrorCode {

    /**
     * 最细粒度code,不包含project、module信息
     */
    int getNodeN