技术标签: # 编程规范&代码管理 阿里巴巴代码规范
Java异常日志规约规定了异常日志的编写范式,如何抛出等详细内容。包括错误码、异常处理、日志规约。红色加粗字体为自己可能会犯的错误以及不规范的地方,蓝色结论部分为几条规则的归纳或一条规则的阐述。
1 【强制】错误码的制定原则:快速溯源、沟通标准化。
2 【强制】错误码不体现版本号和错误等级信息。
3 【强制】全部正常,但不得不填充错误码时返回五个零:00000。
4 【强制】错误码为字符串类型,共 5 位,分成两个部分:错误产生来源+四位数字编号。这里个人容易不符合规范
5 【强制】编号不与公司业务架构,更不与组织架构挂钩,以先到先得的原则在统一平台上进行,审批生效,编号即被永久固定。
6【强制】错误码使用者避免随意定义新的错误码。
7 【强制】错误码不能直接输出给用户作为提示信息使用。
这里可以和之前的前后端规约类比一下
服务端发生错误时,返回给前端的响应信息必须包含 HTTP 状态码,errorCode、errorMessage、用户提示信息四个部分。
说明:四个部分的涉众对象分别是浏览器、前端开发、错误排查人员、用户。其中输出给用户的提示信息要求:简短清晰、提示友好,引导用户进行下一步操作或解释错误原因,提示信息可以包括错误原因、上下文环境、推荐操作等。 errorCode:参考附表 3,大致错误方向。errorMessage:简要描述后端出错原因,便于错误排查人员快速定位问题,注意不要包含敏感数据信息
8【推荐】错误码之外的业务独特信息由 error_message 来承载,而不是让错误码本身涵盖过多具体业务属性
结论:在已知业务判断出错的位置,抛出自定义异常组合(打印出错误码,错误信息以及用户提示信息,返回给前端时因为异常会自动附加http状态码);在未知业务异常的时候,例如远程调用不知道错误是什么,就捕获异常,把堆栈信息用日志打印出来,同时向调用方返回结果,由调用方Service向外抛异常
看了下公司项目中代码,目前用法没有区分用户提示和error_message提示,错误码也是大写英文,没有统一规范编码,没有申请和管理机制
9 【推荐】在获取第三方服务错误码时,向上抛出允许本系统转义,由 C 转为 B,并且在错误信息上带上原有的第三方错误码。
10【参考】错误码分为一级宏观错误码、二级宏观错误码、三级宏观错误码。
11 【参考】错误码的后三位编号与 HTTP 状态码没有任何关系。
12【参考】错误码有利于不同文化背景的开发者进行交流与代码协作。
13 【参考】错误码即人性,感性认知+口口相传,使用纯数字来进行错误码编排不利于感性记忆和分类。
1 【强制】Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过catch 的方式来处理,比如:NullPointerException,IndexOutOfBoundsException
等等。
过 catch NumberFormatException
来实现。if (obj != null) {...}
try { obj.method(); } catch (NullPointerException e) {…}
2【强制】异常捕获后不要用来做流程控制,条件控制。
3【强制】catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型,再做对应的异常处理。
4 【强制】捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请将该异常抛给它的调用者。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容。
5【强制】事务场景中,抛出异常被 catch 后,如果需要回滚,一定要注意手动回滚事务
6【强制】finally 块必须对资源对象、流对象进行关闭,有异常也要做 try-catch。
7【强制】不要在 finally 块中使用 return。这里个人容易不符合规范
private int x = 0;
public int checkReturn() {
try {
// x 等于 1,此处不返回
return ++x;
} finally {
// 返回的结果是 2
return ++x;
}
}
8【强制】捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。
9 【强制】在调用 RPC、二方包、或动态生成类的相关方法时,捕捉异常必须使用 Throwable类来进行拦截。
NoSuchMethodException
。什么情况会抛出NoSuchMethodError
呢?二方包在类冲突时,仲裁机制可能导致引入非预期的版本使类的方法签名不匹配,或者在字节码修改框架(比如:ASM)动态创建或修改类时,修改了相应的方法签名。这些情况,即使代码编译期是正确的,但在代码运行期时,会抛出NoSuchMethodError
。10【推荐】方法的返回值可以为 null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回 null 值。这里个人容易不符合规范
11【推荐】防止 NPE,是程序员的基本修养,注意 NPE 产生的场景:
public int f() { return Integer 对象}
, 如果为 null,自动解箱抛 NPE。这里个人就犯过一次错误,序列化时用的是包装类型,结果为null,接收时用的是int,直接NPE了正例:使用 JDK8 的 Optional 类来防止 NPE 问题
12 【推荐】定义时区分 unchecked / checked
异常,避免直接抛出 new RuntimeException()
,更不允许抛出 Exception 或者 Throwable,应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常,如:DAOException / ServiceException
等。这里个人容易不符合规范
13 【参考】对于公司外的 http/api 开放接口必须使用 errorCode;而应用内部推荐异常抛出;跨应用间 RPC 调用优先考虑使用 Result 方式,封装 isSuccess()方法、errorCode、errorMessage;而应用内部直接抛出异常即可。关于 RPC 方法返回方式使用 Result 方式的理由:
error message
,对于调用端解决问题的帮助不会太多。如果加了栈信息,在频繁调用出错的情况下,数据序列化和传输的性能损耗也是问题。结论:对于RPC的第三方调用来说最好还是用info的形式记录调用参数和返回结果,如果不确定第三方是否会抛异常,最好加try catch捕获并打印日志,并将返回结果返回给上层,也就是RPC调用不抛出异常,异常统一由Service抛出,展望下异常分层规约:可以按照以下几条原则去处理分层的异常,
综合而言就是DAO粒度太细就不记录了,Service层因为带有业务含义需要记录日志来排查问题,Web层则应该对错误给出自己的应对机制了。
1 【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架(SLF4J、JCL–Jakarta Commons Logging)中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。
使用 SLF4J:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Test.class);
使用 JCL:
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
private static final Log log = LogFactory.getLog(Test.class);
2 【强制】所有日志文件至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。对于当天日志,以应用名.log来保存,保存在/home/admin/应用名/logs/目录下,过往日志格式为: {logname}.log.{保存日期}
,日期格式:yyyy-MM-dd
/home/admin/aapserver/logs/aap.log
,历史日志名称为aap.log.2021-11-01
3【强制】根据国家法律,网络运行状态、网络安全事件、个人敏感信息操作等相关记录,留存的日志不少于六个月,并且进行网络多机备份。
4 【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:
appName_logType_logName.log
。logType:日志类型,如 stats/monitor/access
等;logName:日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找
mppserver_monitor_timeZoneConvert.log
5【强制】在日志输出时,字符串变量之间的拼接使用占位符的方式。这里个人容易不符合规范
logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);
6 【强制】对于 trace/debug/info
级别的日志输出,必须进行日志级别的开关判断。
isDisabled(Level.DEBUG_INT)
为真时(Slf4j 的常见实现Log4j 和 Logback),就直接 return,但是参数可能会进行字符串拼接运算。此外,如果 debug(getName())
这种参数内有 getName()方法调用,无谓浪费方法调用的开销。正例:// 如果判断为真,那么可以输出 trace 和 debug 级别的日志
if (logger.isDebugEnabled()) {
logger.debug("Current ID is: {} and name is: {}", id, getName());
}
7 【强制】避免重复打印日志,浪费磁盘空间,务必在日志配置文件中设置 additivity=false
。
<logger name="com.taobao.dubbo.config" additivity="false">
additivity是 子Logger 是否继承 root的Logger 的 输出源(appender) 的标志位。具体说,默认情况下子Logger会继承root的Logger的appender,也就是说子Logger会在root的Logger的appender里输出。
若是additivity设为false,则子Logger只会在自己的appender里输出,不会在root的logger的appender里输出(个人可以理解为additivity设为false后,子Logger会覆盖掉root的logger)。
若是additivity设为true,则子Logger不止会在自己的appender里输出,还会在root的logger的appender里输出
8【强制】生产环境禁止直接使用 System.out
或 System.err
输出日志或使用
e.printStackTrace()
打印异常堆栈。
9【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过关键字 throws 往上抛出。这里个人容易不符合规范
logger.error("inputParams:{} and errorMessage:{}", 各类参数或者对象 toString(), e.getMessage(), e);
10【强制】日志打印时禁止直接用 JSON 工具将对象转换成 String。这里个人容易不符合规范
11【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使用warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘撑爆,并记得及时删除这些观察日志。这里个人容易不符合规范
异常部分收获也颇多,例如【异常码,异常信息,用户提示,HTTP状态码,堆栈信息】这5件套什么场景下使用,什么时候使用有了一个较为清晰的理解;以及对RPC的提供时的注意事项(使用Result而非异常抛出给调用方);还有就是进行RPC调用时的异常规范(只捕获,返回值给上层调用方);日志的级别选择;日志打印对象时最好不要使用JSON工具方法;以及自己最近刚犯的NPE错误(包装类到基本类型的转换)等,结合分层的异常输出规范,大致有个规范的认知了。
文章浏览阅读3.3k次,点赞7次,收藏39次。CPU 执行现行程序的过程中,出现某些急需处理的异常情况或特殊请求,CPU暂时中止现行程序,而转去对异常情况或特殊请求进行处理,处理完毕后再返回现行程序断点处,继续执行原程序。void 函数名(void) interrupt n using m {中断函数内容 //尽量精简 }编译器会把该函数转化为中断函数,表示中断源编号为n,中断源对应一个中断入口地址,而中断入口地址的内容为跳转指令,转入本函数。using m用于指定本函数内部使用的工作寄存器组,m取值为0~3。该修饰符可省略,由编译器自动分配。_51单片机中断篇
文章浏览阅读396次。项目经验(案例一)项目时间:2009-10 - 2009-12项目名称:中驰别克信息化管理整改完善项目描述:项目介绍一,建立中驰别克硬件档案(PC,服务器,网络设备,办公设备等)二,建立中驰别克软件档案(每台PC安装的软件,财务,HR,OA,专用系统等)三,能过建立的档案对中驰别克信息化办公环境优化(合理使用ADSL宽带资源,对域进行调整,对文件服务器进行优化,对共享打印机进行调整)四,优化完成后..._网络工程师项目经历
文章浏览阅读1k次,点赞31次,收藏30次。LVS:Linux Virtual Server,负载调度器,内核集成, 阿里的四层SLB(Server Load Balance)是基于LVS+keepalived实现。NATTUNDR优点端口转换WAN性能最好缺点性能瓶颈服务器支持隧道模式不支持跨网段真实服务器要求anyTunneling支持网络private(私网)LAN/WAN(私网/公网)LAN(私网)真实服务器数量High (100)High (100)真实服务器网关lvs内网地址。
文章浏览阅读899次。https://www.toutiao.com/a6713171323893318151/作者 | 黄小邪/言有三编辑 | 黄小邪/言有三图像预处理算法的好坏直接关系到后续图像处理的效果,如图像分割、目标识别、边缘提取等,为了获取高质量的数字图像,很多时候都需要对图像进行降噪处理,尽可能的保持原始信息完整性(即主要特征)的同时,又能够去除信号中无用的信息。并且,降噪还引出了一..._噪声很大的图片可以降噪吗
文章浏览阅读152次。目录谨慎地覆盖cloneCloneable接口并没有包含任何方法,那么它到底有什么作用呢?Object类中的clone()方法如何重写好一个clone()方法1.对于数组类型我可以采用clone()方法的递归2.如果对象是非数组,建议提供拷贝构造器(copy constructor)或者拷贝工厂(copy factory)3.如果为线程安全的类重写clone()方法4.如果为需要被继承的类重写clone()方法总结谨慎地覆盖cloneCloneable接口地目的是作为对象的一个mixin接口(详见第20_为继承设计类有两种选择,但无论选择其中的
文章浏览阅读958次,点赞21次,收藏24次。今天学长向大家分享一个毕业设计项目基于协同过滤的电影推荐系统项目运行效果:项目获取:https://gitee.com/assistant-a/project-sharing21世纪是信息化时代,随着信息技术和网络技术的发展,信息化已经渗透到人们日常生活的各个方面,人们可以随时随地浏览到海量信息,但是这些大量信息千差万别,需要费事费力的筛选、甄别自己喜欢或者感兴趣的数据。对网络电影服务来说,需要用到优秀的协同过滤推荐功能去辅助整个系统。系统基于Python技术,使用UML建模,采用Django框架组合进行设
文章浏览阅读614次。10G SFP+光模块被广泛应用于10G以太网中,在下一代移动网络、固定接入网、城域网、以及数据中心等领域非常常见。下面易天光通信(ETU-LINK)就为大家一一盘点下10G SFP+光模块都有哪些吧。一、10G SFP+双纤光模块10G SFP+双纤光模块是一种常规的光模块,有两个LC光纤接口,传输距离最远可达100公里,常用的10G SFP+双纤光模块有10G SFP+ SR、10G SFP+ LR,其中10G SFP+ SR的传输距离为300米,10G SFP+ LR的传输距离为10公里。_10g sfp+
文章浏览阅读239次。该项目含有源码、文档、程序、数据库、配套开发软件、软件安装教程。欢迎交流项目运行环境配置:项目技术:Express框架 + Node.js+ Vue 等等组成,B/S模式 +Vscode管理+前后端分离等等。环境需要1.运行环境:最好是Nodejs最新版,我们在这个版本上开发的。其他版本理论上也可以。2.开发环境:Vscode或HbuilderX都可以。推荐HbuilderX;3.mysql环境:建议是用5.7版本均可4.硬件环境:windows 7/8/10 1G内存以上;_基于vue美食网站源码
文章浏览阅读62次。oldwain随便写@hexun链接:http://oldwain.blog.hexun.com/ ...
文章浏览阅读843次,点赞16次,收藏22次。用这个工具扫描其它网站时,要注意法律问题,同时也比较慢,所以我们以之前写的登录页面为例子扫描。_sqlmap拖库
文章浏览阅读1.5w次,点赞5次,收藏38次。Origin也能玩转图片的拼接组合排版谭编(华南师范大学学报编辑部,广州 510631)通常,我们利用Origin软件能非常快捷地绘制出一张单独的绘图。但是,我们在论文的撰写过程中,经常需要将多种科学实验图片(电镜图、示意图、曲线图等)组合在一张图片中。大多数人都是采用PPT、Adobe Illustrator、CorelDraw等软件对多种不同类型的图进行拼接的。那么,利用Origin软件能否实..._origin怎么把三个图做到一张图上
文章浏览阅读4.2k次,点赞4次,收藏51次。51单片机智能电风扇控制系统仿真设计( proteus仿真+程序+原理图+报告+讲解视频)仿真图proteus7.8及以上 程序编译器:keil 4/keil 5 编程语言:C语言 设计编号:S0042。_电风扇模拟控制系统设计