Java日志之Log4j2

Apache Log4j 2是Log4j的升级版，对Log4j的前身Log4j 1.x进行了重大改进，并提供了Logback中可用的许多改进，同时解决了Logback体系结构中的一些固有问题。

与Logback相似，Log4j2可以重新加载修改过的配置文件，但与Logback不同，它将在进行重新配置的同时不会丢失日志事件。

在Logback和Log4j1.x中，Appender的异常信息对程序不可见，而Log4j2的Appender可以配置异常信息渗入到应用程序中。

在稳态日志记录期间，Log4j 2在独立应用程序中是无垃圾的，而在Web应用程序中是低垃圾的。

Log4j的几个概念

Level-日志级别，不同的级别代表不同的重要程度，从高到低 OFF、FATAL、ERROR、WARN、INFO 、DEBUG、TRACE、ALL

Logger-日志记录器，在代码中通过LoggerFactory.getLogger(xxx.class)来获取logger，RootLogger是所有logger的父级

Appender-指定日志输出到哪里以及日志的滚动策略等，比如ConsoleAppender输出到控制台，FileAppender输出到文件，此外还有JMSAppender、HttpAppender、KafkaAppender、NoSQLAppender等

Layout-指定日志的输出格式，PatternLayout最常用，此外还有HTMLLayout、JSONLayout等

异步日志

同步情况下，日志打印代码和业务逻辑代码在同一线程中执行，即程序都是在打印完日志后再继续执行后面的业务逻辑代码，而异步日志则是另起一个线程专门打印日志，不阻塞后面业务代码的执行。

Log4j2中的异步日志实现方式有AsyncAppender和AsyncLogger两种：

1. AsyncLogger采用了高性能并发框架Disruptor，创建一个线程用于处理日志输出，需要另外引入DIsruptor依赖
2. AsyncAppender内部采用ArrayBlockingQueue，对每个AsyncAppender创建一个线程用于处理日志输出

配置文件

1. Log4j2可以在初始化时自动配置，并且可以和Logback一样定时检测配置文件修改并重新自动配置
2. 配置文件可以是Properties、YAML、JSON、XML格式，配置文件放在classpath下，并命名为log4j2.xml或log4j2或properties或log4j2.json或log4j2.yml

 常用配置详解：

<?xml version="1.0" encoding="UTF-8"?>
<!-- status指定log4j2内部事件输出到控制台日志的级别，monitorInterval指定每隔多少秒检测文件修改便于自动重新配置 -->
<Configuration status="info" monitorInterval="60" name="MyApp">
	
	<!-- 定义一些属性，类似局部变量，可以在本配置文件上下文中引用 -->
	<properties>
        <property name="log_pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %logger %m%n" />
        <property name="log_home" value="F:/log/app.log" />
        <property name="baseDir" value="F:/log/" />
	</properties>
  
    <Appenders>
	    <!-- 输出日志到文件，默认开启bufferedIO(缓冲区满了才会写入磁盘)和immediateFlush(确保数据写入磁盘，但可能影响性能) -->
	    <File name="MyFile" fileName="F:/log/app.log">
            <!-- layout设置日志格式，除了PatternLayout外，还有HTMLLayout、JSONLayout等 -->		   
	        <PatternLayout pattern="${log_pattern}" />
	    </File>
	    
	    <!-- 跟FileAppender很相似，但永远是带缓冲的，不能像FileAppender一样用bufferedIO关闭，性能比FileAppender好 -->
        <RandomAccessFile name="RandomFile" fileName="F:/log/app_random.log">
            <PatternLayout>
                <Pattern>${log_pattern}</Pattern>
            </PatternLayout>
        </RandomAccessFile>
	    
	    <!-- 异步appender，内部采用ArrayBlockingQueue，对每个AsyncAppender创建一个线程用于处理日志输出，
	                           可以引用其它appender并使LogEvents在单独的线程上写入它们，写在要引用的appender后面 -->
	    <Async name="Async">
	        <AppenderRef ref="MyFile" />
	    </Async>
	    
	    <!-- 输出到控制台 target有两个值：SYSTEM_OUT或SYSTEM_ERROR -->
	    <Console name="CONSOLE" target="SYSTEM_OUT">
	        <PatternLayout pattern="${log_pattern}" />
	        <!-- 临界值过滤器，只输出info及以上级别 -->
	        <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" />
	    </Console>
	    
	    <!-- 输出到文件并按策略（滚动策略和触发滚动策略）滚动日志文件，fileName是日志文件名，filePattern是归档日志文件格式 
	    RollingRandomAccessFile和RollingFile很相似，但永远是带缓冲的，不能像RollingFile一样用bufferedIO关闭，性能比RollingFile好
	    -->
		<RollingFile name="RollingFile" fileName="F:/log/roll_app.log" filePattern="F:/log/myApp-%d{yyyy-MM-dd}-%i.log.gz">
			<PatternLayout>
				<Pattern>${log_pattern}</Pattern>
			</PatternLayout>
			<Policies>
                <!-- JVM启动触发滚动 -->
                <OnStartupTriggeringPolicy />
                <!-- 当日志文件大小达到20M时触发滚动 -->
                <SizeBasedTriggeringPolicy size="20 MB" />
                <!-- 当前日期不是日志开始日期时触发滚动，filePattern中%d指定到dd则按天，指定到HH则按小时，默认单位是1 -->
                <TimeBasedTriggeringPolicy />
			</Policies>
			
			<!-- 滚动时保留最近60天的文件，其他删除 -->
			<DefaultRolloverStrategy>
			    <!-- 删除basePath下最多2级子目录下的文件 -->
                <Delete basePath="${baseDir}" maxDepth="2">
                    <!-- 文件名匹配glob指定的格式 -->
                    <IfFileName glob="*/myApp-*.log.gz" />
                    <!-- 文件最后一次修改是60（含）天前 -->
                    <IfLastModified age="60d" />
                </Delete>
			</DefaultRolloverStrategy>
			
		</RollingFile>
		
		<!-- FailoverAppender包装了一组appender，如果主Appender失败，则将按顺序尝试次要Appender，直到一个成功或没有其他次要appender为止 -->	
		<Failover name="Failover" primary="RollingFile">
			<Failovers>
				<AppenderRef ref="CONSOLE" />
			</Failovers>
		</Failover>
    
    </Appenders>
    
    <Loggers>
        <!-- name属性可以写Java类包名，也可以写到具体类限定名 
            level属性指定该logger的日志级别
            additivity="false"确保不重复打印日志，子logger打印过的，父logger就不会再次打印 -->
        <logger name="com.test.im" level="info" additivity="false">
            <AppenderRef ref="CONSOLE" />
        </logger>
        <!-- 异步logger，需引入disruptor依赖，不要跟AsyncAppender一起用，即ref不要引用AsyncAppender -->
        <!--<AsyncLogger name="com.test.im" level="info" additivity="false">
            <AppenderRef ref="RollingFile"/>
        </AsyncLogger>-->

        <Root level="info">
            <AppenderRef ref="CONSOLE" />
            <AppenderRef ref="RollingFile" />
        </Root>
    </Loggers>
    
</Configuration>

SpringBoot使用Log4j2

SpringBoot默认使用Logback，因此，需要手动排除对Logback的依赖，然后引入Log4j2

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter</artifactId>
	<exclusions>
		<exclusion>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>