如何在Maven项目中正确配置Log4j并使其生效

教程大全 2026-02-10 19:19:28 浏览次

在 Java 项目的开发与管理中，Maven 作为业界标准的构建和依赖管理工具，极大地简化了库的引入和项目的构建过程，而日志系统，作为应用程序运行状态的“黑匣子”，是不可或缺的关键组件，Log4j，特别是其现代版本 Log4j 2，以其强大的性能、灵活的配置和丰富的功能，成为了最受欢迎的日志框架之一，本文将详细介绍如何在 Maven 项目中配置并使用 Log4j 2，旨在为开发者提供一份清晰、全面且实用的指南。

在 POM 文件中添加 Log4j 依赖

配置 Log4j 的第一步是将其作为依赖项添加到 Maven 项目的文件中，Log4j 2 核心主要由两个模块组成：和 log4j-core 。提供了与应用程序交互的接口，而 log4j-core 则是具体的实现。

打开项目根目录下的文件，在节点中添加以下配置：

org.apache.logging.log4jlog4j-core2.23.1org.apache.logging.log4jlog4j-API2.23.1

说明：

创建 log4j2.xml 配置文件

仅仅添加依赖是不够的,Log4j 需要一个配置文件来告诉它如何记录日志（记录级别、输出目的地、日志格式等），Log4j 2 会在 classpath 中自动查找名为 log4j2.xml 的配置文件。

在 Maven 项目的标准结构中，应将此文件放置在 src/main/resources 目录下，如果该目录不存在，请手动创建。

以下是一个功能齐全的 log4j2.xml 示例，它将日志同时输出到控制台和一个滚动文件中：

配置解析：

在 Java 代码中使用 Log4j

配置完成后,就可以在 Java 代码中记录日志了，推荐使用 Logmanager 获取一个实例。

import org.apache.logging.log4j.LogManager;import org.apache.logging.log4j.Logger;public class Application {// 获取当前类的 Logger 实例private static final Logger logger = LogManager.getLogger(Application.class);public static void main(String[] args) {logger.info("应用程序启动。");try {int result = 10 / 0;} catch (Exception e) {// 记录错误信息，并附带异常堆栈logger.error("发生了一个数学运算异常", e);}logger.debug("这是一条调试信息。");logger.warn("这是一条警告信息。");logger.info("应用程序结束。");}}

运行上述代码,你将看到控制台和 logs/app.log 文件中都有相应的日志输出，由于 Application 类不在 com.example 包下，它的日志级别由根记录器控制， logger.debug() 的消息不会输出。