如何禁用外部Maven依赖中的日志配置，避免覆盖自定义Log4j2配置？

场景说明 #

Spring Boot应用自定义Log4j2配置文件resources/log4j2.xml，但引入的外部库自带logback.xml，导致自定义Log4j2配置被覆盖，日志由外部库控制。Logger实例获取方式：
private static final Logger LOGGER = LogManager.getLogger(Foo.class);

已配置的Log4j2相关Maven依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <version>${spring.boot.version}</version>
    <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>
    <version>${spring.boot.version}</version>
</dependency>

解决步骤 #

1. 排除外部库中的Logback依赖 #

项目中必须完全移除Logback相关依赖，否则classpath中存在Logback的jar或配置文件时，仍可能被加载。

在引入外部库的Maven依赖中添加排除规则：

<dependency>
    <groupId>外部库groupId</groupId>
    <artifactId>外部库artifactId</artifactId>
    <exclusions>
        <!-- 排除Logback核心依赖 -->
        <exclusion>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
        </exclusion>
        <exclusion>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
        </exclusion>
        <!-- 若存在logback-access也一并排除 -->
        <exclusion>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-access</artifactId>
        </exclusion>
    </exclusions>
</dependency>

可执行mvn dependency:tree查看依赖树，确认所有Logback相关依赖已被排除。

2. 强制指定Log4j2配置文件优先级 #

通过系统属性或Spring Boot配置，明确指定自定义log4j2.xml的加载优先级：

方式一：启动时添加JVM参数

应用启动时加入以下JVM参数：

-Dlogging.config=classpath:log4j2.xml
-Dlog4j2.configurationFile=classpath:log4j2.xml

这两个参数分别对应Spring Boot日志配置指定和Log4j2自身配置文件指定，双重确保自定义配置生效。

方式二：在Spring Boot配置文件中设置

在application.properties或application.yml中添加：

# 指定Spring Boot使用的日志配置文件
logging.config=classpath:log4j2.xml
# 强制Log4j2加载自定义配置
log4j2.configurationFile=classpath:log4j2.xml

3. 阻止外部库的logback.xml被加载 #

若外部库的logback.xml仍被扫描加载，可在构建阶段移除该文件：

在Maven的pom.xml中添加maven-dependency-plugin，打包时排除外部库中的logback.xml：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>unpack-dependencies</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>unpack-dependencies</goal>
                    </goals>
                    <configuration>
                        <includeGroupIds>外部库groupId</includeGroupIds>
                        <includeArtifactIds>外部库artifactId</includeArtifactIds>
                        <excludes>**/logback.xml</excludes>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

4. 验证配置生效 #

启动应用后，查看日志初始化信息，若出现类似以下内容，说明自定义Log4j2配置已生效：

Log4j2 initialization using configuration file [classpath:log4j2.xml]

同时检查日志格式、输出位置是否与log4j2.xml定义一致，确认外部库的Logback配置未生效。

内容的提问来源于stack exchange，提问作者jnemecz