Log4j2+SpringMVC5配置

最新推荐文章于 2024-09-05 14:27:21 发布

原创最新推荐文章于 2024-09-05 14:27:21 发布 · 1.1k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#log4j2 #springmvc

JAVA 专栏收录该内容

12 篇文章

订阅专栏

本文介绍在Spring MVC项目中使用Log4j2动态加载配置文件的实践，包括pom.xml依赖配置、log4j2.xml动态刷新设置及解决运行中修改配置不生效的问题。

文章目录

需求
尝试过程

需求

想使用Log4j2的动态加载配置文件的特性,随便搭建了一个springMVC项目,尝试效果

尝试过程

pom.xml文件

pom.xml文件内容如下
spring使用的版本是 5.0.1.RELEASE
slf4j2版本2.11.0

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <artifactId>springmvc</artifactId>
    <groupId>cn.com.learnlog</groupId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>
    <modelVersion>4.0.0</modelVersion>
    <properties>
        <springframework.version>5.0.1.RELEASE</springframework.version>
        <!--下面这两个是springAOP需要用到 -->
        <log4j2-version>2.11.0</log4j2-version>
        <spring.version>5.0.1.RELEASE</spring.version>
        <slf4j.version>1.7.26</slf4j.version>
        <log4j.version>2.11.2</log4j.version>
        <swagger.version>2.8.0</swagger.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <!-- pring IOC的基础实现，包含访问配置文件、创建和管理bean等 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>${slf4j.version}</version>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <!--用于与sfl4j保持桥接-->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
            <version>${log4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-web</artifactId>
            <version>${log4j.version}</version>
            <scope>runtime</scope>
        </dependency>
    </dependencies>
    <build>
        <testSourceDirectory>src/test/java</testSourceDirectory>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.7.0</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <artifactId>maven-war-plugin</artifactId>
                <version>3.2.1</version>
                <configuration>
                    <warSourceDirectory>src/main/webapp</warSourceDirectory>
                </configuration>
            </plugin>
            <!-- build-helper-maven-plugin, 设置多个源文件夹 -->
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>build-helper-maven-plugin</artifactId>
                <version>3.0.0</version>
                <executions>
                    <execution>
                        <id>add-source</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>add-source</goal>
                        </goals>
                        <configuration>
                            <sources>

                                <source>src/main/java</source>
                                <!-- 我们可以通过在这里添加多个source节点，来添加任意多个源文件夹 -->
                            </sources>

                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-resources-plugin</artifactId>
                <version>2.6</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>


    </build>
</project>

web.xml中log4j2的配置

百度一圈抄袭了一套配置Log4j2的在web.xml里的写法

	<!-- 日志记录 -->
	<context-param>
		<param-name>log4jConfiguration</param-name>
		<param-value>classpath:log4j2.xml</param-value>
	</context-param>
	<!--动态修改log4j2.xml：容器会每60秒扫描log4j的配置文件-->
	<context-param>
		<param-name>log4jRefreshInterval</param-name>
		<param-value>60000</param-value>
	</context-param>

log4j2文件路径

log4j2.xml文件路径为:src\main\resources\log4j2.xml

测试项目运行中修改log4j2.xml是否生效

运行配置生效,没毛病,尝试修改log4j2.xml文件测试动态修改后的效果,由于配置是60秒检测一次,所以等了一分钟后…发现没有效果.问号脸,开始百度,谷歌之旅.
得到的原因如下:
spring4.21+ 开始,再在web.xml里配置配置文件位置以及刷新时间周期的方式标注为过期了.
另外:
还要注意webapp使用的servlet的版本是2.5和还是3.0以及以上版本;
还有tomcat版本小于等于7.0.43的版本有因为性能问题没有加载 log4j*.jar包(需要额外修改配置文件)!!!(推荐使用比7.0.43更高版本或tomcat8及以后版本,已经修复这个问题了)
详情可以参考官网

解决问题

鉴于本项目用的Spring5,直接删除了web.xml中关于log4j2的2段配置内容(就是上文贴出的web.xml中log4j2的配置文件,全删掉了).因为新版基于servlet3,可以自动识别获取项目classpath下的log4j2.xml当做配置文件或者log4j2-xxxx.xml文件(未测试).
之后修改log4j2.xml配置文件,最终如下,增加 monitorInterval="10"配置,(注意这里配置的10的单位是秒!!!),每10秒检测下配置文件的变动.

<?xml version="1.0" encoding="UTF-8"?>
<!-- status=debug 可以查看log4j的装配过程 -->
<configuration status="off" monitorInterval="10">
...
</configuration>

重新测试成功

重启项目,修改log4j2.xml里的配置(我测试的是修改日志输出路径),10秒后,再生成日志会写入刚才修改的日志路径下.