log4j2的使用

log4j2的使用

目录

1. maven的pom.xml中导包
2. 添加配置文件
3. 使用

1、maven的pom.xml中导包

   <dependencies>
		<dependency>
			<groupId>org.apache.logging.log4j</groupId>
			<artifactId>log4j-api</artifactId>
			<version>2.11.1</version>
		</dependency>
		<dependency>
			<groupId>org.apache.logging.log4j</groupId>
			<artifactId>log4j-core</artifactId>
			<version>2.11.1</version>
		</dependency>
	</dependencies>

如果使用slf4j作为日志门面，log4j2作为日志实现，还需导入以下依赖

    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.28</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.9.1</version>
    </dependency>
    ```
        如果是spring-boot项目，默认使用的是logback日志框架，需要先排除logback的依赖：
```xml
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>-->
                   <artifactId>spring-boot-starter-logging</artifactId>-->
               </exclusion>
            </exclusions>
        </dependency>

2、添加配置文件
在项目resource文件夹下新建xml文件，文件名为log4j2.xml

   <Configuration status="off" monitorInterval="300">
	<properties>
		<property name="LOG_HOME">D:/logs</property>
		<property name="FILE_NAME">mylog</property>
	</properties>
	<Appenders>
		<Console name="Console" target="SYSTEM_OUT">
			<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
		</Console>
		<RollingRandomAccessFile name="MyFile"
			fileName="${LOG_HOME}/${FILE_NAME}.log"
			filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">
			<PatternLayout
				pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
			<Policies>
				<TimeBasedTriggeringPolicy interval="1" />
				<SizeBasedTriggeringPolicy size="10 MB" />
			</Policies>
			<DefaultRolloverStrategy max="20" />
		</RollingRandomAccessFile>
		<!--异步日志追加器1：AsyncAppender 生产上几乎不使用，因为性能低下-->
        <Async name="Async">
            <AppenderRef ref="file" />
        </Async>

        <!--异步日志追加器2：AsyncLogger 全局方式
        在项目resources目录下创建文件 log4j2.component.properties ，添加属性
        Log4jContextSelector=org.apache.logging.log4j.core.async.AsyncLoggerContextSelector
        -->
	</Appenders>
 
	<Loggers>
		<!--异步日志追加器2：AsyncLogger 局部方式
        自定义 logger 对象 ，只对com.log包下的代码进行异步日志追加， <AppenderRef ref="Console" />指定需要异步的日志追加器
        includeLocation="false" 关闭日志记录的行号信息，开启的话会严重影响异步输出的性能
        additivity="false" 不再继承 rootlogger对象
        -->
        <AsyncLogger name="com.log" level="trace" includeLocation="false" additivity="false">
            <AppenderRef ref="Console" />
        </AsyncLogger>
		<Root level="error">
			<AppenderRef ref="Console" />
			<AppenderRef ref="MyFile" />
		</Root>
	</Loggers>
</Configuration>

根标签Configuaration 的两个属性：
status:用来指定log4j2自身的日志级别（log4j2自身程序运行的日志级别）
monitorInterval：log4j2自动检测更新配置文件(log4j2.xml)改动并更新的时间间隔，最少5秒。
子标签properties用于定义一些常量
子标签 appenders 用于定义输出器，可以输出到控制台和文件.
appenders的子标签Console 可以将日志信息输出到控制台，RollingRandomAccessFile 可以将日志信息输出到文件并通过设置分割文件的策略，将文件按时间或者文件大小分隔成一个个的小文件。
PatternLayout 标签的pattern属性用于设置日志输出样式。
%d{HH:mm:ss.SSS}：%d代表日志时间,后面{}包括的内容是时间格式，
%-5level：level代表日志等级，-代表左对齐5代表取日志等级的前五个字符，
%n：代表换行,
%l:行号
%c:类名
%M:方法名
%msg:日志内容
%m:日志内容简写
在Loggers的root标签里声明要使用的追加器Console、MyFile（在Appenders标签中定义的），不然不会生效
更多日志样式设置可以参考官网说明：

官网英文如果看着吃力可以用流量器的翻译功能把网页翻译一下。
TimeBasedTriggeringPolicy标签中的 interval属性表示多长时间分割一次RollingRandomAccessFile 标签的属性filePattern中定义的日志文件单位取决于filePattern中%d{}日志时间格式的最后以为，如果最后一位是小时，就是每隔1小时，切割一次日志文件。
SizeBasedTriggeringPolicy标签中 size表示从RollingRandomAccessFile标签的fileName属性定义的文件切割出来的文件的大小。

DefaultRolloverStrategy标签的max表示filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">中i的最大值，i的初始值是1，当达到最大值时，将删除i=1的文件，并重命名其他文件的名字，具体就是将其他文件的i-1,具体可参考 https://www.cnblogs.com/yeyang/p/7944899.html

Loggers标签用于定义记录器，就是代码中要用到的，实际引用的。
它的子标签root定义了根记录器的属性，包括日志等级level和子标签appenderRef（日志输出器，就是上面appenders标签里定义的日志输出器）。appenderRef的ref属性指定使用哪个日志输出器。

3、使用

public static Logger logger = LogManager.getLogger(This.class);
logger.info("log4j2日志打印");

官方建议定义为静态变量。getLogger()的参数不填也行，它会自动将获取到的记录器命名为当前类的全类名。
生产上日志对于查找问题是非常重要的手段，以前没有重视。今天好好看了一下。总结的还是很浅显，但是够日常使用了，有错误的地方，欢迎指出！