浅谈Java Spring Boot日志管理

作为 Java 程序员，我们使用日志来记录程序运行过程中的状态信息和错误信息。Spring Boot 提供了使用很方便的日志处理方式。在本文中，我们将介绍如何在 Spring Boot 项目中管理日志。

添加日志依赖

Spring Boot 自带日志框架，常用的是 logback 和 log4j2。如果你想使用其他日志框架，需要在 pom.xml 中添加相应的依赖。

在本文中，我们将使用 logback，可以在 pom.xml 文件中添加以下依赖：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-logback</artifactId>
</dependency>

配置日志

在 Spring Boot 中配置日志是非常简单的。默认情况下，Spring Boot 使用内置的日志配置，但是我们可以在 application.properties 或 application.yml 中自定义日志配置。

下面是一个简单的 application.properties 文件示例：

# 设置日志级别为 INFO
logging.level.root=INFO

# 设置日志文件路径
logging.file.name=myapp.log

如果你使用的是 yaml 文件，可以使用下面的配置：

logging:
  file:
    name: myapp.log
  level:
    root: INFO

使用日志

在编写 Java 代码时，我们可以使用如下方式来使用日志：

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

@RestController
public class MyController {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @GetMapping("/hello")
    public String sayHello() {
        logger.info("Hello World!");
        return "Hello World!";
    }
}

在上面的代码中，我们使用了 org.slf4j.Logger 接口打印日志，并使用 org.slf4j.LoggerFactory 工厂类获取 Logger 对象。根据需要可以使用 trace、debug、info、warn、error 等方法来打印不同级别的日志。

日志输出格式

默认情况下，logback 日志输出格式为：

%d [%thread] %-5level %logger{35} - %msg%n

其中，%d 表示日期时间，%thread 表示线程名，%-5level 表示日志级别（最长为 5 个字符），%logger{35} 表示 logger 名称（最长为 35 个字符），%msg 表示日志消息，%n 表示换行符。

我们可以在 application.properties 或 application.yml 中通过 logging.pattern.console 或 logging.pattern.file 来修改日志输出格式。

例如，我们可以在 application.properties 通过以下方式修改输出格式：

logging.pattern.console=【%d{yyyy-MM-dd HH:mm:ss}】 【%thread】 【%level】 【%logger{35}】 - 【%msg】 %n

示例

以下是一个 Spring Boot 应用程序的示例，展示了如何使用日志记录应用程序中的信息和错误。

1. 添加依赖

在 pom.xml 中添加以下依赖：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-logback</artifactId>
</dependency>

2. 编写代码

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class MyApp {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }

    @GetMapping("/")
    public String index() {
        logger.info("Received index request");
        return "Hello World!";
    }

    @GetMapping("/error")
    public String error() {
        try {
            int i = 1 / 0;
        } catch (Exception e) {
            logger.error("An error occurred", e);
        }
        return "Error occurred!";
    }
}

3. 运行程序

运行程序并访问网址 http://localhost:8080，你会看到如下输出：

00:00:00.215 [http-nio-8080-exec-1] INFO  com.example.demo.MyApp - Received index request

当你访问网址 http://localhost:8080/error 时，程序将会除以零并抛出异常：

00:00:10.796 [http-nio-8080-exec-4] ERROR com.example.demo.MyApp - An error occurred
java.lang.ArithmeticException: / by zero
    at com.example.demo.MyApp.error(MyApp.java:33)

小结

在本文中，我们介绍了如何在 Spring Boot 中管理日志。首先，我们添加了依赖并配置了日志，并简述了如何使用日志。最后，通过一个简单的示例演示了如何在应用程序中使用日志记录信息和错误。