如何在项目中打日志

hellosc01

已于 2023-09-12 14:35:22 修改

阅读量667

点赞数 2

于 2023-01-09 13:43:51 首次发布

本文链接：https://blog.csdn.net/sc179/article/details/128558248

版权

后端开发知识点汇总专栏收录该内容

20 篇文章 1 订阅

订阅专栏

使用 slf4j

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

打日志的时机

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

基本格式

不要进行字符串拼接,那样会产生很多String对象，占用空间，影响性能。
反例(不要这么做):

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

必须使用参数化信息的方式，并使用[]进行参数变量隔离：

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

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

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

不同日志级别的使用

ERROR

使用场景

影响到程序和当前请求正常运行的异常情况，比如像：

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

注意事项

如果有Throwable信息，需要记录完整的堆栈信息：

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

WARN

使用场景

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

有容错机制的时候出现的错误情况；
找不到配置文件，但是系统能自动创建配置文件；
即将接近临界值的时候，例如：缓存池占用达到警告线；

INFO

使用场景

系统的运行信息

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

外部接口部分

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

注意事项

并不是所有的service都进行出入口打点记录，单一、简单service是没有意义的;

反例(不要这么做):

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操作(业务状态变更);
调用其他第三方服务时，所有的出参和入参是必须要记录的（因为你很难追溯第三方模块发生的问题）;

DEBUG

使用场景及注意事项

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

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

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