Java项目中如何使用日志系统_Log4j配置与日志输出实践

P粉602998670

发布： 2025-12-01 16:49:02

原创

117人浏览过

Log4j由Logger、Appender、Layout组成，通过配置文件定义日志级别、输出位置与格式，结合Maven引入依赖并在代码中使用Logger实例记录不同级别日志，建议生产环境设INFO级以上，使用参数化日志、敏感信息脱敏及滚动文件策略优化性能与安全。

java项目中如何使用日志系统_log4j配置与日志输出实践

在Java项目中，日志系统是开发、调试和运维过程中不可或缺的工具。Log4j 作为 Apache 提供的一个成熟、高效的日志框架，被广泛应用于各类 Java 应用中。合理配置 Log4j 能帮助开发者清晰地记录程序运行状态、定位问题并监控系统行为。

Log4j 核心组件简介

Log4j 主要由三个核心部分组成：Logger（日志记录器）、Appender（输出目的地）和 Layout（输出格式）。

Logger：负责捕获日志信息，通过名称获取实例，支持分级控制（如 DEBUG、INFO、WARN、ERROR）。
Appender：定义日志输出位置，例如控制台（ConsoleAppender）、文件（FileAppender）、滚动文件（RollingFileAppender）等。
Layout：指定日志的输出格式，常用的是 PatternLayout，可自定义时间、级别、类名、消息等内容的显示方式。

引入 Log4j 依赖

如果你使用 Maven 构建项目，在 pom.xml 中添加以下依赖：

注意：Log4j 1.x 已停止维护，建议新项目使用 Log4j2。若使用 Log4j2，需引入对应的 log4j-core 和 log4j-api 包。

立即学习“Java免费学习笔记（深入）”；

配置 log4j.properties 文件

在 src/main/resources 目录下创建 log4j.properties 文件，进行基本配置：

Word-As-Image for Semantic Typography

文字变形艺术字、文字变形象形字

查看详情

# 设置根 Logger 级别和使用的 Appender
log4j.rootLogger=DEBUG, console, file

控制台 Appender

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Target=System.out
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

文件 Appender

log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=logs/app.log
log4j.appender.file.MaxFileSize=10MB
log4j.appender.file.MaxBackupIndex=10
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

上述配置将日志同时输出到控制台和文件，文件达到 10MB 后自动滚动备份，最多保留 10 个历史文件。

代码中使用 Logger 示例

在 Java 类中获取 Logger 实例并输出日志：

import org.apache.log4j.Logger;

public class UserService {
private static final Logger logger = Logger.getLogger(UserService.class);

  public void saveUser(String username) {
    logger.info("开始保存用户: " + username);
    try {
      // 模拟业务逻辑
      if (username == null || username.isEmpty()) {
        throw new IllegalArgumentException("用户名不能为空");
      }
      logger.debug("用户数据校验通过");
    } catch (Exception e) {
      logger.error("保存用户失败", e);
    }
  }
}

不同级别的日志用于不同场景：DEBUG 用于调试信息，INFO 表示正常运行状态，WARN 提醒潜在问题，ERROR 记录错误事件。

日志输出最佳实践

避免字符串拼接：使用参数化日志，如 logger.debug("用户 {} 登录成功", username);，可提升性能，尤其在关闭 DEBUG 日志时避免不必要的字符串操作。
合理设置日志级别：生产环境通常设为 INFO 或 WARN，减少日志量；开发环境可用 DEBUG 查看详细流程。
分类管理日志：对不同模块使用不同的 Logger 名称，便于过滤和分析。
定期清理日志文件：结合 RollingFileAppender 配置最大文件数和大小，防止磁盘被占满。
敏感信息脱敏：避免在日志中打印密码、身份证号等敏感数据。