Java 日志框架详解分析

虾米哥 阅读:191 2021-03-31 13:28:57 评论:0

常用日志框架

  • java.util.logging:是 JDK 在 1.4 版本中引入的 Java 原生日志框架
  • Log4j:Apache 的一个开源项目,可以控制日志信息输送的目的地是控制台、文件、GUI 组件等,可以控制每一条日志的输出格式,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。虽然已经停止维护了,但目前绝大部分企业都是用的 log4j。
  • LogBack:是 Log4j 的一个改良版本
  • Log4j2:Log4j2 已经不仅仅是 Log4j 的一个升级版本了,它从头到尾都被重写

日志门面 slf4j

上述介绍的是一些日志框架的实现,这里我们需要用日志门面来解决系统与日志实现框架的耦合性。SLF4J,即简单日志门面(Simple Logging Facade for Java),它不是一个真正的日志实现,而是一个抽象层( abstraction layer),它允许你在后台使用任意一个日志实现。

 

前面介绍的几种日志框架一样,每一种日志框架都有自己单独的 API,要使用对应的框架就要使用其对应的 API,这就大大的增加应用程序代码对于日志框架的耦合性。

使用了 slf4j 后,对于应用程序来说,无论底层的日志框架如何变,应用程序不需要修改任意一行代码,就可以直接上线了。

为什么选用 log4j2

相比与其他的日志系统,log4j2 丢数据这种情况少;disruptor 技术,在多线程环境下,性能高于 logback 等 10 倍以上;利用 jdk1.5 并发的特性,减少了死锁的发生;

在这列举一下一些网上其他博文中对它们的性能评测:

 

  • 可以看到在同步日志模式下,Logback 的性能是最糟糕的.
  • log4j2 的性能无论在同步日志模式还是异步日志模式下都是最佳的.

 

log4j2 优越的性能其原因在于 log4j2 使用了 LMAX, 一个无锁的线程间通信库代替了,logback 和 log4j 之前的队列。并发性能大大提升。

SpringBoot 集成log4j2 日志

spring boot支持的日志框架有,Logback,Log4j2,Log4j和Java Util  Logging,默认使用的是Logback日志框架,如果要使用别的日志框架,必须让spring boot项目不使用Logback。

第一步:移除SpringBoot 依赖的Logback 日志框架,添加log4j2 框架的jar 包依赖

       <dependency> 
			<groupId>org.springframework.boot</groupId> 
			<artifactId>spring-boot-starter</artifactId> 
			<!-- 排除自带的Logback日志工具依赖,为了项目使用Log4j2日志打印工具 --> 
			<exclusions> 
			    <exclusion> 
				     <groupId>org.springframework.boot</groupId> 
				     <artifactId>spring-boot-starter-logging</artifactId> 
			    </exclusion> 
			</exclusions> 
		</dependency> 
        <!-- 导入log4j2依赖 --> 
        <dependency> 
            <groupId>org.springframework.boot</groupId> 
            <artifactId>spring-boot-starter-log4j2</artifactId> 
        </dependency> 
        <!-- end --> 
        <!-- log4j2支持异步日志,导入disruptor依赖,不需要支持异步日志,也可以去掉该依赖包 --> 
        <dependency> 
           <groupId>com.lmax</groupId> 
           <artifactId>disruptor</artifactId> 
           <version>${com.lmax.disruptor}</version> 
        </dependency> 
        <!-- end -->

第二步:配置log4j2 日志模块的配置文件:

在资源文件夹src/main/resources下添加log4j2.xml或者log4j2-spring.xml,启动后spring boot自动加载,配置文件的内容如下:

<?xml version="1.0" encoding="UTF-8"?> 
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE >ALL --> 
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出;可以设置成OFF(关闭)或Error(只输出错误信息)--> 
<!--monitorInterval:Log4j2能够自动检测修改配置文件和重新配置本身,设置间隔秒数--> 
<Configuration status="WARN" monitorInterval="30"> 
  
    <Properties> 
        <!-- 缺省配置(用于开发环境),配置日志文件输出目录和动态参数。其他环境需要在VM参数中指定; 
       “sys:”表示:如果VM参数中没指定这个变量值,则使用本文件中定义的缺省全局变量值 --> 
        <Property name="instance">spring-boot-log</Property> 
        <Property name="log.dir">D:\log\dev</Property> 
    </Properties> 
  
    <!-- 定义所有的appender --> 
    <Appenders> 
        <!--这个输出控制台的配置--> 
        <Console name="Console" target="SYSTEM_OUT"> 
            <!--输出日志的格式--> 
            <PatternLayout pattern="[%date{yyyy-MM-dd HH:mm:ss.SSS}][%thread][%level][%class][%line]:%message%n"/> 
        </Console> 
  
        <!-- info及以上级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档--> 
        <RollingRandomAccessFile name="infoLog" 
                                 fileName="${log.dir}/${instance}-info.log" 
                                 filePattern="${log.dir}/%d{yyyy-MM}/${instance}-info-%d{yyyy-MM-dd}-%i.log.gz" 
                                 append="true"> 
            <PatternLayout pattern="[%date{yyyy-MM-dd HH:mm:ss.SSS}][%thread][%level][%class][%line]:%message%n"/> 
  
            <!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)--> 
            <Filters> 
                <!-- onMatch="ACCEPT" 表示匹配该级别及以上 --> 
                <!-- onMatch="DENY" 表示不匹配该级别及以上--> 
                <!-- onMatch="NEUTRAL" 表示该级别及以上的,由下一个filter处理,如果当前是最后一个,则表示匹配该级别及以上--> 
                <!-- onMismatch="ACCEPT" 表示匹配该级别以下--> 
                <!-- onMismatch="NEUTRAL" 表示该级别及以下的,由下一个filter处理,如果当前是最后一个,则不匹配该级别以下的--> 
                <!-- onMismatch="DENY" 表示不匹配该级别以下的--> 
                <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="NEUTRAL"/> 
            </Filters> 
  
            <Policies> 
                <!-- 基于时间的滚动策略,interval属性用来指定多久滚动一次,默认是1 hour --> 
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/> 
                <!-- 基于指定文件大小的滚动策略,size属性用来定义每个日志文件的大小 --> 
                <SizeBasedTriggeringPolicy size="1MB"/> 
                <!-- DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的,创建新的(通过max属性) --> 
            </Policies> 
        </RollingRandomAccessFile> 
  
  
        <!-- warn级别的日志信息 --> 
        <RollingRandomAccessFile name="warnLog" 
                                 fileName="${log.dir}/${instance}-warn.log" 
                                 filePattern="${log.dir}/%d{yyyy-MM}/${instance}-warn-%d{yyyy-MM-dd}-%i.log.gz" 
                                 append="true"> 
            <Filters> 
                <!-- onMatch="ACCEPT" 表示匹配该级别及以上 --> 
                <!-- onMatch="DENY" 表示不匹配该级别及以上--> 
                <!-- onMatch="NEUTRAL" 表示该级别及以上的,由下一个filter处理,如果当前是最后一个,则表示匹配该级别及以上--> 
                <!-- onMismatch="ACCEPT" 表示匹配该级别以下--> 
                <!-- onMismatch="NEUTRAL" 表示该级别及以下的,由下一个filter处理,如果当前是最后一个,则不匹配该级别以下的--> 
                <!-- onMismatch="DENY" 表示不匹配该级别以下的--> 
                <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/> 
                <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/> 
            </Filters> 
  
            <PatternLayout pattern="[%date{yyyy-MM-dd HH:mm:ss.SSS}][%thread][%level][%class][%line]:%message%n"/> 
  
            <Policies> 
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/> 
                <SizeBasedTriggeringPolicy size="1MB"/> 
            </Policies> 
        </RollingRandomAccessFile> 
  
  
        <!-- error级别的日志信息 --> 
        <RollingRandomAccessFile name="errorLog" 
                                 fileName="${log.dir}/${instance}-error.log" 
                                 filePattern="${log.dir}/%d{yyyy-MM}/${instance}-error-%d{yyyy-MM-dd}-%i.log.gz" 
                                 append="true"> 
            <Filters> 
                <!-- onMatch="ACCEPT" 表示匹配该级别及以上 --> 
                <!-- onMatch="DENY" 表示不匹配该级别及以上--> 
                <!-- onMatch="NEUTRAL" 表示该级别及以上的,由下一个filter处理,如果当前是最后一个,则表示匹配该级别及以上--> 
                <!-- onMismatch="ACCEPT" 表示匹配该级别以下--> 
                <!-- onMismatch="NEUTRAL" 表示该级别及以下的,由下一个filter处理,如果当前是最后一个,则不匹配该级别以下的--> 
                <!-- onMismatch="DENY" 表示不匹配该级别以下的--> 
                <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/> 
            </Filters> 
  
            <PatternLayout pattern="[%date{yyyy-MM-dd HH:mm:ss.SSS}][%thread][%level][%class][%line]:%message%n"/> 
  
            <Policies> 
                <TimeBasedTriggeringPolicy interval="1" modulate="true"/> 
                <SizeBasedTriggeringPolicy size="1MB"/> 
            </Policies> 
        </RollingRandomAccessFile> 
    </Appenders> 
  
  
    <!-- 全局配置,默认所有的Logger都继承此配置 --> 
  
    <!-- 用来配置LoggerConfig,包含一个root logger和若干个普通logger。 
         additivity指定是否同时输出log到父类的appender,缺省为true。 
         一个Logger可以绑定多个不同的Appender。只有定义了logger并引入的appender,appender才会生效。 
    --> 
    <Loggers> 
        <!-- 第三方的软件日志级别 --> 
        <logger name="org.springframework" level="info" additivity="true"> 
            <AppenderRef ref="warnLog"/> 
            <AppenderRef ref="errorLog"/> 
        </logger> 
  
        <logger name="java.sql.PreparedStatement" level="debug" additivity="true"> 
            <AppenderRef ref="Console"/> 
        </logger> 
  
        <logger name="codex.terry.filter" level="debug" additivity="true"> 
            <AppenderRef ref="infoLog"/> 
            <AppenderRef ref="warnLog"/> 
            <AppenderRef ref="errorLog"/> 
        </logger> 
  
        <!-- root logger 配置 --> 
        <Root level="ALL" includeLocation="true"> 
            <AppenderRef ref="Console"/> 
        </Root> 
  
        <!-- AsyncRoot - 异步记录日志 - 需要LMAXDisruptor的支持 --> 
        <!-- 
        <AsyncRootlevel="info" additivity="false"> 
          <AppenderRef ref="Console"/> 
          <AppenderRef ref="infoLog"/> 
          <AppenderRef ref="errorLog"/> 
        </AsyncRoot> 
        --> 
    </Loggers> 
  
</Configuration>

注意:applicatiion.properties 配置读取log4j2 默认名称为log4j2.xml或者log4j2-spring.xml,也可以指定log4j2 读取其他日志配置文件,通过以下属性指定:logging.config=classpath:log4j2-dev.xml

 Log4j2 参数配置请参考:

声明

1.本站遵循行业规范,任何转载的稿件都会明确标注作者和来源;2.本站的原创文章,请转载时务必注明文章作者和来源,不尊重原创的行为我们将追究责任;3.作者投稿可能会经我们编辑修改或补充。

发表评论
搜索
排行榜
关注我们

一个IT知识分享的公众号