Java日志

最新推荐文章于 2024-09-23 07:00:00 发布
最新推荐文章于 2024-09-23 07:00:00 发布
阅读量125 收藏
点赞数
分类专栏： Java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Emma0o/article/details/119887262
版权
本文介绍了Java日志的基础使用场景、格式规范、日志级别及其应用，强调了错误的日志记录方式，并对比了CommonsLogging与Slf4j的实现机制。建议在新项目中使用Slf4j与Logback组合，以获得更好的性能和灵活性。
摘要由CSDN通过智能技术生成

Java日志

基础

使用场景

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

基本格式

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

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

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

反例(不要这么做):

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

日志级别

日志级别描述
OFF 关闭最高级别，不输出日志
FATAL 致命输出非常严重的可能会导致应用程序终止的错误。
ERROR 错误：输出错误，但应用还能继续运行 主要是程序的错误。
WARN 警告：输出可能潜在的危险状况，比如session丢失。
INFO 信息：输出应用运行过程的详细信息，比如登录登出。
DEBUG 调试：输出更细致的对调试应用有用的信息。
TRACE 跟踪：输出更细致的程序运行轨迹。

ALL 所有：输出所有级别信息。
日志优先级别标准顺序为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF

不同级别的使用

ERROR

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

  1. 打开配置文件失败

  2. 所有第三方对接的异常(包括第三方返回错误码)

  3. 所有影响功能使用的异常，包括:SQLException和除了业务异常之外的所有异常(RuntimeException和Exception)

不应该出现的情况:
比如要使用Azure传图片，但是Azure未响应
如果有Throwable信息，需要记录完成的堆栈信息:

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

说明
如果进行了抛出异常操作，请不要记录error日志，由最终处理方进行处理：
反例(不要这么做): 原因见3

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. 主要逻辑中的分步骤
    外部接口部分
  3. 客户端请求参数(REST/WS)
  4. 调用第三方时的调用参数和调用结果

说明

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

基本概念
特别详细的系统运行完成信息，业务代码中，不要使用.(除非有特殊用意，否则请使用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());
    }
}

几个错误的打日志方式

1. 不要使用 System.out.print…

输出日志的时候只能通过日志框架来输出日志，而不能使用 System.out.print… 来打印日志，这个只会打印到 tomcat 控制台，而不会记录到日志文件中，不方便管理日志，如果通过服务形式启动把日志丢弃了那更是找不到日志了。

2. 不要使用 e.printStackTrace()

首先来看看它的源码：

public void printStackTrace() {
    printStackTrace(System.err);
}

它其实也是利用 System.err 输出到了 tomcat 控制台。

3. 不要抛出异常后又输出日志

如捕获异常后又抛出了自定义业务异常，此时无需记录错误日志，由最终捕获方进行异常处理。不能又抛出异常，又打印错误日志，不然会造成重复输出日志。

try {
    // ...
} catch (Exception e) {
    // 错误
    LOG.error("xxx", e);
    throw new RuntimeException();
}

4. 不要使用具体的日志实现类

InterfaceImpl interface = new InterfaceImpl();

这段代码大家都看得懂吧？应该面向接口的对象编程，而不是面向实现，这也是软件设计模式的原则，正确的做法应该是。

Interface interface = new InterfaceImpl();

日志框架里面也是如此，上面也说了，日志有门面接口，有具体实现的实现框架，所以大家不要面向实现编程。

5. 没有输出全部错误信息

看以下代码，这样不会记录详细的堆栈异常信息，只会记录错误基本描述信息，不利于排查问题。

try {
    // ...
} catch (Exception e) {
    // 错误
    LOG.error('XX 发生异常', e.getMessage());
 
    // 正确
    LOG.error('XX 发生异常', e);
}

6. 不要使用错误的日志级别

曾经在线上定位一个问题，同事自信地和我说：明明输出了日志啊，为什么找不到…，后来我去看了下他的代码，是这样的：

try {
    // ...
} catch (Exception e) {
    // 错误
    LOG.info("XX 发生异常...", e);
}

大家看出了什么问题吗？用 info 记录 error 日志，日志输出到了 info 日志文件中了，同事拼命地在 error 错误日志文件里面找怎么能找到呢？

7. 不要在千层循环中打印日志

这个是什么意思，如果你的框架使用了性能不高的 Log4j 框架，那就不要在上千个 for循环中打印日志，这样可能会拖垮你的应用程序，如果你的程序响应时间变慢，那要考虑是不是日志打印的过多了。

for(int i=0; i<2000; i++){
    //错误
    LOG.info("XX");
}

最好的办法是在循环中记录要点，在循环外面总结打印出来。

8. 禁止在线上环境开启 debug

这是最后一点，也是最重要的一点。

一是因为项目本身 debug 日志太多，二是各种框架中也大量使用 debug 的日志，线上开启 debug 不久就会打满磁盘，影响业务系统的正常运行。

ps：Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml）

java常用日志框架及关联

Log4j 2与Log4j 1发生了很大的变化，Log4j 2不兼容Log4j 1。

  • Commons Logging和Slf4j是日志门面(门面模式是软件工程中常用的一种软件设计模式，也被称为正面模式、外观模式。它为子系统中的一组接口提供一个统一的高层接口，使得子系统更容易使用)。

  • Log4j和Logback则是具体的日志实现方案。可以简单的理解为接口与接口的实现，调用者只需要关注接口而无需关注具体的实现，做到解耦。

  • 比较常用的组合使用方式是Slf4j与Logback组合使用，Commons Logging与Log4j组合使用。

  • Logback必须配合Slf4j使用。由于Logback和Slf4j是同一个作者，其兼容性不言而喻。

Commons Logging与Slf4j实现机制对比

Commons Logging实现机制

Commons Logging是通过动态查找机制，在程序运行时，使用自己的ClassLoader寻找和载入本地具体的实现。详细策略可以查看commons-logging-*.jar包中的org.apache.commons.logging.impl.LogFactoryImpl.java文件。由于Osgi不同的插件使用独立的ClassLoader，Osgi的这种机制保证了插件互相独立, 其机制限制了Commons Logging在Osgi中的正常使用。

Slf4j实现机制

Slf4j在编译期间，静态绑定本地的Log库，因此可以在Osgi中正常使用。它是通过查找类路径下org.slf4j.impl.StaticLoggerBinder，然后在StaticLoggerBinder中进行绑定。

项目中选择日志框架选择

如果是在一个新的项目中建议使用Slf4j与Logback组合，这样有如下的几个优点。

  1. Slf4j实现机制决定Slf4j限制较少，使用范围更广。由于Slf4j在编译期间，静态绑定本地的LOG库使得通用性要比Commons
    Logging要好。

  2. Logback拥有更好的性能。Logback声称：某些关键操作，比如判定是否记录一条日志语句的操作，其性能得到了显著的提高。这个操作在Logback中需要3纳秒，而在Log4J中则需要30纳秒。LogBack创建记录器（logger）的速度也更快：13毫秒，而在Log4J中需要23毫秒。更重要的是，它获取已存在的记录器只需94纳秒，而Log4J需要2234纳秒，时间减少到了1/23。跟JUL相比的性能提高也是显著的。

  3. Logback文档免费。Logback的所有文档是全面免费提供的，不象Log4J那样只提供部分免费文档而需要用户去购买付费文档。

  4. Commons Logging开销更高`

 在使Commons Logging时为了减少构建日志信息的开销，通常的做法是
if(log.isDebugEnabled()){
  log.debug("User name： " +
    user.getName() + " buy goods id ：" + good.getId());
}
在Slf4j阵营，你只需这么做：
log.debug("User name：{} ,buy goods id ：{}", user.getName(),good.getId());
 也就是说，Slf4j把构建日志的开销放在了它确认需要显示这条日志之后，减少内存和Cup的开销，使用占位符号，代码也更为简洁
Emma0o
关注
专栏目录
java 日志查看_Java日志
weixin_30082367的博客
02-12 3092
日志对于一个系统来说非常重要，查找异常信息、分析系统运行情况等都需要用到日志。所以无论是JDK还是第三方都提供了关于日志的相关工具，本文分别介绍以下几种工具，以及各种工具间的整合、原理。JDK的java.util.logging包第三方日志工具(commons-logging/slf4j，log4j/logback)JDK的java.util.logging包JDK1.4引入了java.util....
java输出日志_Java日志打印方法
weixin_35650074的博客
02-12 7166
一、使用log4j打印日志1. 下载log4j.jar和commons-logging.jar。2.将准备好的两个jar包放到项目的lib包中(添加到项目的build path中)。方法：右键单击项目→选择“属性”→JavaBuild Path→Add External JARs。3.在src路径下创建一个log4j.properties文件。创建方法：右键单击src→New→File，输入文...
java 异常与记录日志
qq_38472465的博客
07-16 107
java 异常与记录日志
快来 GET java代码日志的正确打印姿势！
java3456的博客
06-30 244
使用slf4j 1.使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一 2.实现方式统一使用: Logback框架 打日志的正确方式 什么时候应该打日志 当你遇到问题的时候，只能通过debug功能来确定问题，你应该考虑打日志，良好的系统，是可以通过日志进行问题定为的。 当你碰到if…else 或者 switch这样的分支时，要在分支的首行打印日志，用来确定进入了哪个分支 经常以功能为核心进行开发，你应该在提交代码前，可以确定通过日志可以看到整个流程 基本格式 必须使用参数化信息的方式
Java日志详解
刘皇叔说Java的博客
03-29 5197
日志的定义：程序执行过程中，记录程序运行的情况的信息日志的作用：Log日志，主要用于记录程序运行的情况，以便于程序在部署之后的排错调试等，也有利于将这些信息进行持久化（如果不将日志信息保存到文件或数据库，则信息便会丢失）。
Java日志系统
X..RH
11-19 2845
常见的日志框架 JUL 基本组件 用户使用Logger来进行日志的记录，Logger可以持有多个处理器Handler (日志的记录使用的是Logger，日志的输出使用的是Handler) 1.自定以日志级别时，记录器和处理器同时设置才生效 2.handler可以时consleHandler和fileHandler，输出到控制台和文件中 3.日志输出的格式可以simpleFormatter设置（logger.addHandler,handler.setFormatter） 4.单例获得Logger logg
java日志规范
dzl84394的专栏
10-13 1709
日志规范
java日志框架之Log4j
从基础到源码解析的学习记录
09-23 3541
Log4j是Apache的一个开源项目可以控制日志信息输出到控制台文件、甚至是数据库中可以控制每一条日志的输出格式通过一个配置文件来灵活地进行配置，而不需要修改应用的代码主要由Loggers (日志记录器)、Appenders（输出控制器）和 Layout（日志格式化器）组成Loggers：控制日志的输出级别与日志是否输出Appenders：指定日志的输出方式（输出到控制台、文件等）Layout：控制日志信息的输出格式；源码默认从类路径找。
Java日志体系详解
lixinkuan的博客
01-30 2596
一、日志框架的分类 1.1、门面型日志框架： JCL：Apache基金会所属的项目，是一套Java日志接口，之前叫Jakarta Commons Logging，后更名为Commons Logging SLF4J：是一套简易Java日志门面，本身并无日志的实现。（Simple Logging Facade for Java，缩写Slf4j） 1.2、记录型日志框架: JUL：JDK中的日志...
浅谈java日志格式化
08-26
浅谈Java日志格式化 在软件开发中，日志是一个非常重要的数据，特别是在程序发生异常时，日志可以提供非常有价值的信息。但是，并不是打印的日志越多越好，我们需要的是有用的日志。下面我们来讨论一下Java日志格式...
简单了解Java日志脱敏框架sensitive
08-25
Java日志脱敏框架Sensitive是基于Java注解的日志脱敏工具，旨在解决项目开发过程中的日志脱敏问题。该框架提供了基于注解的方式来实现日志脱敏，内置了常见的脱敏方式，并且允许用户根据自己的实际需要自定义脱敏...
java 日志的数据脱敏的实现方法
08-26
Java日志数据脱敏是为了确保在记录日志时，敏感信息不会被泄露，从而保护用户隐私和企业数据安全。在本文中，我们将探讨如何在Java应用程序中实现这一目标。 首先，理解数据脱敏的重要性至关重要。在处理包含敏感...
efk7.13搜集java日志-filebeat配置详解
06-29
efk7.13搜集java日志—filebeat配置详解笔记总结
java日志文件过滤
08-09
总的来说，这个“java日志文件过滤”项目提供了一个便捷的工具，帮助开发者快速处理和分析日志数据，提高了问题排查和系统监控的效率。通过学习和理解这个项目，你可以深化对Java日志处理、文件I/O和条件过滤等技术...
【优化流量】基于matlab遗传算法GA求解OD流量优化问题【含Matlab源码 9159期】.mp4
最新发布
11-15
Matlab领域上传的视频均有对应的完整代码，皆可运行，亲测可用，适合小白； 1、代码压缩包内容 主函数：main.m； 调用函数：其他m文件；无需运行 运行结果效果图； 2、代码运行版本 Matlab 2019b；若运行有误，根据提示修改；若不会，私信博主； 3、运行操作步骤 步骤一：将所有文件放到Matlab的当前文件夹中； 步骤二：双击打开main.m文件； 步骤三：点击运行，等程序运行完得到结果； 4、仿真咨询 如需其他服务，可私信博主； 4.1 博客或资源的完整代码提供 4.2 期刊或参考文献复现 4.3 Matlab程序定制 4.4 科研合作
基于深度学习YOLOv9实现道路红绿灯行人车辆(8类)识别检测系统python源码+详细教程+模型+数据集+评估指标曲线.zip
11-15
【使用教程】 一、环境配置 1、建议下载anaconda和pycharm 在anaconda中配置好环境，然后直接导入到pycharm中，在pycharm中运行项目 anaconda和pycharm安装及环境配置参考网上博客，有很多博主介绍 2、在anacodna中安装requirements.txt中的软件包 命令为：pip install -r requirements.txt 或者改成清华源后再执行以上命令，这样安装要快一些 软件包都安装成功后才算成功 3、安装好软件包后，把anaconda中对应的python导入到pycharm中即可（不难，参考网上博客） 二、环境配置好后，开始训练（也可以训练自己数据集） 1、数据集准备 需要准备yolo格式的目标检测数据集，如果不清楚yolo数据集格式，或者有其他数据训练需求，请看博主yolo格式各种数据集集合链接：https://blog.csdn.net/DeepLearning_/article/details/127276492 更多详情介绍，见资源内的项目说明
(源码)基于SpringBoot和Vue的学生作业互评系统.zip
11-15
# 基于Spring Boot和Vue的学生作业互评系统 ## 项目简介 本项目是一个基于Spring Boot和Vue框架开发的学生作业互评系统。系统主要功能包括学生作业的提交、教师作业的布置、作业的批改与评分、以及学生之间的作业互评。通过该系统，教师可以方便地管理课程和作业，学生可以在线提交作业并参与互评，从而提高作业质量和学习效果。 ## 项目的主要特性和功能 1. 用户管理 支持学生、教师和管理员三种角色的用户管理。 提供用户注册、登录、密码修改等功能。 2. 课程管理 教师可以创建和管理课程，学生可以选课。 支持课程信息的查看和编辑。 3. 作业管理 教师可以布置作业，设置作业的截止日期和评分标准。 学生可以在线提交作业，查看作业提交状态。 4. 作业批改与评分 教师可以对学生提交的作业进行批改和评分。 学生可以查看自己的作业评分和教师的评语。
PHP学生成绩查询(源代码+论文).rar
11-15
PHP学生成绩查询(源代码+论文)
Java日志技术资料与实践教程
资源摘要信息: "Java日志.zip" Java日志技术是Java开发中用于记录、监控和分析应用程序运行状态的重要组成部分。在Java生态系统中，存在多种日志框架，它们提供了灵活且强大的日志记录能力。了解和掌握这些日志技术...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值