首页手记 Java日志系统入门教程

Java日志系统入门教程

标签：

Java

概述

本文介绍了Java日志系统的基本概念和作用，涵盖了Log4j、SLF4J、Java Util Logging和Logback等常见日志框架的配置方法和代码示例，帮助读者了解如何选择合适的日志框架并进行集成，适合对Java日志系统入门感兴趣的学习者。

日志系统简介

什么是日志

日志是软件运行时生成的一系列记录，这些记录包含了程序运行过程中的各种信息。日志的主要功能是记录程序运行过程中产生的事件，以便开发人员调试程序、追踪错误、分析系统行为。在实际的开发过程中，日志记录是必不可少的一个环节，不仅可以在发生错误时帮助定位问题，还可以用于性能分析和监控。

日志的作用

调试与错误追踪：在开发过程中，可以通过日志记录程序的状态和执行流程，帮助开发者快速定位错误。
性能分析：日志可以记录程序执行的时间、资源使用情况等信息，帮助开发者分析程序性能。
监控与维护：在系统运行过程中，可以通过日志记录系统状态变化，帮助运维人员监控系统运行状况。
审计追踪：对于某些需要审计的系统，日志可以记录用户操作和系统关键操作，供后续追溯。

Java中的日志框架

Java编程语言提供了多种日志框架，这些框架帮助开发者更方便地记录日志。常见的日志框架包括Log4j、SLF4J、Java Util Logging和Logback等。每种框架都有其特点和使用场景。

Log4j 是最早的一个Java日志框架，由Apache开发和维护。
SLF4J（Simple Logging Facade for Java）是一个简单的日志门面框架，尽管本身不提供日志实现，但可以通过绑定不同的日志实现库来使用。
Java Util Logging 是Java平台自带的一个日志框架，使用方便，但功能相对简单。
Logback 是Log4j的后续版本，功能强大，性能优秀。

常见Java日志框架

Log4j

Log4j是一个强大的日志框架，提供了灵活的日志记录方式。使用Log4j，你可以配置不同的日志级别（例如debug、info、warn、error等），并且可以通过配置文件指定日志输出的格式和目的地。

依赖配置：

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

配置文件（log4j.properties）：

log4j.rootLogger=DEBUG, stdout, file

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.File=./logs/app.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

代码示例：

import org.apache.log4j.Logger;

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

    public static void main(String[] args) {
        logger.debug("This is a debug message");
        logger.info("This is an info message");
        logger.warn("This is a warning message");
        logger.error("This is an error message");
    }
}

SLF4J

SLF4J是一个日志门面框架，它本身并没有实现日志的功能，而是通过绑定不同的日志实现库来提供日志服务。使用SLF4J，你可以避免在代码中直接引用某个特定的日志实现库，从而使得代码更具有可移植性。

依赖配置：

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.30</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>1.7.30</version>
</dependency>

代码示例：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

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

    public static void main(String[] args) {
        logger.debug("This is a debug message");
        logger.info("This is an info message");
        logger.warn("This is a warning message");
        logger.error("This is an error message");
    }
}

Java Util Logging

Java Util Logging是Java平台自带的一个日志框架，使用方便，但功能相对简单。虽然它没有Log4j或SLF4J那么强大，但对于一些简单的应用场景还是非常实用的。

依赖配置：
无需额外依赖，Java Util Logging是JDK自带的。

配置文件（logging.properties）：

# Java Util Logging configuration
.handlers=java.util.logging.FileHandler, java.util.logging.ConsoleHandler

java.util.logging.FileHandler.pattern=./logs/app.log
java.util.logging.FileHandler.level=FINE

java.util.logging.ConsoleHandler.level=FINE
java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter

代码示例：

import java.util.logging.Logger;

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

    public static void main(String[] args) {
        logger.info("This is an info message");
        logger.warning("This is a warning message");
        logger.severe("This is a severe message");
    }
}

Logback

Logback是Log4j的后续版本，功能强大，性能优秀。Logback支持灵活的日志配置，可以输出到文件、数据库、远程服务器等多种目标。

依赖配置：

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.10</version>
</dependency>

配置文件（logback.xml）：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>./logs/app.log</file>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>./logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

代码示例：

import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;

public class LogbackExample {
    private static final LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
    private static final Logger logger = context.getLogger(LogbackExample.class);

    public static void main(String[] args) {
        logger.debug("This is a debug message");
        logger.info("This is an info message");
        logger.warn("This is a warning message");
        logger.error("This is an error message");
    }
}

如何在项目中集成日志框架

选择合适的日志框架

选择合适的日志框架需要考虑以下因素：

功能需求：不同的框架支持不同的日志级别和输出格式，根据项目需求选择。
性能要求：某些框架在性能方面更优，适合高负载环境。
兼容性：选择与已有系统兼容的框架，避免引入过多依赖。
易用性：使用简单、配置方便的框架可以提高开发效率。

添加依赖

根据选择的框架，添加相应的Maven依赖到项目的pom.xml文件中。例如，添加Log4j的依赖：

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

配置文件的编写

不同的日志框架有不同的配置文件格式，需要根据框架的文档编写相应的配置文件。例如Log4j的配置文件（log4j.properties）和Logback的配置文件（logback.xml）格式不同。

配置文件示例：

Log4j配置文件示例：
```
log4j.rootLogger=INFO, stdout, file
```

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.File=./logs/app.log
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n


- **Logback配置文件示例**：
```xml
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>./logs/app.log</file>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>./logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

日志配置详解

输出格式

日志输出格式是指日志条目的表现形式，通常包含时间戳、日志级别、日志信息等内容。格式的定义可以保证日志的一致性和可读性。

示例（Log4j）：

log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

日志级别

日志级别定义了日志条目的严重程度，常见的有debug、info、warn、error等。不同的日志级别可以控制输出的信息量，帮助开发者更有效地进行调试和维护。

示例（Log4j）：

log4j.rootLogger=DEBUG, stdout, file

输出目的地

输出目的地指定了日志条目的输出位置，可以是控制台、文件、数据库等。根据实际需求选择不同的输出目的地，确保日志能够被正确保存和查看。

示例（Log4j）：

log4j.appender.stdout.Target=System.out
log4j.appender.file.File=./logs/app.log

日志文件管理

日志文件管理是指对日志文件的维护和管理，包括文件的滚动、压缩、删除等操作。良好的日志文件管理可以避免日志文件过大，确保日志的可用性和稳定性。

示例（Logback）：

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>./logs/app.log</file>
    <encoder>
        <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <fileNamePattern>./logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
</appender>

常见问题及解决方案

日志打印不正常

问题描述：日志信息没有按照预期输出。
解决方案：检查配置文件是否正确，确保日志级别设置正确，输出目的地配置无误。

日志文件过大

问题描述：日志文件不断增长，占用大量存储空间。
解决方案：配置日志文件滚动策略，定期创建新的日志文件，旧的文件自动删除或压缩。

日志混淆

问题描述：不同日志框架混用，导致日志记录混乱。
解决方案：选择一个合适的日志框架并统一使用，避免引入多个日志库，以免混淆。

小结与实践

总结

选择合适日志框架、正确配置日志文件、合理设置日志级别和输出格式是日志系统设计的关键。良好的日志系统不仅帮助开发者快速定位和解决问题，还可以提高系统的稳定性和可维护性。

练习题

配置Log4j：


# Log4j配置文件示例
log4j.rootLogger=INFO, stdout, file


2. **配置Logback**：
```xml
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>./logs/app.log</file>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>./logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

代码示例：


import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

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

public static void main(String[] args) {
    logger.debug("This is a debug message");
    logger.info("This is an info message");
    logger.warn("This is a warning message");
    logger.error("This is an error message");
}

}



### 进阶资源推荐
- **慕课网（imooc.com）**：提供丰富的Java课程和资源，帮助开发者深入学习Java编程和相关技术。
- **Log4j官方文档**：详细介绍Log4j的配置和使用方法。
- **SLF4J官方文档**：详细介绍SLF4J的设计理念和使用方法。
- **Logback官方文档**：详细解释Logback的配置和高级特性。
- **Java Util Logging官方文档**：详细介绍Java Util Logging的使用方法和配置选项。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

绝地无双

手记
篇

粉丝

59

获赞与收藏

325

关注作者，订阅最新文章

相关文章推荐

JAVA日志系统

Graylog日志分析管理系统入门教程

Java 为程序创建日志系统

ELK日志系统之通用应用程序日志接入方案

小白入门学习打日志

阅读免费教程

Java并发工具

23个小节 19133 310

Java 并发原理入门教程

26个小节 38736 565

Java 入门教程

50个小节 339380 3141

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

Java日志系统入门教程

什么是日志

日志的作用

Java中的日志框架

Log4j

SLF4J

Java Util Logging

Logback

选择合适的日志框架

添加依赖

配置文件的编写

输出格式

日志级别

输出目的地

日志文件管理

日志打印不正常

日志文件过大

日志混淆

总结

练习题

相关文章推荐

阅读免费教程