二、异常日志

二、异常日志
（一）、错误码

• 错误码的制定原则：快速溯源、沟通标准化
• 错误码不体现版本号和错误等级信息
• 全部正常，但不得不填充错误码时返回五个零：00000
• 错误码为字符串类型，共 5 位，分成两个部分：错误产生来源+四位数字编号
• 编号不与公司业务架构，更不与组织架构挂钩，以先到先得的原则在统一平台上进行，审批生效，编号即被永久固定
• 错误码使用者避免随意定义新的错误码
• 错误码不能直接输出给用户作为提示信息使用
• 错误码之外的业务信息由 error_message 来承载，而不是让错误码本身涵盖过多具体业务属性
• 在获取第三方服务错误码时，向上抛出允许本系统转义，由 C 转为 B，并且在错误信息上带上原有的第三方错误码
• 错误码分为一级宏观错误码、二级宏观错误码、三级宏观错误码
• 错误码的后三位编号与 HTTP 状态码没有任何关系
• 错误码有利于不同文化背景的开发者进行交流与代码协作
• 错误码即人性，感性认知+口口相传，使用纯数字来进行错误码编排不利于感性记忆和分类
  （二）、异常处理
• Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过 catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException 等等
• 异常捕获后不要用来做流程控制，条件控制
• catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理
• 捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容
• 事务场景中，抛出异常被 catch 后，如果需要回滚，一定要注意手动回滚事务
• finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch
• 不要在 finally 块中使用 return
• 捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类
• 在调用 RPC、二方包、或动态生成类的相关方法时，捕捉异常使用 Throwable 类进行拦截
• 方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值
• 注意 NPE 产生的场景：
  • 返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE
  • 数据库的查询结果可能为 null
  • 集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null
  • 远程调用返回对象时，一律要求进行空指针判断，防止 NPE
  • 对于 Session 中获取的数据，建议进行 NPE 检查，避免空指针
  • 级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE
• 定义时区分 unchecked / checked 异常，避免直接抛出 new RuntimeException()，更不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException 等
• 对于公司外的 http / api 开放接口必须使用错误码，而应用内部推荐异常抛出；跨应用间RPC 调用优先考虑使用 Result 方式，封装 isSuccess() 方法、错误码、错误简短信息；应用内部推荐异常抛出
  （三）、日志规约
• 应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架（SLF4J、JCL—Jakarta Commons Logging）中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一
• 日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。对于当天日志，以“应用名.log”来保存，保存在/{统一目录}/{应用名}/logs/目录下，过往日志格式为：{logname}.log.{保存日期}，日期格式：yyyy-MM-dd
• 根据国家法律，网络运行状态、网络安全事件、个人敏感信息操作等相关记录，留存的日志不少于六个月，并且进行网络多机备份
• 应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log。logType：日志类型，如 stats / monitor / access 等；logName：日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找
• 在日志输出时，字符串变量之间的拼接使用占位符的方式
• 对于 trace / debug / info 级别的日志输出，必须进行日志级别的开关判断
• 避免重复打印日志，浪费磁盘空间，务必在日志配置文件中设置 additivity=false
• 生产环境禁止使用 System.out 或 System.err 输出或使用 e.printStackTrace() 打印异常堆栈
• 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws 往上抛出
• 日志打印时禁止直接用 JSON 工具将对象转换成 String
• 谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志
• 可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警
• 尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义
• 为了保护用户隐私，日志文件中的用户敏感信息需要进行脱敏处理