这里是码农充电第一站，回复“666”，获取一份专属大礼包
真爱，请设置“星标”或点个“在看
作者：西格玛
来源：http://lrwinx.github.io

# 使用slf4j

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

# 打日志的正确方式

什么时候应该打日志

• 当你遇到问题的时候，只能通过debug功能来确定问题，你应该考虑打日志，良好的系统，是可以通过日志进行问题定为的。

• 当你碰到if…else 或者 switch这样的分支时，要在分支的首行打印日志，用来确定进入了哪个分支

• 经常以功能为核心进行开发，你应该在提交代码前，可以确定通过日志可以看到整个流程

基本格式

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

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

if (logger.isDebugEnabled()) {    logger.debug("Processing trade with id: " +id + " symbol: " + symbol);}

logger.debug("Processing trade with id: " + id + " symbol: " + symbol);

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

# 不同级别的使用

ERROR:

基本概念

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

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

基本概念

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

INFO:

基本概念

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

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

说明

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);}

2、对于复杂的业务逻辑，需要进行日志打点，以及埋点记录，比如电商系统
中的下订单逻辑，以及OrderAction操作(业务状态变更)。

DEBUG

基本概念

1. 可以填写所有的想知道的相关信息(但不代表可以随便写，debug信息要有意义,最好有相关参数)
2. 生产环境需要关闭DEBUG信息
3. 如果在生产情况下需要开启DEBUG,需要使用开关进行管理，不能一直开启。

说明

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

logger.debug("开始获取员工[{}] [{}]年基本薪资",employee,year);
logger.debug("获取员工[{}] [{}]年的基本薪资为[{}]",employee,year,basicSalary);logger.debug("开始获取员工[{}] [{}]年[{}]月休假情况",employee,year,month);
logger.debug("员工[{}][{}]年[{}]月年假/病假/事假为[{}]/[{}]/[{}]",employee,year,month,annualLeaveDays,sickLeaveDays,noPayLeaveDays);logger.debug("开始计算员工[{}][{}]年[{}]月应得薪资",employee,year,month);
logger.debug("员工[{}] [{}]年[{}]月应得薪资为[{}]",employee,year,month,actualSalary);

TRACE

基本概念

规范示例说明

@Override@Transactionalpublic 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());    }}

- END -
最近热文
•  程序员被公司辞退12天，前领导要求回公司讲清楚代码，结果懵了
•  超级天才尹希：31岁成哈佛史上最年轻教授，却因国籍引发争议
•  美团面试题：hashCode 和对象的内存地址有什么关系？
•  人脸识别的时候，一定要穿上衣服啊！