注意事项
应当清楚自己记录的内容
log.debug(“Processing request with id: {}”, request.getId());
要避免空指针异常，比如这里要确定request不为null
toString方法可能没有正确的实现或者使用。
首先，为了记录日志，为每个类创建一个toString的做法比比皆是，最好用 ToStringBuilder来生成（不过不是它的反射实现的那个版本）。
第二，注意数组和非典型的集合。数组和一些另类的集合的toString实现可能没有挨个调用每个元素的toString方法。可以使用JDK提供的Arrays#deepToString方法。经常检查一下你自己打印的日志，看有没有格式异常的一些信息。
门面模式
三分钟学会门面模式！ (qq.com)
什么时候应该打日志
当你遇到问题的时候，只能通过debug功能来确定问题，你应该考虑打日志，良好的系统，是可以通过日志进行问题定为的。
当你碰到if…else 或者 switch这样的分支时，要在分支的首行打印日志，用来确定进入了哪个分支
经常以功能为核心进行开发，你应该在提交代码前，可以确定通过日志可以看到整个流程
避免副作用
有时候日志打印会导致延迟初始化的集合被加载，这种时候，把日志级别提高集合就不再被初始化
另一个副作用是影响程序的运行速度，如果日志打印过多或者没有正确使用toString和字符串拼接，日志打印就会对性能产生负面影响
如果是由于日志打印异常导致的业务进程终止，这个副作用就大了。有些人甚至为了避免这种情况而这么写：（反例）
try {
log.trace("Id=" + request.getUser().getId() + " accesses " + manager.getPage().getUrl().toString())
} catch(NullPointerException e) {}描述要清晰
日志中要加上消息类型，消息ID
日志文件应当是可读性强，清晰地，自描述的，记录处理的数据以及它的含义，记录程序正在干什么，好的日志应该是程序代码的一份好文档
不要打印密码和个人信息
调整格式
理想的日志格式应当包括：当前时间（无日期，毫秒级精度），日志级别，线程名，简单的日志名称（不用全称）还有消息, 文件名，类名，行号，都不用列进来，尽管它们看起来很有用。
记录方法的参数和返回值
log.debug("Entering printDocument(doc={}, mode={})", doc, mode);
String id = ...; //Lengthy printing operation
log.debug("Leaving printDocument(): {}", id);
return id;
}观察外部系统
观察外部传参大小，类型，是否为null
正确的记录异常
Integer x = null;
++x;
} catch (Exception e) {
log.error(e); //A
log.error(e, e); //B
log.error("" + e); //C
log.error(e.toString()); //D
log.error(e.getMessage()); //E
log.error(null, e); //F
log.error("", e); //G
log.error("{}", e); //H
log.error("{}", e.getMessage()); //I
log.error("Error reading configuration file: " + e); //J
log.error("Error reading configuration file: " + e.getMessage()); //K
log.error("Error reading configuration file", e); //L
}其中只有G和L是对的，A和B在slf4j下编译不过。
第一个参数通常都是文本信息，想要打印异常要将异常传到第二个参数里面才行。
日志应当可读性强且易于解析
如果有可能的话，你记录的日志最好能让人和计算机都能看明白 ，不要将数字格式化，用一些能让正则容易匹配的格式等等。如果不可能的，用两个格式来打印数据
基本格式
必须使用参数化信息的方式
logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);
对于debug日志，必须判断是否为debug级别后，才进行使用
if (logger.isDebugEnabled()) {
logger.debug("Processing trade with id: " +id + " symbol: " + symbol);
}不要进行字符串拼接，会产生很多String对象，占用空间，影响性能。
反例：
logger.debug("Processing trade with id: " + id + " symbol: " + symbol);使用[]进行参数变量隔离
这样的写法可读性更佳，对于排查问题更有帮助
不同级别的使用
Error
影响到程序正常运行、当前请求正常运行的异常情况:
- 打开配置文件失败
- 所有第三方对接的异常(包括第三方返回错误码)
- 所有影响功能使用的异常，包括:SQLException和除了业务异常之外的所有异常(RuntimeException和Exception)
不应该出现的情况: - 比如要使用Azure传图片，但是Azure未响应
如果有Throwable信息，需要记录完成的堆栈信息:
log.error(“获取用户[{}]的用户信息时出错”,userName,e);
说明 - 如果进行了抛出异常操作，请不要记录error日志，由最终处理方进行处理：
反例:
try{
....
}catch(Exception ex){
String errorMessage=String.format("Error while reading information of user [%s]",userName);
logger.error(errorMessage,ex);
throw new UserServiceException(errorMessage,ex);
}WARN
不应该出现但是不影响程序、当前请求正常运行的异常情况:
有容错机制的时候出现的错误情况
找不到配置文件，但是系统能自动创建配置文件（如果不能自动创建配置文件就会编程error）
即将接近临界值的时候，例如：
缓存池占用达到警告线
业务异常的记录,比如:
当接口抛出业务异常时，应该记录此异常
INFO
基本概念
系统运行信息
- Service方法中对于系统/业务状态的变更
- 主要逻辑中的分步骤
外部接口部分 - 客户端请求参数(REST/WS)
- 调用第三方时的调用参数和调用结果
说明 - 并不是所有的service都进行出入口打点记录,单一、简单service是没有意义的(job除外,job需要记录开始和结束,)。
- 反例(不要这么做):
public List listByBaseType(Integer baseTypeId) {
log.info("开始查询基地");
BaseExample ex=new BaseExample();
BaseExample.Criteria ctr = ex.createCriteria();
ctr.andIsDeleteEqualTo(IsDelete.USE.getValue());
Optionals.doIfPresent(baseTypeId, ctr::andBaseTypeIdEqualTo);
log.info("查询基地结束");
return baseRepository.selectByExample(ex);
}- 对于复杂的业务逻辑，需要进行日志打点，以及埋点记录，比如电商系统中的下订单逻辑，以及OrderAction操作(业务状态变更)。
- 对于整个系统的提供出的接口(REST/WS)，使用info记录入参
- 如果所有的service为SOA架构，那么可以看成是一个外部接口提供方，那么必须记录入参。
- 调用其他第三方服务时，所有的出参和入参是必须要记录的(因为你很难追溯第三方模块发生的问题)
DEBUG
基本概念
- 可以填写所有的想知道的相关信息(但不代表可以随便写，debug信息要有意义,最好有相关参数)
- 生产环境需要关闭DEBUG信息
- 如果在生产情况下需要开启DEBUG,需要使用开关进行管理，不能一直开启。
说明
日志信息要尽可能完善和详细
//获取用户基本薪资
logger.debug(“开始获取员工[{}] [{}]年基本薪资”,employee,year);
//获取用户休假情况
logger.debug(“开始获取员工[{}] [{}]年[{}]月休假情况”,employee,year,month);
//计算用户应得薪资
logger.debug(“开始计算员工[{}][{}]年[{}]月应得薪资”,employee,year,month);
//优化后
logger.debug(“获取员工[{}] [{}]年的基本薪资为[{}]”,employee,year,basicSalary);
logger.debug(“员工[{}][{}]年[{}]月年假/病假/事假为[{}]/[{}]/[{}]”,employee,year,month,annualLeaveDays,sickLeaveDays,noPayLeaveDays);
logger.debug(“员工[{}] [{}]年[{}]月应得薪资为[{}]”,employee,year,month,actua
TRACE
基本概念
特别详细的系统运行完成信息，业务代码中，不要使用.(除非有特殊用意，否则请使用DEBUG级别替代)
规范示例说明
@Override
@Transactional
public void createUserAndBindMobile(@NotBlank String mobile, @NotNull User user) throws CreateConflictException{
boolean debug = log.isDebugEnabled();
if(debug){
log.debug("开始创建用户并绑定手机号. args[mobile=[{}],user=[{}]]", mobile, LogObjects.toString(user));
}
try {
user.setCreateTime(new Date());
user.setUpdateTime(new Date());
userRepository.insertSelective(user);
if(debug){
log.debug("创建用户信息成功. insertedUser=[{}]",LogObjects.toString(user));
}
UserMobileRelationship relationship = new UserMobileRelationship();
relationship.setMobile(mobile);
relationship.setOpenId(user.getOpenId());
relationship.setCreateTime(new Date());
relationship.setUpdateTime(new Date());
userMobileRelationshipRepository.insertOnDuplicateKey(relationship);
if(debug){
log.debug("绑定手机成功. relationship=[{}]",LogObjects.toString(relationship));
}
log.info("创建用户并绑定手机号. userId=[{}],openId=[{}],mobile=[{}]",user.getId(),user.getOpenId(),mobile);
}catch(DuplicateKeyException e){
log.info("创建用户并绑定手机号失败,已存在相同的用户. openId=[{}],mobile=[{}]",user.getOpenId(),mobile);
throw new CreateConflictException("创建用户发生冲突, openid=[%s]",user.getOpenId());
}
}错误异常
错误异常分为程序异常（系统异常）和业务异常；
程序异常会导致程序不能正常执行；业务异常不会，业务异常的处理属于业务逻辑的一部分；
ERROR 级别的日志，一出，意味着开发运维人员要介入了，要操作确认一下东西，要维修一些东西了；
业务系统开发过程中，不需要 log.error 记录异常，让框架和容器（Tomcat等）来做；
业务异常的需要开发者开发对应的异常处理逻辑，业务异常不是程序异常；比如用户登陆失败；
业务异常的处理属于正常的业务逻辑，不应该log.error，不重要的可以不log，重要的可以使用log.warn记录，避免用户投诉时,可以追溯信息;
数据库或者kafka在应用启动时连不上是如何处理的，在应用运行过程中是如何处理的？启动时，依赖的插件有问题，应用直接启动不起来；如果应用已经启动起来了，触发到跟其交互时，抛出异常，程序还是正常执行；
链路追踪
多个进程间的日志联动
集中式日志存储系统的存在，让在一个入口处理业务系统的日志成为了可能，产生了高级的用法，链路追踪；
用户的一个动作触发的在各个系统的所有的执行逻辑，使用一个标识将其联系起来，开发人员分析的时候，可以根据此标识查询所有相关的日志，哪里出问题，一目了然；
远程调用
远程调用的plan b，就是熔断降级里面的Plan B；
外部接口部分,客户端请求参数(REST/WS),调用第三方时的调用参数和调用结果使用info
如果出异常，调用过程异常或者返回错误码，根据情况选择抛出异常或者启用Plan B；
抛出异常意味着程序正常流程执行结束，需要处理这个异常，warn记录此异常，然后返回用户结果；
Plan B意味着程序还可以正常执行下去，warn记录发生了此事件，出现异常转入Plan B；
远程调用过程中出异常，意味着需要开发人员介入，应该记录 error 级别的异常；
如果是返回的错误码是非成功执行的错误码，这时候应该根据错误码的级别抛出不同的异常，处理异常的地方根据远程调用的接口的重要程度评估使用不同的日志级别。
验证日志
提交代码前，确定通过日志可以看到一个功能的整个执行流程，可以通过日志进行问题定位程序执行的路径；
