使用slf4j

• 使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
• 实现方式统一使用: Logback框架

打日志的正确方式

什么时候应该打日志

• 当你遇到问题的时候，只能通过debug功能来确定问题，你应该考虑打日志，良好的系统，是可以通过日志进行问题定为的。
• 当你碰到if…else 或者 switch这样的分支时，要在分支的首行打印日志，用来确定进入了哪个分支
• 经常以功能为核心进行开发，你应该在提交代码前，可以确定通过日志可以看到整个流程

基本格式

必须使用参数化信息的方式:

1. logger.debug(
2. "Processing trade with id:[{}] and symbol : [{}] "
3. , id, symbol);

对于debug日志，必须判断是否为debug级别后，才进行使用:

1. if
2. (logger.isDebugEnabled()) {
3. logger.debug(
4. "Processing trade with id: "
5. +id +
6. " symbol: "
7. + symbol);
8. }

不要进行字符串拼接,那样会产生很多String对象，占用空间，影响性能。

反例(不要这么做):

1. logger.debug(
2. "Processing trade with id: "
3. + id +
4. " symbol: "
5. + symbol);

使用[]进行参数变量隔离

如有参数变量，应该写成如下写法:

1. logger.debug(
2. "Processing trade with id:[{}] and symbol : [{}] "
3. , id, symbol);

这样的格式写法，可读性更好，对于排查问题更有帮助。

不同级别的使用

ERROR

基本概念

影响到程序正常运行、当前请求正常运行的异常情况:

• 打开配置文件失败
• 所有第三方对接的异常(包括第三方返回错误码)
• 所有影响功能使用的异常，包括:SQLException和除了业务异常之外的所有异常(RuntimeException和Exception)

不应该出现的情况:

• 比如要使用Azure传图片，但是Azure未响应

如果有Throwable信息，需要记录完成的堆栈信息:

1. log.error(
2. "获取用户[{}]的用户信息时出错"
3. ,userName,e);

说明如果进行了抛出异常操作，请不要记录error日志，由最终处理方进行处理：

反例，不要这么做！

1. try
2. {
3. ....
4. }
5. catch
6. (
7. Exception
8. ex){
10. String
11. errorMessage=
12. String
13. .format(
14. "Error while reading information of user [%s]"
15. ,userName);
16. logger.error(errorMessage,ex);
18. throw
20. new
22. UserServiceException
23. (errorMessage,ex);
24. }

WARN

基本概念

不应该出现但是不影响程序、当前请求正常运行的异常情况:

• 有容错机制的时候出现的错误情况
• 找不到配置文件，但是系统能自动创建配置文件

即将接近临界值的时候，例如：

• 缓存池占用达到警告线

业务异常的记录，比如:

• 当接口抛出业务异常时，应该记录此异常

INFO

基本概念

系统运行信息

• Service方法中对于系统/业务状态的变更
• 主要逻辑中的分步骤

外部接口部分

• 客户端请求参数(REST/WS)
• 调用第三方时的调用参数和调用结果

说明

• 并不是所有的service都进行出入口打点记录，单一、简单service是没有意义的(job除外，job需要记录开始和结束)。
• 反例，不要这么做:

1. public
3. List
4. listByBaseType(
5. Integer
6. baseTypeId) {
7. log.info(
8. "开始查询基地"
9. );
10. BaseExample
11. ex=
12. new
14. BaseExample
15. ();
16. BaseExample
17. .
18. Criteria
19. ctr = ex.createCriteria();
20. ctr.andIsDeleteEqualTo(
21. IsDelete
22. .USE.getValue());
23. Optionals
24. .doIfPresent(baseTypeId, ctr::andBaseTypeIdEqualTo);
25. log.info(
26. "查询基地结束"
27. );
28. return
29. baseRepository.selectByExample(ex);
30. }

• 对于复杂的业务逻辑，需要进行日志打点，以及埋点记录，比如电商系统中的下订单逻辑，以及OrderAction操作(业务状态变更)。
• 对于整个系统的提供出的接口(REST/WS)，使用info记录入参
• 如果所有的service为SOA架构，那么可以看成是一个外部接口提供方，那么必须记录入参。
• 调用其他第三方服务时，所有的出参和入参是必须要记录的(因为你很难追溯第三方模块发生的问题)

DEBUG

基本概念

可以填写所有的想知道的相关信息，但不代表可以随便写，debug信息要有意义,最好有相关参数

• 生产环境需要关闭DEBUG信息
• 如果在生产情况下需要开启DEBUG,需要使用开关进行管理，不能一直开启。

说明

如果代码中出现以下代码，可以进行优化:

1. //1. 获取用户基本薪资
2. //2. 获取用户休假情况
3. //3. 计算用户应得薪资

优化后的代码:

1. logger.debug(
2. "开始获取员工[{}] [{}]年基本薪资"
3. ,employee,year);
4. logger.debug(
5. "获取员工[{}] [{}]年的基本薪资为[{}]"
6. ,employee,year,basicSalary);
7. logger.debug(
8. "开始获取员工[{}] [{}]年[{}]月休假情况"
9. ,employee,year,month);
10. logger.debug(
11. "员工[{}][{}]年[{}]月年假/病假/事假为[{}]/[{}]/[{}]"
12. ,employee,year,month,annualLeaveDays,sickLeaveDays,noPayLeaveDays);
13. logger.debug(
14. "开始计算员工[{}][{}]年[{}]月应得薪资"
15. ,employee,year,month);
16. logger.debug(
17. "员工[{}] [{}]年[{}]月应得薪资为[{}]"
18. ,employee,year,month,actualSalary);

TRACE

基本概念

特别详细的系统运行完成信息，业务代码中，不要使用，除非有特殊用意，否则请使用DEBUG级别替代。

规范示例说明

1. @Override
2. @Transactional
3. public
5. void
6. createUserAndBindMobile(
7. @NotBlank
9. String
10. mobile,
11. @NotNull
13. User
14. user)
15. throws
17. CreateConflictException
18. {
20. boolean
21. debug = log.isDebugEnabled();
23. if
24. (debug){
25. log.debug(
26. "开始创建用户并绑定手机号. args[mobile=[{}],user=[{}]]"
27. , mobile,
28. LogObjects
29. .toString(user));
30. }
32. try
33. {
34. user.setCreateTime(
35. new
37. Date
38. ());
39. user.setUpdateTime(
40. new
42. Date
43. ());
44. userRepository.insertSelective(user);
46. if
47. (debug){
48. log.debug(
49. "创建用户信息成功. insertedUser=[{}]"
50. ,
51. LogObjects
52. .toString(user));
53. }
55. UserMobileRelationship
56. relationship =
57. new
59. UserMobileRelationship
60. ();
61. relationship.setMobile(mobile);
62. relationship.setOpenId(user.getOpenId());
63. relationship.setCreateTime(
64. new
66. Date
67. ());
68. relationship.setUpdateTime(
69. new
71. Date
72. ());
73. userMobileRelationshipRepository.insertOnDuplicateKey(relationship);
75. if
76. (debug){
77. log.debug(
78. "绑定手机成功. relationship=[{}]"
79. ,
80. LogObjects
81. .toString(relationship));
82. }
83. log.info(
84. "创建用户并绑定手机号. userId=[{}],openId=[{}],mobile=[{}]"
85. ,user.getId(),user.getOpenId(),mobile);
86. // 如果考虑安全，手机号记得脱敏
87. }
88. catch
89. (
90. DuplicateKeyException
91. e){
92. log.info(
93. "创建用户并绑定手机号失败,已存在相同的用户. openId=[{}],mobile=[{}]"
94. ,user.getOpenId(),mobile);
96. throw
98. new
100. CreateConflictException
101. (
102. "创建用户penid=[%s]"
103. ,user.getOpenId());
104. }

转发并关注私信小编：“资料”即可领取最新资料