• 别在 Java 代码里乱打日志了，这才是正确的打日志姿势！

    点击上方“方志朋”，选择“设为星标”

    回复”666“获取新整理的面试资料

    作者：lrwin

    使用slf4j

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

    2. 实现方式统一使用: Logback框架

    打日志的正确方式

    什么时候应该打日志

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

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

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

    基本格式

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

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

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

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

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

    反例(不要这么做):

    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)

    不应该出现的情况:

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

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

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

    说明

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

    反例(不要这么做):

    1. try{
    2.     ....
    3. }catch(Exception ex){
    4.   String errorMessage=String.format("Error while reading information of user [%s]",userName);
    5.   logger.error(errorMessage,ex);
    6.   throw new UserServiceException(errorMessage,ex);
    7. }

    WARN

    基本概念

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

    1. 有容错机制的时候出现的错误情况

    2. 找不到配置文件，但是系统能自动创建配置文件

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

    1. 缓存池占用达到警告线

    业务异常的记录,比如:

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

    INFO:

    基本概念

    系统运行信息

    1. Service方法中对于系统/业务状态的变更

    2. 主要逻辑中的分步骤

    外部接口部分

    1. 客户端请求参数(REST/WS)

    2. 调用第三方时的调用参数和调用结果

    说明

    1.并不是所有的service都进行出入口打点记录,单一、简单service是没有意义的(job除外,job需要记录开始和结束,)。

    反例(不要这么做):

    1. public List listByBaseType(Integer baseTypeId) {
    2.     log.info("开始查询基地");
    3. BaseExample ex=new BaseExample();
    4. BaseExample.Criteria ctr = ex.createCriteria();
    5. ctr.andIsDeleteEqualTo(IsDelete.USE.getValue());
    6. Optionals.doIfPresent(baseTypeId, ctr::andBaseTypeIdEqualTo);
    7.     log.info("查询基地结束");
    8. return baseRepository.selectByExample(ex);
    9. }

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

    3.对于整个系统的提供出的接口(REST/WS)，使用info记录入参

    4.如果所有的service为SOA架构，那么可以看成是一个外部接口提供方，那么必须记录入参。

    5.调用其他第三方服务时，所有的出参和入参是必须要记录的(因为你很难追溯第三方模块发生的问题)

    DEBUG

    基本概念

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

    2. 生产环境需要关闭DEBUG信息

    3. 如果在生产情况下需要开启DEBUG,需要使用开关进行管理，不能一直开启。

    说明

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

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

    优化后的代码:

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

    TRACE

    基本概念

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

    规范示例说明

    1. @Override
    2. @Transactional
    3. public void createUserAndBindMobile(@NotBlank String mobile, @NotNull User user) throws CreateConflictException{
    4.     boolean debug = log.isDebugEnabled();
    5.     if(debug){
    6.         log.debug("开始创建用户并绑定手机号. args[mobile=[{}],user=[{}]]", mobile, LogObjects.toString(user));
    7.     }
    8.     try {
    9.         user.setCreateTime(new Date());
    10.         user.setUpdateTime(new Date());
    11.         userRepository.insertSelective(user);
    12.         if(debug){
    13.             log.debug("创建用户信息成功. insertedUser=[{}]",LogObjects.toString(user));
    14.         }
    15.         UserMobileRelationship relationship = new UserMobileRelationship();
    16.         relationship.setMobile(mobile);
    17.         relationship.setOpenId(user.getOpenId());
    18.         relationship.setCreateTime(new Date());
    19.         relationship.setUpdateTime(new Date());
    20.         userMobileRelationshipRepository.insertOnDuplicateKey(relationship);
    21.         if(debug){
    22.             log.debug("绑定手机成功. relationship=[{}]",LogObjects.toString(relationship));
    23.         }
    24.         log.info("创建用户并绑定手机号. userId=[{}],openId=[{}],mobile=[{}]",user.getId(),user.getOpenId(),mobile);
    25.     }catch(DuplicateKeyException e){
    26.         log.info("创建用户并绑定手机号失败,已存在相同的用户. openId=[{}],mobile=[{}]",user.getOpenId(),mobile);
    27.         throw new CreateConflictException("创建用户发生冲突, openid=[%s]",user.getOpenId());
    28.     }
    29. }

    热门内容：   

        


    最近面试BAT，整理一份面试资料《Java面试BAT通关手册》，覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。

    获取方式：点“在看”，关注公众号并回复 666 领取，更多内容陆续奉上。

    明天见(｡･ω･｡)ﾉ♡ 

    来源：https://blog.csdn.net/zhipengfang/article/details/117452287
  • 相关阅读:
    算法笔记 --- Scale Sort
    算法笔记 --- String Rotation
    Css3动画缩放
    第一天
    SpringMVC_Controller中方法的返回值
    SpringMVC_url-pattern的写法
    SpringMVC_注释编写SpringMvc程序，RequestMapping常用属性，请求提交方式，请求携带参数
    SpringMVC_数据校验
    SpringMVC_类型转换器
    SpringMVC_异常处理的三种方式
  • 原文地址：https://www.cnblogs.com/konglxblog/p/16411647.html
Copyright © 2020-2023  润新知