《阿里开发手册》读书笔记（七）

红太狼 2022-05-26 02:56 170阅读 0赞

12. 12.  【推荐】定义时区分  unchecked  /  checked  异常，避免直接使用  RuntimeException  抛出，  
更不允许抛出  Exception  或者  Throwable ，应使用有业务含义的自定义异常。推荐业界已定义

过的自定义异常，如： DAOException / ServiceException 等。

14.13. 【参考】避免出现重复的代码（Don’t Repeat Yourself） ，即 DRY 原则。  
说明： 随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副  
本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是共用模块。  
正例： 一个类中有多个 public 方法，都需要进行数行相同的参数校验操作，这个时候请抽取：  
private boolean checkParam(DTO dto)\{...\}

1. 【强制】应用中不可直接使用日志系统（Log4j、 Logback） 中的 API，而应依赖使用日志框架  
SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
private static final Logger logger = LoggerFactory.getLogger(Abc.class);

2. 【强制】日志文件推荐至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。

4. 【强制】对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方  
式。  
说明： logger.debug("Processing trade with id: " + id \+ " symbol: " + symbol);  
如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象，  
会执行 toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。  
正例： （条件）  
if (logger.isDebugEnabled()) \{  
logger.debug("Processing trade with id: " + id + " symbol: " + symbol);  
\}  
正例： （占位符）  
logger.debug("Processing trade with id: \{\} symbol : \{\} ", id, symbol);

5. 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。  
正例： <logger name="com.taobao.dubbo.config" additivity="false">

6. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么往上  
抛。

正例： logger.error(各类参数或者对象 toString + "\_" + e.getMessage(), e);

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

8. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志； 有选择地输出 info 日志； 如果使  
用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘  
撑爆，并记得及时删除这些观察日志。  
说明： 大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。 记录日志时请  
思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？