河北沧州做网站的电话,湛江专业的建站软件,买外链网站,加盟代理网二、异常日志 #xff08;一#xff09;、错误码
错误码的制定原则#xff1a;快速溯源、沟通标准化错误码不体现版本号和错误等级信息全部正常#xff0c;但不得不填充错误码时返回五个零#xff1a;00000错误码为字符串类型#xff0c;共 5 位#xff0c;分成两个部分…二、异常日志 一、错误码
错误码的制定原则快速溯源、沟通标准化错误码不体现版本号和错误等级信息全部正常但不得不填充错误码时返回五个零00000错误码为字符串类型共 5 位分成两个部分错误产生来源四位数字编号编号不与公司业务架构更不与组织架构挂钩以先到先得的原则在统一平台上进行审批生效编号即被永久固定错误码使用者避免随意定义新的错误码错误码不能直接输出给用户作为提示信息使用错误码之外的业务信息由 error_message 来承载而不是让错误码本身涵盖过多具体业务属性在获取第三方服务错误码时向上抛出允许本系统转义由 C 转为 B并且在错误信息上带上原有的第三方错误码错误码分为一级宏观错误码、二级宏观错误码、三级宏观错误码错误码的后三位编号与 HTTP 状态码没有任何关系错误码有利于不同文化背景的开发者进行交流与代码协作错误码即人性感性认知口口相传使用纯数字来进行错误码编排不利于感性记忆和分类 二、异常处理Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过 catch 的方式来处理比如NullPointerExceptionIndexOutOfBoundsException 等等异常捕获后不要用来做流程控制条件控制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 级别的日志输出必须进行日志级别的开关判断避免重复打印日志浪费磁盘空间务必在日志配置文件中设置 additivityfalse生产环境禁止使用 System.out 或 System.err 输出或使用 e.printStackTrace() 打印异常堆栈异常信息应该包括两类信息案发现场信息和异常堆栈信息。如果不处理那么通过关键字throws 往上抛出日志打印时禁止直接用 JSON 工具将对象转换成 String谨慎地记录日志。生产环境禁止输出 debug 日志有选择地输出 info 日志如果使用 warn来记录刚上线时的业务行为信息一定要注意日志输出量的问题避免把服务器磁盘撑爆并记得及时删除这些观察日志可以使用 warn 日志级别来记录用户输入参数错误的情况避免用户投诉时无所适从。如非必要请不要在此场景打出 error 级别避免频繁报警尽量用英文来描述日志错误信息如果日志中的错误信息用英文描述不清楚的话使用中文描述即可否则容易产生歧义为了保护用户隐私日志文件中的用户敏感信息需要进行脱敏处理
