系统异常日志处理的思考

一、问题及解决思路

1.错误码问题

后端在编写代码，遇到异常处理时，常常纠结于错误码code的设置以及错误信息msg的处理。
尤其在多人协作时常常遗忘之前定义的错误码、错误信息，从而导致重复定义错误码。
因此错误码规则的合理设置，尤其重要。
参考《阿里巴巴编码规约泰山版》以下简称《阿里规约》
**强制 **错误码的制定原则：快速溯源、简单易记、沟通标准化。

说明： 错误码想得过于完美和复杂，就像康熙字典中的生僻字一样，用词似乎精准，但是字典不容易随身 携带并且简单易懂。
正例：错误码回答的问题是谁的错？错在哪？
1）错误码必须能够快速知晓错误来源，可快速判断是谁的问 题。
2）错误码易于记忆和比对（代码中容易 equals）。
3）错误码能够脱离文档和系统平台达到线下轻量 化地自由沟通的目的。

---

2.错误信息及前端提示问题

通常我们定义的错误信息不应直接返回至前端展示。例如：用户ID不存在或未传入正确token。此类信息应适合后端开发定位排查问题，而不应直接返回给用户。
而且，错误码通常与错误信息一一对应，例如，(40001，“资源不存在”)。
此时我们输出特定资源提示时，非常不灵活。例如，“用户不存在”,“商品不存在”，其本质都是"资源不存在"。
如果增加错误码，个人觉得显得冗余，而且极容易重复定义错误码。
但，若只记录"资源不存在"，对于问题的定位、追溯将会有一定的困难。
在阅读《阿里规约》-异常日志章节时，看到“ **堆栈（stack_trace）、错误信息(error_message)、错误码（error_code）、提示信息（user_tip） 是一个有效关联并互相转义的和谐整体，但是请勿互相越俎代庖。 **”
因此感觉到仅用错误码 + 错误信息来处理异常，确实无法不够使用，无法自由定义给用户反馈的提示。

因此，将堆栈信息、错误信息、错误码、提示信息、区分开来，会更加清晰，明白。

二、服务异常处理实践

1. 错误码定义规范

错误码为字符串类型，共 5 位，分成两个部分：错误产生来源+四位数字编号。
说明：错误产生来源分为 A/B/C，
A 表示错误来源于用户，比如参数错误，用户安装版本过低，用户支付 超时等问题；
B 表示错误来源于当前系统，往往是业务逻辑出错，或程序健壮性差等问题；
C 表示错误来源 于第三方服务，比如 CDN 服务出错，消息投递超时等问题；
四位数字编号从 0001 到 9999，大类之间的 步长间距预留 100，错误码列表：参考见附件《阿里规约》。

示例：

错误码	中文描述	说明
00000	一切OK	正确执行的返回
A0001	用户端错误	一级宏观错误
A0100	用户注册错误	二级宏观错误码
A0101	用户未同意隐私协议
B0001	系统执行出错	一级宏观错误码
B0100	系统执行超时	二级宏观错误码
B0101	系统订单处理超时
C0001	调用第三方服务出错	一级宏观错误码
C0100	中间件服务出错	二级宏观错误码

public enum CodeEnum {
    RESOURCE_CODE("B0001","资源不存在");
    
    ···getter...
    ...setter...
}

2. Resultful响应定义

public class ResultResponse{
    private String code;
    private String msg;
    private Object data;
    
    ...construct method...
    ...getter...
    ...setter...
        
    public static ResultResponse custom(String code,String tip,Object data){
        return new ResultResponse(code,tip,data);
    }
}

3. 自定义异常

public class CustomException extends RuntimeException{
    //错误码
    private String code; 
    //错误信息
    private String msg;
    //用户提示信息
    private String tip;
    
    public CustomException(String code,String msg,String tip){
        super(msg);
        this.code = code;
        this.msg = msg;
        this.tip = tip;
    }
}

4. 异常统一处理

@RestControllerAdvice
public class CustomExceptionHandler {

    @ExceptionHandler(value = CustomException.class)
    public HttpResponse<String> handleCustomException(CustomException e) {
        //将tip 返回给前端
        return ResultResponse.custom(e.getCode(), e.getTip(),null);
    }
}

5. 异常示例

public void checkParam(String id){
    User user = userService.getById(id);
    if(null == user){
        //tip可与msg相同,也可依据实际需求修改
        throw new CustomException(RESOURCE_CODE.getCode(),RESOURCE_CODE.getMsg(),"未查询到该用户");
    }
}

6. 用户响应示例

{
  "code":"B0001",
  "msg":"未查询到该用户",
  "data":null
}

附件：阿里巴巴编码规约泰山版下载

泰山版.pdf