掘金 后端 ( ) • 2024-04-08 11:06
一起来学阿里巴巴Java开发手册(九)
手册 阿里巴巴

前言

目前正在出一个阿里巴巴Java开发手册系列教程, 篇幅会较多, 喜欢的话，给个关注❤️ ~

在日常开发中，好的编码习惯和代码规范有助于提高代码可读性,提升团队协作效率,还利于维护与扩展，在某些情况下还有利于优化性能。今天就带着大家一起学习下手册中的内容，学习下Java开发中的编码规范。

好了, 废话不多说直接开整吧~

日志规约

  1. 【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架（SLF4J、JCL--Jakarta Commons Logging）中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。 说明：日志框架（SLF4J、JCL--Jakarta Commons Logging）的使用方式（推荐使用 SLF4J） 使用 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);

  1. 【强制】所有日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。对于当天日志，以应用名.log来保存，保存在/home/admin/应用名/logs/目录下，过往日志格式为: {logname}.log.{保存日期}，日期格式：yyyy-MM-dd 说明：以 mppserver 应用为例，日志保存在/home/admin/mppserver/logs/mppserver.log，历史日志名称为 mppserver.log.2016-08-01

  2. 【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式： appName_logType_logName.log。logType:日志类型，如 stats/monitor/access 等；logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。 说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。

正例：

mppserver 应用中单独监控时区转换异常，如：mppserver_monitor_timeZoneConvert.log

  1. 【强制】在日志输出时，字符串变量之间的拼接使用占位符的方式。 说明：因为 String 字符串的拼接会使用 StringBuilder 的 append()方式，有一定的性能损耗。使用占位符仅是替换动作，可以有效提升性能。 正例：
logger.debug("Processing trade with id: {} and symbol: {}", id, symbol);
  1. 【强制】对于 trace/debug/info 级别的日志输出，必须进行日志级别的开关判断。 说明：虽然在 debug(参数)的方法体内第一行代码 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());
}
  1. 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。 正例：
<logger name="com.taobao.dubbo.config" additivity="false">
  1. 【强制】生产环境禁止直接使用 System.out 或 System.err 输出日志或使用e.printStackTrace()打印异常堆栈。

说明：标准日志输出与标准错误输出文件每次 Jboss 重启时才滚动，如果大量输出送往这两个文件，容易造成文件大小超过操作系统大小限制

  1. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 往上抛出。

正例：

logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);
  1. 【强制】日志打印时禁止直接用 JSON 工具将对象转换成 String。 说明：如果对象里某些 get 方法被重写，存在抛出异常的情况，则可能会因为打印日志而影响正常业务流程的执行。

正例：打印日志时仅打印出业务相关属性值或者调用其对象的 toString()方法

10.【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。

说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

11.【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。 说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。

12.【推荐】尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述即可，否则容易产生歧义。 说明：国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。

结束语

本系列到此就结束了，给大家推荐一款idea插件Alibaba Java Coding Guidelines​,这个插件能够自动检查代码规范，大家可以去尝试一下~

本着把自己知道的都告诉大家，如果本文对有所帮助，点赞+关注鼓励一下呗~

阿里巴巴Java开发手册相关文章

MybatisPlus教程相关文章

往期Nginx教程相关文章

往期Docker教程相关文章

往前Shell脚本编程相关文章

往期Linux相关文章

往期面试题相关文章

项目源码(源码已更新 欢迎star⭐️)

往期设计模式相关文章

设计模式项目源码(源码已更新 欢迎star⭐️)

Kafka 专题学习

项目源码(源码已更新 欢迎star⭐️)

ElasticSearch 专题学习

项目源码(源码已更新 欢迎star⭐️)

往期并发编程内容推荐

推荐 SpringBoot & SpringCloud (源码已更新 欢迎star⭐️)

博客(阅读体验较佳)
相关内容
港股午盘丨恒指涨1.14%，科技股走强 | 恒指涨1.14%，恒生科技指数涨2.07%。科技股走强，哔哩哔哩涨超6%，网易、京东涨超4%，百度集团、阿里巴巴涨超3%。
财联社5月1日电，阿里巴巴考虑在越南建设数据中心。 (日经新闻)
阿里巴巴将于5月14日公布2024财年业绩
阿里巴巴倚天710 128核心处理器实测：Arm史上最快
热门中概股多数上涨 | 理想汽车涨超7%，百度涨超5%，小鹏汽车涨超3%，蔚来涨超2%，哔哩哔哩、阿里巴巴、爱奇艺涨超1%，唯品会、网易、腾讯音乐小幅上涨。...
阿里巴巴开源 1100 亿参数 Qwen1.5-110B 模型
阿里巴巴发布了首个千亿参数的大模型 Qwen1.5-110B
港股科技股走高 | 哔哩哔哩涨超5%，联想集团涨超3%，微博、阿里巴巴等跟涨。
美股热门中概股多数上涨 | 哔哩哔哩涨超8%，名创优品涨近4%，京东、蔚来汽车涨近3%，阿里巴巴、网易、小鹏汽车涨近2%。
港股午后持续走高 | 恒生指数午后涨超2%，恒生科技指数涨超3%。哔哩哔哩涨超10%，快手涨超7%，阿里巴巴涨超4%。