日志门面和日志框架(日志实现框架log4j2)

秒速五厘米 2023-10-07 22:41 17阅读 0赞

## 一、log4j2简介 ##

Apache Log4j 2是对Log4j的升级，是最优秀的java日志框架。

## 二、log4j2特征 ##

**性能提升**：Log4j2包含基于LMAX Disruptor库的下一代异步记录器。在多线程场景中，异步记录器的吞吐量比log4j和logback高18倍，延迟低。

**自动重新加载配置**：与logback一样，log4j2可以在修改时自动重新加载其配置。与logback不同，它会在重新配置时不会丢失日志事件。

**高级过滤**：与logback一样，log4j2支持基于log事件中的上下文数据，标记，正则表达式和其他组件进行过滤。此外，过滤器还可以与记录器关联。与logback不同，logback可以在任何这些情况下使用通用的Filter类。

**插件架构**：log4j2使用插件模式配置组件。因此，无需编写代码来创建和配置Appender，layout，pattern Converter等。在配置了的情况下，log4j2自动识别插件并使用它们。

**无垃圾机制**：在稳定日志记录期间，log4j2在独立应用程序中是无垃圾的，在web应用程序中是低垃圾。这减少了垃圾收集器的压力，并且可以提供更好的响应性能。

总之：SLF4j+Log4j2的组合，是市场上最强大的日志功能实现方式。

## 三、slf4j集成log4j2 ##

### 1. slf4j集成log4j2步骤共4步 ###

1.  导入slf4j日志门面
2.  导入log4j2的适配器
3.  导入log4j2日志门面
4.  导入log4j2日志实现

<dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>slf4j-api</artifactId>
          <version>1.7.32</version>
    </dependency>
    
          <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-slf4j-impl</artifactId>
          <version>2.14.1</version>
    </dependency>
    <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-api</artifactId>
          <version>2.14.1</version>
    </dependency>
    
    <dependency>
          <groupId>org.apache.logging.log4j</groupId>
          <artifactId>log4j-core</artifactId>
          <version>2.14.1</version>
    </dependency>

### 2. 集成原理 ###

slf4j门面调用的是log4j2的门面，再由log4j2的门面调用log4j2的实现。

## 四、log4j2配置文件 ##

log4j2是参考logback创作出来的，所以配置文件也是使用xml。log4j2同样是默认加载类路径(resources)下的log4j2.xml文件中的配置。

<?xml version="1.0" encoding="UTF-8" ?>
    <configuration>
        
        <Appenders>
            <Console name="consoleAppender" target="SYSTEM_ERR"></Console>
        </Appenders>
    
        
        <Loggers>
            
            <Root level="info">
                <AppenderRef ref="consoleAppender"></AppenderRef>
            </Root>
        </Loggers>
    </configuration>

## 五、日志文件输出 ##

## 六、日志文件的拆分和压缩 ##

<?xml version="1.0" encoding="UTF-8" ?>
    <configuration>
    
        
        <properties>
            <property name="logDir">F:\\project\\springboot_log</property>
            <property name="pattern" value="[%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} %c %M %L  %thread %m%n"></property>
        </properties>
    
        
        <Appenders>
            
            <RollingFile name="rollingFile" fileName="${logDir}\\rolllog.log"
                         filePattern="${logDir}/$${date:yyyy-MM-dd}/rolllog-%d{yyyy-MM-dd-HH-mm}-%i.log">
                
                <PatternLayout pattern="${pattern}"></PatternLayout>
                <Policies>
                    
                    <OnStartupTriggeringPolicy></OnStartupTriggeringPolicy>
                    
                    <SizeBasedTriggeringPolicy size="1KB"></SizeBasedTriggeringPolicy>
                    
                    <TimeBasedTriggeringPolicy></TimeBasedTriggeringPolicy>
                </Policies>
                
                <DefaultRolloverStrategy max="30"></DefaultRolloverStrategy>
            </RollingFile>
        </Appenders>
    
        
        <Loggers>
            
            <Root level="info">
                <AppenderRef ref="rollingFile"></AppenderRef>
            </Root>
        </Loggers>
    </configuration>

## 七、异步日志 ##

log4j2提供了两种实现日志的方式，一个是通过AsyncAppender,一个是通过AsyncLogger,分别对应前面的Appender组件和Logger组件。

## 1. AsyncAppender方式 ##

AsyncAppender方式是通过引用别的Appender来实现，当有日志事件到达时，会开启另外一个线程来处理它们。需要注意的是，如果在Appender的时候出现异常，对应用来说是无法感知的。

AysncAppender应该在它引用的Appender之后配置，默认使用java.util.concurrent.ArrayBlockingQueue实现而不需要其它外部的类库。当使用此Appender的时候，在多线程的环境下需要注意，阻塞队列容易受到锁争用的影响，这可能会对性能产生影响。这时候，我们应该考虑使用无锁的异步记录器(AsyncLogger).

### 2. AsyncLogger方式(最推荐混合异步) ###

AsyncLogger才是log4j2实现异步最重要的功能体现，也是官方推荐的异步方式。

它可以使得调用Logger.log返回的更快。可以有两种选择：全局异步和混合异步。

**全局异步**：所有的日志都异步的记录，在配置文件上不用做任何改动，只需要在jvm启动的时候增加一个参数即可实现。

**混合异步**：可以在应用中同时使用同步日志和异步日志，这使得日志的配置方式更加灵活。虽然Log4j2提供一套异常处理机制，可以覆盖大部分状态，但是还是有一小部分的特殊情况是无法完全处理的，比如我们如果是记录审计日志(特殊情况之一)，那么官方就推荐使用同步日志的方式，二对于其他的一些仅仅是记录一个程序日志的地方，使用异步日志将大幅提升性能，减少应用本身的影响。

混合异步的方式需要通过修改配置文件来实现，使用AsyncLogger标记配置

## 八、AsyncAppender方式异步日志 ##

### 1. 实现步骤 ###

1. 添加异步日志的依赖

<dependency>
          <groupId>com.lmax</groupId>
          <artifactId>disruptor</artifactId>
          <version>3.4.3</version>
    </dependency>

2. 在Appender标签中，对于异步进行配置，使用Async标签

<?xml version="1.0" encoding="UTF-8" ?>
    <configuration>
        
        <Appenders>
            
            <Console name="consoleAppender" target="SYSTEM_OUT"></Console>
            
            <Async name="myAsync">
                
                <AppenderRef ref="consoleAppender"></AppenderRef>
            </Async>
    
        </Appenders>
    
        
        <Loggers>
            
            <Root level="info">
                <AppenderRef ref="myAsync"></AppenderRef>
            </Root>
        </Loggers>
    </configuration>

3. rootlogger引用Async，如上图

## 九、AsyncLogger-全局异步日志 ##

**全局异步**：所有的日志都是异步的日志记录，在配置文件上不用做任何的改动。只需要在类路径resources下添加一个properties属性文件，做异步配置即可。

文件要求是：文件名必须为log4j2.component.properties

文件内容为键值对：Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector

## 十、AsyncLogger-混合异步日志(推荐使用) ##

混合异步：可以在应用中同时使用同步日志和异步日志，这使得日志的配置和输出会更加的灵活。

需求：假设我们有自定义的logger -- com.atredhorse,让自定义的Logger是异步的。让rootLogger是同步的,也即其他包下是同步的。

<Loggers>
            
            
            <AsyncLogger name="com.atredhorse" level="debug"
                    includeLocation="false" additivity="false">
                <AppenderRef ref="consoleAppender"></AppenderRef>
            </AsyncLogger>
            
            <Root level="info">
                <AppenderRef ref="consoleAppender"></AppenderRef>
            </Root>
        </Loggers>

总之：如果使用异步日志，AsyncAppender、AsyncLogger不要同时出现，没有这个需求，效果也不会叠加。如果同时出现，那么效率会以AsyncAppender为主。

AsyncLogger的全局异步和混合异步也不要同时出现，没有这个需求，效果也不会叠加。