开发Java应用时如何用好Log

简介: 开发Java应用时如何用好Log




本篇文章,主要介绍应用如何正确使用日志系统,帮助用户从依赖、输出、清理、问题排查、报警等各方面全面掌握。


日志相关的包的种类及使用


 日志系统与日志框架


每个应用为了方便排查问题都要输出日志,大家经常使用:log4j、logback等。我们先搞明白日志系统的整套体系是如何运作的。


  • 日志系统


直接负责打印输出日志,提供完整的日志输出能力:

  1. JUL
  • java.util.logging.*,java自带的日志系统简称JUL。目前除了Java自身代码很少被生态系统类库使用。
  1. Log4j
  • https://logging.apache.org/,目前已经发展到2.x版本(2.x版本有超越logback的趋势),早期的1.x版本非常成功。开创日志系统模型(Logger\Appender\Level等概念)并被各种日志框架采用,且一直沿用至今
  • log4j可直接使用,也可配合日志框架一起使用
  1. Logback
  • http://logback.qos.ch/,Log4j作者的另一个作品,(比Log4j1.x新,Log4j2.x旧)吸取多年经验教训重新设计的一套日志系统,使用更方便、功能更强、性能更好。
  • logback不能单独使用,需配置日志框架SLF4J一起使用


  • 日志框架


为了克服各种日志系统标准混乱,诞生了日志框架,日志框架不提供日志输出的功能,它定义标准,提供标准接口API,日志框架+日志系统=输出日志。写代码过程中使用日志框架的好处:编码的时候调用日志框架API,部署的时候可根据不同的环境在多种日志系统中随意切换。

  1. JCL
  1. SLF4J
  • https://www.slf4j.org/,Log4j作者推出,这几年最流行的日志框架,特别是配合Logback使用。
  • 当然也可以配合log4j使用

目前在Java生态趋势主要是使用:SLF4J+Logback组合。


 如何正确组合使用日志系统和日志框架


上一节我们介绍了日志框架和日志系统,因为存在多套,所以:如何在系统中正确使用是我们的重点。


  • 日志系统之间互斥


  1. 日志框架:JCL和JCL-over-SLF4J桥接包直接互斥
  2. 日志系统:logback和slf4j-log4j12互斥,不能共存


我们大概可枚举出如下几种组合:

类型

说明

slf4j+logback

目前最主流的玩法,除了依赖slf4j、logback,还需要考虑把二方库和三方库内部使用的jcl和log4j桥接到slf4j上来,并避免依赖反桥接的包

slf4j+log4j

不推荐。需要把slf4j桥接到log4j,并把jul桥接到slf4j

jcl+log4j

不推荐。这需要你直接使用jcl接口来编码,并把把slf4j桥接到log4j

log4j

不推荐。直接依赖日志系统


  • slf4j+logback组合


下面列出一个正确的slf4j+logback依赖,这个环节很重要,很多应用因为依赖搞不清楚经常出现日志丢失问题:


<properties>
  <slf4j.version>${xxxx}</slf4j.version>
  <logback.version>${yyyyy}</logback.version>
</properties>


<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>commons-logging</groupId>
      <artifactId>commons-logging</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>com.alibaba.external</groupId>
      <artifactId>jakarta.commons.logging</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba.external</groupId>
        <artifactId>org.slf4j.slf4j-log4j12</artifactId>
        <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-nop</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-simple</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba.external</groupId>
        <artifactId>org.slf4j.slf4j-simple</artifactId>
        <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-ext</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jcl-over-slf4j</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jul-to-slf4j</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>log4j-over-slf4j</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-core</artifactId>
      <version>${logback.version}</version>
    </dependency>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>${logback.version}</version>
    </dependency>
  </dependencies>
</dependencyManagement>



<dependencies>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-ext</artifactId>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jul-to-slf4j</artifactId>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
  </dependency>
  <dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
  </dependency>
  <dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
  </dependency>
</dependencies>


  1. 先将依赖全部写在<dependencyManagement>节点中,这样可影响间接依赖,如果只当初的使用dependencies节点,只会应用直接依赖
  2. 使用999-not-exist这样的版本:欺骗maven,直接依赖一个空包占位,这样Maven就不会再去依赖相同坐标的真实依赖,间接起到排包的作用


 logback配置


  • 文件名和位置


应用类型

文件名

文件配置(启动模块)

说明

spring-boot

logback-spring.xml

src/main/resources/

支持从spring-boot配置文件中直接读取property

普通java应用

logback.xml

src/main/resources/


WAR应用

logback.xml

src/main/webapp/WEB-INF/

需要依赖slf4j-ext,然后在web.xml里使用监听器挂载这个文件

单元测试和集成测试

logback-test.xml

src/test/resources/



  • 配置样例



<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <property name="APP_NAME" value="demo1" />
  <property name="LOG_PATH" value="${user.home}/${APP_NAME}/logs" />
  <property name="LOG_FILE" value="${LOG_PATH}/application.log" />
  <property name="LOG.PATTERN" value="%d %-5level %X{EAGLEEYE_TRACE_ID}  %logger{5}[%L] - %msg%n"/>
  <property name="LOG.CHARSET" value="UTF-8"/>

  <appender name="APPLICATION"
    class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${LOG_FILE}</file>
    <encoder>
      <pattern>${LOG.PATTERN}</pattern>
      <charset>${LOG.CHARSET}</charset>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      <fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
      <maxHistory>7</maxHistory>
      <maxFileSize>50MB</maxFileSize>
      <totalSizeCap>20GB</totalSizeCap>
    </rollingPolicy>
  </appender>

  <logger name="org.springframework" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="com.ibatis" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="org.mybatis" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="java.sql" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="sqlMonitor" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="com.taobao" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="com.alibaba" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="com.alibaba.example.demo" additivity="false">
    <level value="info"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <root level="error">
    <appender-ref ref="APPLICATION" />
  </root>
</configuration>


  1. 使用SizeAndTimeBasedRollingPolicy使日志可以根据大小和日期进行滚动
  2. 日志编码请使用UTF-8
  3. 请正确使用日志级别,不要统统输出error


  • 日志级别根据不同环境可配


  1. 如果是Pandora-boot或spring-boot可以直接在配置里使用property读取application.properties,application.properties在不同环境下使用-Dspring.profiles.active进行切换
  2. 普通应用和WAR应用:请使用autoconfig-maven-plugin插件


一些实用的日志技巧


 动态修改日志级别


场景:应用在运行中,默认日志配置的打印级别是error,但是我现在想针对某个包或者某个类输出下info日志。

使用Arthas:https://arthas.aliyun.com/doc/logger.html,该工具提供了动态修改日志的能力。


 追加业务信息到日志中,并格式化输出:追加MDC信息,方便排查问题


这是日志系统的一个扩容能力,可以把一些额外的信息输出到日志里,只需要在MDC上下文中写入kv,https://logback.qos.ch/manual/mdc.html


例如:


public static void main(String[] args) {
    //代码里使用MDC.put写入key为traceId的值
    //在logback.xml里就可以使用%X{traceId}进行输出
    MDC.put("traceId", UUID.randomUUID().toString().replace("-", ""));
}


 配置定时日志磁盘占用清理


一定要配置合理的日志清理策略,避免磁盘被打爆,可借助日志框架自身能力,或借助可用的日志清理系统(如果有)

在logback.xml配置中,可通过配置带有清理作用的rollingPolicy来完成日志定时清理和滚动,例如:SizeAndTimeBasedRollingPolicy



这段配置的含义是:最多保留7天,单个文件最大50MB,该日志(包括滚动的)最大只能保存20GB。


 不要封装一个日志Util,而应该直接使用日志框架进行输出


反例:LogUtil.log("通过封装的日志工具打印日志");

正例:log.info("直接使用日志框架的api进行日志输出");

理由:在日志输出的时候,日志系统会打印日志产生的原始位置:比如哪个包的哪个类,以及第几行(如果配置了[%L]),如果你使用LogUtil等自己封装的工具,所有的日志输出打印的位置都是LogUtil的,这样不便于做日志问题定位


系统日志打不出来或者丢日志排查思路

目前没有现成的工具帮你一键做好这个事情,下面给出一个排查思路

  1. 先明确该系统到底使用的是什么日志框架+日志系统组合,这个很重要,必须搞清是何种组合才可有针对性的处理后续步骤
  2. 如果是slf4j+logback组合,则可根据第一章列出的maven依赖进行排包处理,优先保证依赖的包没有错误,90%的情况下都是包依赖混乱导致的日志丢失
  3. 排查自己的logback配置文件是否放在正确的路径下、文件名是否正确,配置文件位置不对也会导致日志输出的不对甚至丢失
  4. 检查logback配置文件内部每个logger及其level配置是否正确,避免自己期望打印info,却配置了error


总结

日志系统的正确使用,对于应用的日常维护和问题排查尤为重要,所谓:工欲善其事,必先利其器。本篇文章重点讲解了日志系统的结构和包如何正确依赖,这是很多同学最容易犯的错误,需要格外注意并认真阅读,只有正确理解其中的含义才可以更好的使用日志系统,在日常使用中大家要不断总结经验。


最后希望文章提供的内容能够在日常开发和维护中为大家提供到切实的帮助。


团队介绍


物流技术团队是服务淘天物流部及零售行业的产技团队,一直深耕在物流及供应链的数字化协同与运营领域:为零售业务提供灵活多样的经营模式管理方案及可以快速适配市场变化的经营策略数宇化管理工具;为商家提供高效低成本的物流及供应链解决方案,加快资金效率,提升协同效率;为消费者提供即时便捷的购物体验。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
2天前
|
IDE Java 数据库连接
使用 Java 进行桌面应用开发
【4月更文挑战第19天】Java 是一款广泛应用于企业级、网络和桌面应用开发的编程语言。其跨平台特性使Java程序能在不同操作系统上运行,而JDK提供了开发所需工具和库。使用Swing等GUI库构建用户界面,结合JDBC进行数据库操作,Socket实现网络通信。虽然面临性能和用户体验的挑战,但通过优化和选用合适的IDE,Java仍能开发出高效稳定的桌面应用。
|
3天前
|
前端开发 Java Go
开发语言详解(python、java、Go(Golong)。。。。)
开发语言详解(python、java、Go(Golong)。。。。)
|
3天前
|
人工智能 前端开发 Java
Java语言开发的AI智慧导诊系统源码springboot+redis 3D互联网智导诊系统源码
智慧导诊解决盲目就诊问题,减轻分诊工作压力。降低挂错号比例,优化就诊流程,有效提高线上线下医疗机构接诊效率。可通过人体画像选择症状部位,了解对应病症信息和推荐就医科室。
27 10
|
3天前
|
Java 关系型数据库 MySQL
一套java+ spring boot与vue+ mysql技术开发的UWB高精度工厂人员定位全套系统源码有应用案例
UWB (ULTRA WIDE BAND, UWB) 技术是一种无线载波通讯技术,它不采用正弦载波,而是利用纳秒级的非正弦波窄脉冲传输数据,因此其所占的频谱范围很宽。一套UWB精确定位系统,最高定位精度可达10cm,具有高精度,高动态,高容量,低功耗的应用。
一套java+ spring boot与vue+ mysql技术开发的UWB高精度工厂人员定位全套系统源码有应用案例
|
3天前
|
设计模式 算法 Java
Java中的设计模式及其应用
【4月更文挑战第18天】本文介绍了Java设计模式的重要性及分类,包括创建型、结构型和行为型模式。创建型模式如单例、工厂方法用于对象创建;结构型模式如适配器、组合关注对象组合;行为型模式如策略、观察者关注对象交互。文中还举例说明了单例模式在配置管理器中的应用,工厂方法在图形编辑器中的使用,以及策略模式在电商折扣计算中的实践。设计模式能提升代码可读性、可维护性和可扩展性,是Java开发者的必备知识。
|
3天前
|
安全 Java API
函数式编程在Java中的应用
【4月更文挑战第18天】本文介绍了函数式编程的核心概念,包括不可变性、纯函数、高阶函数和函数组合,并展示了Java 8如何通过Lambda表达式、Stream API、Optional类和函数式接口支持函数式编程。通过实际应用案例,阐述了函数式编程在集合处理、并发编程和错误处理中的应用。结论指出,函数式编程能提升Java代码的质量和可维护性,随着Java语言的演进,函数式特性将更加丰富。
|
4天前
|
Java API 数据库
深入解析:使用JPA进行Java对象关系映射的实践与应用
【4月更文挑战第17天】Java Persistence API (JPA) 是Java EE中的ORM规范,简化数据库操作,让开发者以面向对象方式处理数据,提高效率和代码可读性。它定义了Java对象与数据库表的映射,通过@Entity等注解标记实体类,如User类映射到users表。JPA提供持久化上下文和EntityManager,管理对象生命周期,支持Criteria API和JPQL进行数据库查询。同时,JPA包含事务管理功能,保证数据一致性。使用JPA能降低开发复杂性,但需根据项目需求灵活应用,结合框架如Spring Data JPA,进一步提升开发便捷性。
|
2天前
|
安全 Java
深入理解 Java 多线程和并发工具类
【4月更文挑战第19天】本文探讨了Java多线程和并发工具类在实现高性能应用程序中的关键作用。通过继承`Thread`或实现`Runnable`创建线程,利用`Executors`管理线程池,以及使用`Semaphore`、`CountDownLatch`和`CyclicBarrier`进行线程同步。保证线程安全、实现线程协作和性能调优(如设置线程池大小、避免不必要同步)是重要环节。理解并恰当运用这些工具能提升程序效率和可靠性。
|
3天前
|
安全 Java
java多线程(一)(火车售票)
java多线程(一)(火车售票)
|
3天前
|
安全 Java 调度
Java并发编程:深入理解线程与锁
【4月更文挑战第18天】本文探讨了Java中的线程和锁机制,包括线程的创建(通过Thread类、Runnable接口或Callable/Future)及其生命周期。Java提供多种锁机制,如`synchronized`关键字、ReentrantLock和ReadWriteLock,以确保并发访问共享资源的安全。此外,文章还介绍了高级并发工具,如Semaphore(控制并发线程数)、CountDownLatch(线程间等待)和CyclicBarrier(同步多个线程)。掌握这些知识对于编写高效、正确的并发程序至关重要。