Springboot使用log4j2日志框架

发布时间:2023年12月28日

1.pom.xml引入依赖

提示:lombok用于@Slf4j注解

		<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>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
        
		<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

2.配置文件引入log4j2的配置文件

提示:在配置文件yaml中引入

logging:
  config: classpath:log4j2-spring.xml

3.导入log4j2配置文件

提示:文件名为log4j2-spring.xml,放置在/src/main/resources文件夹下与yaml配置文件同路径,可直接使用下面的配置文件信息,或根据自己需求修改。

<?xml version="1.0" encoding="UTF-8"?>
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status,这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出 -->
<!--monitorInterval:Log4j能够自动检测修改配置 文件和重新配置本身,设置间隔秒数 -->
<configuration status="INFO" monitorInterval="30">
	<!--<contextName>log4j2</contextName> -->
	<properties>
		<!--${sys:catalina.home}表示linux中环境变量中的tomcat根目录 用户主目录 -->
		<!--原来用logback时候在统一配置中心也配置一个logging.path=/opt/tomcat-log/${spring.application.name} 
			LOG_PATH是内置变量 -->
		<!--${sys:user.home} 用户主目录 -->
		<Property name="log_path">logs</Property>

		<!-- 保留日志天数 D H M S 分别对应天 小时 分钟 秒 -->
		<property name="KEEP_LOG_DAY">60D</property>
		<!-- 日志切割的最小单位 -->
		<property name="EVERY_FILE_SIZE">5M</property>
	</properties>
	<!--先定义所有的appender -->
	<appenders>
		<console name="Console" target="SYSTEM_OUT">
			<!--输出日志的格式 -->
			<PatternLayout 
				pattern="[%d][%t][%p][%c:%L] %m%n" />
			<ThresholdFilter level="info" onMatch="ACCEPT"
				onMismatch="DENY" />
		</console>
		<!--这个输出控制台的配置 -->
		<!--<console name="Console" target="SYSTEM_OUT" follow="false"> -->
		<!--&lt;!&ndash;输出日志的格式 &ndash;&gt; -->
		<!--<PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] 
			- %msg%n" /> -->
		<!--</console> -->

		<!-- 这个会打印出所有的info及以下级别的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档 -->
		<RollingFile name="RollingFileInfo"
			fileName="${log_path}/info.log"
			filePattern="${log_path}/$${date:yyyy-MM-dd}/info-%d{yyyy-MM-dd}-%i.log">
			<!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch) -->
			<ThresholdFilter level="info" onMatch="ACCEPT"
				onMismatch="DENY" />
			<!--<Filters> -->
			<!--<ThresholdFilter level="INFO"/> -->
			<!--<ThresholdFilter level="WARN" onMatch="DENY" -->
			<!--onMismatch="NEUTRAL"/> -->
			<!--</Filters> -->
			<PatternLayout 
				pattern="[%d][%t][%p][%c:%L] %m%n" />
			<Policies>
				<!-- 归档每天的文件 -->
				<!--<TimeBasedTriggeringPolicy interval="1" modulate="true"/> -->
				<TimeBasedTriggeringPolicy />
				<!-- 限制单个文件大小 -->
				<SizeBasedTriggeringPolicy
					size="${EVERY_FILE_SIZE}" />
			</Policies>
			<!-- 限制每天文件个数 --> <!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了100 -->
			<DefaultRolloverStrategy max="256">
				<Delete basePath="${log_path}/" maxDepth="3">
					<IfFileName glob="*/*info*.log" />
					<IfLastModified age="${KEEP_LOG_DAY}" />
				</Delete>
			</DefaultRolloverStrategy>
		</RollingFile>


		<RollingFile name="RollingFileWarn"
			fileName="${log_path}/warn.log"
			filePattern="${log_path}/$${date:yyyy-MM-dd}/warn-%d{yyyy-MM-dd}-%i.log">
			<ThresholdFilter level="warn" onMatch="ACCEPT"
				onMismatch="DENY" />
			<!--<PatternLayout charset="GBK" pattern="[%d{HH:mm:ss:SSS}] [%p] - %l 
				- %m%n" /> -->
			<PatternLayout 
				pattern="[%d][%t][%p][%c:%L] %m%n" />
			<Policies>
				<TimeBasedTriggeringPolicy />
				<SizeBasedTriggeringPolicy
					size="${EVERY_FILE_SIZE}" />
			</Policies>
			<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了100 -->
			<DefaultRolloverStrategy max="256">
				<Delete basePath="${log_path}/" maxDepth="3">
					<IfFileName glob="*/*warn*.log" />
					<IfLastModified age="${KEEP_LOG_DAY}" />
				</Delete>
			</DefaultRolloverStrategy>
		</RollingFile>
		<RollingFile name="RollingFileError"
			fileName="${log_path}/error.log"
			filePattern="${log_path}/$${date:yyyy-MM-dd}/error-%d{yyyy-MM-dd}-%i.log">
			<ThresholdFilter level="error" onMatch="ACCEPT"
				onMismatch="DENY" />
			<!--<PatternLayout charset="GBK" pattern="[%d{HH:mm:ss:SSS}] [%p] - %l 
				- %m%n" /> -->
			<PatternLayout 
				pattern="[%d][%t][%p][%c:%L] %m%n" />
			<Policies>
				<TimeBasedTriggeringPolicy />
				<SizeBasedTriggeringPolicy
					size="1${EVERY_FILE_SIZE}" />
			</Policies>
			<!-- DefaultRolloverStrategy属性如不设置,则默认为最多同一文件夹下7个文件,这里设置了100 -->
			<DefaultRolloverStrategy max="256">
				<Delete basePath="${log_path}/" maxDepth="3">
					<IfFileName glob="*/*error*.log" />
					<IfLastModified age="180D" />
				</Delete>
			</DefaultRolloverStrategy>
		</RollingFile>
	</appenders>
	<!--然后定义logger,只有定义了logger并引入的appender,appender才会生效 -->
	<loggers>
		<!--过滤掉spring和mybatis的一些无用的DEBUG信息 -->
		<logger name="org.springframework" level="INFO"></logger>
		<logger name="org.mybatis" level="DEBUG"></logger>
		<!--<root level="all"> -->
		<root level="ALL">
			<appender-ref ref="Console" />
			<appender-ref ref="RollingFileInfo" />
			<appender-ref ref="RollingFileWarn" />
			<appender-ref ref="RollingFileError" />
		</root>
		<logger name="cn.timebusker.util" level="INFO">
			<appender-ref ref="RollingFileInfo" />
		</logger>
	</loggers>
</configuration>

4.通过@Slf4j注解来使用log.info()等

提示:添加@Slf4j注解,然后在下面直接使用log.info()等方法

package com.example.demo.controller;

import com.example.demo.entity.User;
import com.example.demo.service.LoginServcie;
import com.example.demo.utils.ResponseResult;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import lombok.extern.slf4j.Slf4j;

@RestController
@Slf4j
public class LoginController {

    @PostMapping("/user/login")
    public ResponseResult login(@RequestBody User user) {
        log.info("111-登录成功!");
        return null;
    }
}

控制台打印结果
在这里插入图片描述
info.log文件中打印的结果
在这里插入图片描述

最后

到此为止,欢迎大家交流!

文章来源:https://blog.csdn.net/qq_42739591/article/details/135248488
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。