如何在Java项目中实现漂亮的日志输出

拉斯特6个月前发布

3181

日志是开发过程中不可或缺的一部分，它可以帮助我们追踪代码的执行过程、排查问题以及监控系统运行状况。然而，大多数开发人员在编写日志时往往只关注于输出必要的信息，而忽略了日志的可读性和美观性。本文将介绍如何在Java项目中实现漂亮的日志输出，提供一些实用的技巧和建议。

1. 使用合适的日志框架

Java有许多优秀的日志框架可供选择，如Log4j、Logback和java.util.logging等。选择一个适合你项目需求的日志框架是实现漂亮日志输出的第一步。这些框架提供了丰富的配置选项，可以帮助你控制日志的格式和输出方式。这里对几个日志框架做一下简单的介绍。

Log4j

Log4j是一个Java日志处理的框架，用于在Java应用程序中处理日志记录。它提供了一种灵活的方式来记录日志信息，并允许开发者根据需要配置日志输出的格式和目标。

在Log4j中，主要有三个组件：Logger、Appender和Layout。Logger用于记录日志信息，Appender用于定义日志的输出目标，例如控制台、文件、数据库等，Layout用于定义日志的输出格式。

以下是一个简单的Log4j代码示例：

import org.apache.log4j.Logger;  
  
public class MyApp {  
    // 获取Logger实例  
    final static Logger logger = Logger.getLogger(MyApp.class);  
  
public static void main(String[] args) {  
    // 记录不同级别的日志信息  
    logger.debug("Debugging information");  
    logger.info("Informational message");  
    logger.warn("Warning");  
    logger.error("Error occurred");  
    logger.fatal("Fatal error occurred");  
}  
}

在这个示例中，我们首先导入了Logger类，然后通过Logger.getLogger(MyApp.class)获取了一个Logger实例。在main方法中，我们使用Logger实例记录了不同级别的日志信息，包括Debug、Info、Warn、Error和Fatal。

Logback

Logback是Log4j的改进版本，是SLF4J（Simple Logging Facade for Java）下的一种日志实现。与Log4j相比，Logback具有更高的性能和更灵活的配置。

Logback的组件包括Logger、Appender、Encoder、Layout和Filter，其中Logger是最常用的组件。Logger分为rootLogger和nestedLogger，rootLogger是所有Logger的根，nestedLogger则是rootLogger的子级。Logger之间有五个级别，从高到低依次为ERROR、WARN、INFO、DEBUG和TRACE，级别越高，日志信息越重要。

以下是一个简单的Logback代码示例：

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
  
public class MyClass {  
    private static final Logger logger = LoggerFactory.getLogger(MyClass.class);  
    public void myMethod() {  
        logger.debug("Debug message");  
        logger.info("Info message");  
        logger.warn("Warn message");  
        logger.error("Error message");  
    }  
}

logging

java.util.logging是Java平台的核心日志工具。

java.util.logging由Logger、Handler、Filter、Formatter等类和接口组成。其中Logger是日志记录器，用于记录日志信息；Handler是处理器，用于处理日志信息；Filter是过滤器，用于过滤不需要记录的日志信息；Formatter是格式化器，用于格式化日志信息。

这里介绍的日志框架，在项目当中运用的比较多的是Log4j、Logback，从基本的配置上没有太大的差异，大家也可以根据项目需求选择使用。

2. 定义清晰的日志级别

在Java项目中，定义清晰的日志级别是非常重要的，以便在调试、监控和解决潜在问题时有效地记录和理解系统行为。下面是一些建议，可以帮助你定义清晰的日志级别：

了解常见的日志级别：Java中常见的日志级别包括DEBUG、INFO、WARN、ERROR和FATAL。每个级别都有特定的含义和用途，首先要了解这些级别的含义。
根据项目需求确定日志级别：在定义日志级别时，需要考虑项目的需求和目标。例如，对于一个简单的演示应用程序，可能不需要记录过多的调试信息。但对于一个复杂的业务系统，可能需要详细的调试信息来跟踪和解决潜在的问题。根据项目的重要性和规模来确定每个级别的日志信息是否必要。
默认级别设置：为项目设置一个默认的日志级别。这通常是INFO级别，用于记录系统的常规操作信息。
根据模块或功能设置日志级别：为每个模块或功能设置不同的日志级别。这有助于在特定部分出现问题时快速定位问题原因。例如，对于数据库模块，可以将其日志级别设置为DEBUG，以便记录详细的数据库操作信息。
日志级别继承：在一个日志级别下定义的日志信息，应该继承到其所有子级别中。这意味着，如果某个日志信息被设置为WARN级别，那么该信息应该同时出现在WARN、ERROR和FATAL日志中。
日志信息清晰明了：在记录日志信息时，要确保信息清晰明了，包含必要的细节。例如，对于错误信息，要包含错误类型、发生错误的方法和时间戳等信息。
日志轮转和清理：及时对日志进行轮转和清理，避免日志文件过大而影响系统性能。可以设置一个合适的大小限制或时间间隔，对旧的日志文件进行归档和清理。
培训开发人员：为开发人员提供关于如何使用日志系统的培训，确保他们了解如何记录适当的日志信息以及如何利用日志级别进行过滤。
参考最佳实践：可以参考一些关于日志编写的最佳实践指南，例如Log4j的官方文档，以获取更多关于如何定义清晰日志级别的建议。

定义清晰的日志级别对于Java项目来说非常重要。通过了解常见的日志级别、根据项目需求确定级别、设置默认级别、按模块或功能划分级别、继承级别、记录清晰明了的日志信息、及时轮转和清理以及培训开发人员等措施，可以帮助你在项目中实现定义清晰、易于理解和使用的日志级别。

3. 格式化日志输出

下面以Log4j为例，介绍如何格式化日志输出。

1，引入Log4j依赖

在Maven项目中，可以在pom.xml文件中添加以下依赖：

<dependency>  
    <groupId>org.apache.logging.log4j</groupId>  
    <artifactId>log4j-core</artifactId>  
    <version>2.x.x</version>  
</dependency>

2. 配置日志格式

在log4j2.xml配置文件中，可以使用PatternLayout类来配置日志格式。例如，以下配置将日志输出为每行包含时间戳、日志级别、线程名和消息的格式：

<?xml version="1.0" encoding="UTF-8"?>  
<Configuration status="WARN">  
<Appenders>  
    <Console name="Console" target="SYSTEM_OUT">  
    <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>  
    </Console>  
</Appenders>  
<Loggers>  
    <Root level="debug">  
    <AppenderRef ref="Console"/>  
    </Root>  
</Loggers>  
</Configuration>

其中，%d表示时间戳，%t表示线程名，%-5level表示日志级别（使用五个字符的宽度），%logger{36}表示最长为36个字符的Logger名称，%msg表示消息。在配置文件中可以根据需要调整格式。

3. 在代码中使用Log4j记录日志

在Java代码中，可以使用以下语句记录日志：

import org.apache.logging.log4j.LogManager;  
import org.apache.logging.log4j.Logger;  
  
public class MyClass {  
    private static final Logger logger = LogManager.getLogger(MyClass.class); 
  
    public static void main(String[] args) {  
        logger.debug("Debug message");  
        logger.info("Info message");  
        logger.warn("Warn message");  
        logger.error("Error message");  
    }  
}

在输出结果中，可以看到每条日志信息都符合之前配置的格式。可以使用不同的配置文件来调整日志格式，以满足不同的需求。

4. 日志轮转和切割

日志切割和轮转在Log4j中主要通过两种策略实现：基于大小（Size-based）和基于日期时间（Time-based）。

1. 基于大小的日志切割和轮转

这种策略是当日志文件达到指定大小时，会进行切割或轮转。例如，你可以设置当日志文件达到100MB时进行轮转。

<RollingFile name="File" fileName="logs/app.log" filePattern="logs/app-%d{yyyy-MM-dd}.log.gz">  
    <PatternLayout>  
        <pattern>%d %p %c{1.} [%t] %m%n</pattern>  
    </PatternLayout>  
    <Policies>  
        <SizeBasedTriggeringPolicy size="100 MB"/>  
    </Policies>  
    <DefaultRolloverStrategy max="20"/>  
</RollingFile>

在上述配置中，当app.log文件达到100MB时，它会被切割并存储为app-yyyy-MM-dd.log.gz。并且最多保留20个这样的文件。

2. 基于日期时间的日志切割和轮转

这种策略是当达到指定的日期时间时，进行日志切割或轮转。例如，你可以设置每天凌晨1点进行轮转。

<RollingFile name="File" fileName="logs/app.log" filePattern="logs/app-%d{yyyy-MM-dd}.log.gz">  
    <PatternLayout>  
        <pattern>%d %p %c{1.} [%t] %m%n</pattern>  
    </PatternLayout>  
    <Policies>  
        <TimeBasedTriggeringPolicy interval="1"/>  
    </Policies>  
    <DefaultRolloverStrategy max="30"/>  
</RollingFile>

在上述配置中，每天凌晨1点，app.log文件会被切割并存储为app-yyyy-MM-dd.log.gz。并且最多保留30个这样的文件。

注意：<DefaultRolloverStrategy max="20"/> 或 <TimeBasedTriggeringPolicy interval="1"/> 中的数字可以根据你的实际需要进行调整。

5. 日志过滤器（Filter）的使用

Log4j中的过滤器（Filter）用于在日志事件发生之前对其进行一些条件判断，以决定是否接受该事件或者更改该事件。这可以让你根据特定的条件过滤日志输出，例如只打印错误级别以上的日志，或者根据线程ID、请求ID等过滤日志。

在Log4j 2中，你可以通过配置文件（例如log4j2.xml）来为日志事件指定过滤器。以下是一个使用Log4j 2的XML配置文件中的过滤器的示例：

<?xml version="1.0" encoding="UTF-8"?>  
<Configuration status="WARN">  
<Appenders>  
    <Console name="Console" target="SYSTEM_OUT">  
        <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>  
        <Filters>  
            <ThresholdFilter level="ERROR"/>  
            <MarkerFilter marker="FLOW" onMatch="DENY"/>  
            <MarkerFilter marker="EXCEPTION" onMatch="DENY"/>  
        </Filters>  
    </Console>  
</Appenders>  
<Loggers>  
    <Root level="all">  
        <AppenderRef ref="Console"/>  
    </Root>  
</Loggers>  
</Configuration>

在这个例子中，我们使用了三个过滤器：

（1）. ThresholdFilter只接受级别为ERROR或更高级别的日志事件。

（2）. 第一个MarkerFilter会拒绝任何带有”FLOW”标记的日志事件。

（3）. 第二个MarkerFilter会拒绝任何带有”EXCEPTION”标记的日志事件。

另外，你还可以创建自定义的过滤器，只需实现org.apache.logging.log4j.core.filter.Filter接口即可。然后你可以在配置文件中通过指定类全名来使用你的过滤器。

对于更复杂的过滤需求，你还可以使用Condition元素，它允许你使用Java代码来决定是否接受一个日志事件。不过，请注意，因为这可能会影响性能，所以应谨慎使用。

下面是实际项目中打印的日志，大家可以根据项目的需求满足日志打印的需求。

总结

通过选择合适的日志框架、定义清晰的日志级别、格式化日志输出、添加时间戳和线程信息、使用日志分级以及处理异常和堆栈跟踪，我们可以实现在Java项目中打印漂亮的日志。漂亮的日志输出不仅可以提高代码的可读性，还可以帮助我们更好地理解和跟踪代码的执行过程，从而提高开发效率和系统稳定性。

作者：mikezhu
来源：https://juejin.cn/post/7291675889381031990

评分

欢迎为Ta评分