Java常见log日志的使用方法解析

在Java中，使用log日志来记录系统运行时产生的事件和错误信息十分重要。它可以帮助开发者快速定位问题并解决，提高开发效率。本文将介绍Java常见log日志的使用方法，希望对Java开发者有所帮助。

一、Java常见Log日志框架

Java常见的Log日志框架有java.util.logging、log4j、logback。下面分别介绍它们的使用。

1、java.util.logging

java.util.logging是Java自带的一个日志框架，使用简单直接，但功能相对简单。

配置文件

通过修改配置文件logging.properties，可以控制日志输出的级别和格式。配置文件默认在jre目录下，也可以自定义路径。

以下是配置文件示例：

handlers = java.util.logging.ConsoleHandler
.level = ALL

java.util.logging.ConsoleHandler.level = ALL
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
java.util.logging.SimpleFormatter.format=%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS [%4$s] %5$s %n

在代码中使用

import java.util.logging.Logger;

public class MyClass {
    private static final Logger LOGGER = Logger.getLogger(MyClass.class.getName());

    public void myMethod() {
        LOGGER.info("Info log");
        LOGGER.warning("Warning log");
        LOGGER.severe("Severe log");
    }
}

2、Log4j

Log4j是一个功能强大的日志框架，支持多种输出方式和灵活的配置。在下文中笔者以Log4j2为例进行介绍。

配置文件

Log4j2的配置文件默认为log4j2.xml，也可以通过指定系统属性log4j.configurationFile指定。

以下是配置文件示例：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="info">
    <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>

上述配置文件定义了一个输出级别为debug的控制台appender。

在代码中使用

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 void myMethod() {
        LOGGER.debug("Debug log");
        LOGGER.info("Info log");
        LOGGER.warn("Warn log");
        LOGGER.error("Error log");
    }
}

3、Logback

Logback在性能上比Log4j更优秀，并且配置更灵活。

配置文件

Logback的配置文件默认为logback.xml，也可以通过指定系统属性logback.configurationFile指定。

以下是配置文件示例：

<?xml version="1.0" encoding="UTF-8"?>
<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>

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

上述配置文件定义了一个输出级别为debug的控制台appender。

在代码中使用

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 log");
        LOGGER.info("Info log");
        LOGGER.warn("Warn log");
        LOGGER.error("Error log");
    }
}

二、示例说明

下面通过两个实例展示如何使用Log日志来记录应用程序中的事件和错误信息。

示例1：使用Log4j记录异常信息

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 void myMethod() {
        try {
            // some code
        } catch (Exception e) {
            LOGGER.error("Error occurred", e);
        }
    }
}

此处通过LOGGER.error()方法来记录异常信息，第二个参数e代表抛出的异常。

示例 2：使用Logback记录请求信息

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

public class MyController {
    private static final Logger LOGGER = LoggerFactory.getLogger(MyController.class);

    public Response helloWorld(String name) {
        LOGGER.info("Received request, name:{}", name);
        // some code
    }
}

此处通过LOGGER.info()方法来记录请求参数信息。

结论

本文详细介绍了Java常见Log日志框架的使用方法，并通过示例进行了说明。建议Java开发者掌握至少一种日志框架，并在项目中进行使用。