在 Spring Boot中配置日志

桃扇骨 2023-09-25 13:16 51阅读 0赞

Spring Boot 在引擎盖下使用[Apache Commons Logging][]。但是，它允许您选择所需的日志记录库。让我们来看看使用 Spring Boot 时的一些配置和最佳实践。

### 目录 ###

*  [概述][Link 1]
 *  [简单日志记录示例][Link 2]
 *  [配置日志记录][Link 3]
    
     *  [更改日志级别][Link 4]
     *  [将日志写入文件][Link 5]
     *  [在 Spring 引导中更改日志记录模式][Spring]
 *  [对日志条目进行颜色编码][Link 6]
 *  [自定义日志记录配置文件][Link 7]
 *  [Log4j2 用于 Spring 引导日志记录][Log4j2 _ Spring]
 *  [总结][Link 8]
 *  [相关][Link 9]

### 概述 ###

默认情况下，如果使用**[启动器][Link 10]**，则应用程序将使用[Logback][]进行日志记录。该框架还提供各种日志路由，以确保其他日志记录库开箱即用。这样，您可以将 Logback 与 Log4j2 或 JUL 交换。

在进一步讨论之前，有许多用于Java的日志记录框架。在大多数情况下，您不需要在 Spring 引导中更改日志记录依赖项。

### 简单日志记录示例 ###

让我们使用示例控制器演示 spring-boot 中的日志记录。

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.*;
    
    
    @Controller
    public class TestController {
    
      private static final Logger log = LoggerFactory.getLogger(TestController.class);
    
      @RequestMapping("/test")
      @ResponseBody
      String hello(@RequestParam("name") String name) {
        log.trace("Hello {}", name);
        log.debug("Hello {}", name);
        log.info("Hello {}", name);
        log.warn("Hello {}", name);
        log.error("Hello {}", name);
        return "Hello";
      }
    }

使用上述控制器，如果您点击***http://localhost:8080/test?name=John Doe***，那么您将在控制台输出中看到一些日志。就是这样，您已经在项目中成功使用了日志记录。

最好的部分是，您没有配置任何内容。

### 配置日志记录 ###

Spring 引导带有一些用于日志记录的默认配置。例如，它开箱即用地打印到控制台，它具有详细的消息日志模式，我们将详细查看，最后，它仅打印具有 INFO 或更高版本的日志级别。

让我们看看如何覆盖这些行为。

#### 更改日志级别 ####

如果您已经看到了上一节中的示例，则日志将仅包含 INFO 或更高版本的打印条目。但是，如果您希望覆盖此行为，则 Spring boot 允许您根据类和包配置日志记录级别。

例如，您可以为*TestController*启用跟踪日志，如下所示。

`logging.level.com.springhow.examples.logging.controllers.TestController=TRACE`

如果您希望为包下的所有类启用调试日志，则可以像下面这样操作。

`logging.level.com.springhow.examples.logging.controllers=DEBUG`

您还可以将不同的包和类分组到组中。例如，可以将与 API 相关的所有包列出到记录器组中。然后，您可以为其指定日志记录级别。

`#Define a group logging.group.api=com.springhow.web,com.springhow.services,com.springhow.domain #Specify a logging level for that group logging.level.api=DEBUG`

使用此方法，您无需定义三个单独的日志记录级别。此外，它使配置文件看起来干净。

为了方便起见，Spring boot 提供了**Web**和**sql**以及日志记录组，以便我们可以轻松地配置它们以进行调试。

#### 将日志写入文件 ####

默认情况下，Spring 引导将所有日志打印到控制台。但是，通过以下配置，您也可以启用基于文件的日志记录。例如，以下配置在当前工作目录中创建一个日志文件。

`logging.file.name=springhow.log`

您还可以为文件名提供完整路径

`logging.file.name=/var/log/springhow.log`

或者，您可以提供日志记录文件路径。

`logging.file.path=/var/log/`

使用“*logging.file.path*”的唯一例外是 Spring boot 将在给定路径下创建一个名为 “**spring.log**” 的日志文件。

对于***WINDOWS，***所有绝对路径都从**C：\\**drive 转换。因此，“/var/log*/*”变为“*c：\\var\\log\\*”。

最重要的是，如果您同时使用 logging.file.name和*logging.file.path*，则*logging.file.name*将优先。

#### 在 Spring 引导中更改日志记录模式 ####

Spring Boot 的默认记录器格式/模式如下所示。

![837c44d02cfe991deb43aec5fa822e10.png][]

对于许多人来说，这种充满活力的伐木模式绰绰有余。但是，如果您希望更改此日志模式，则可以使用“logging.pattern.console”和“***logging.pattern.file***”属性。

在下面的示例中，我们可以看到覆盖日志格式是多么容易。

`logging.pattern.console=%p %d{yyyy-MM-dd HH:mm:ss.SSS} : [%t] %-40.40logger{39} : %m%n`

![41aa326cf48f72518c15570aa755e684.png][]

如图所示，日志级别位于行首，不再有鲜艳的颜色。有关详细信息，请查看[登录模式文档][Link 11]。

### 对日志条目进行颜色编码 ###

在支持 ANSI 颜色的环境中，您可以使用可以使用不同颜色的不同日志组件的模式。例如，可以使用 %***clr（%p）*** 通过日志记录级别来设置颜色。此处，%p 表示日志记录级别。

![1f4d1ce2ee9cd784bd6749f35de0a09f.png][]

在这里，所有的颜色映射都由弹簧启动提供。如果您希望为日志组件指定颜色，也可以这样做。

`logging.pattern.console=%clr(%p) %d{yyyy-MM-dd HH:mm:ss.SSS} : [%t] %clr(%-40.40logger{39}){red} : %m%n`

上述配置的结果是，

![ce532bc3b75cffd591bb821ba27502bf.png][]

为*logging.pattern.file*设置颜色编码是没有意义的，因为文件不会转换 ANSI 颜色编码。所以你会看到一堆胡言乱语。

### 自定义日志记录配置文件 ###

所有这些默认行为都是可能的，因为 Spring 引导附带[了默认的日志记录配置文件][Link 12]。它还为我们提供了在某种程度上配置这些配置的方法。

但是，如果您希望使用更野蛮的配置，那么您也可以提供自己的配置。只需在*src/main/resources/*下提供一个*logback.xml*或*logback-spring.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>
    
      <root level="debug">
        <appender-ref ref="STDOUT" />
      </root>
    </configuration>

请注意，一旦您添加 logback.xml，就无法通过*application.properties* 自定义日志记录。

您还可以使用“**logging.config**”属性从外部位置加载日志记录配置。

`logging.config=/etc/myapp/logback.xml`

使用自定义配置，您几乎可以执行上述所有自定义。但唯一的问题是，您无法轻松地将 Spring 启动应用程序切换到不同的日志记录系统。例如，如果要切换到 Log4j2，则需要为该特定系统重新创建配置。

### Log4j2 用于 Spring 引导日志记录 ###

如果您没有自定义配置，那么在 Spring 启动中更改日志记录系统非常简单。例如，您可以通过使用 spring-boot-starter-log4j2 删除默认的**spring-boot-starter-logging**来交换到**Log4J2**。

日志记录启动器是核心启动器（弹簧启动启动器）的一部分。因此，您可以安全地从那里删除日志记录启动器。

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <exclusions>
        <exclusion>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
      </exclusions>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-log4j2</artifactId>
    </dependency>

即使您有许多不同的启动器，例如“web”，“jpa”等，它们现在都将排除用于日志记录的启动器，并将使用log4j2中的配置。最好的部分是，您不必更改 application.properties（ 如果您尚未指定与 logback 相关的任何内容）。

### 总结 ###

到目前为止，我们学习了 Spring 引导中的日志记录如何工作，如何配置它们，以及如何在 Spring 引导应用程序中用 log4j2 替换 logback。

### ***相关*** ###

*  [Apache Commons Logging – 解释][Apache Commons Logging]
 *  [在 Spring 引导中添加 Servlet 过滤器的方法][Spring _ Servlet]
 *  [在 Spring 引导中显示来自 Spring Data JPA/hibernate 的 SQL][Spring _ Spring Data JPA_hibernate _ SQL]
 *  [春季启动横幅 – 完整指南][Link 13]
 *  [Spring 框架中的 Setter 依赖注入][Spring _ Setter]

[Apache Commons Logging]: https://springhow.com/apache-commons-logging-explained/
[Link 1]: https://springhow.com/logging-in-spring-boot/#h-overview
[Link 2]: https://springhow.com/logging-in-spring-boot/#simple-logging-example
[Link 3]: https://springhow.com/logging-in-spring-boot/#configuring-logging
[Link 4]: https://springhow.com/logging-in-spring-boot/#changing-log-levels
[Link 5]: https://springhow.com/logging-in-spring-boot/#writing-logs-to-files
[Spring]: https://springhow.com/logging-in-spring-boot/#changing-logging-pattern-in-spring-boot
[Link 6]: https://springhow.com/logging-in-spring-boot/#color-coding-your-log-entries
[Link 7]: https://springhow.com/logging-in-spring-boot/#custom-logging-configuration-file
[Log4j2 _ Spring]: https://springhow.com/logging-in-spring-boot/#log4j2-for-spring-boot-logging
[Link 8]: https://springhow.com/logging-in-spring-boot/#summary
[Link 9]: https://springhow.com/logging-in-spring-boot/#related
[Link 10]: https://springhow.com/what-are-spring-boot-starters/
[Logback]: https://logback.qos.ch/
[837c44d02cfe991deb43aec5fa822e10.png]: https://img-blog.csdnimg.cn/img_convert/837c44d02cfe991deb43aec5fa822e10.png
[41aa326cf48f72518c15570aa755e684.png]: https://img-blog.csdnimg.cn/img_convert/41aa326cf48f72518c15570aa755e684.png
[Link 11]: https://logback.qos.ch/manual/layouts.html#conversionWord
[1f4d1ce2ee9cd784bd6749f35de0a09f.png]: https://img-blog.csdnimg.cn/img_convert/1f4d1ce2ee9cd784bd6749f35de0a09f.png
[ce532bc3b75cffd591bb821ba27502bf.png]: https://img-blog.csdnimg.cn/img_convert/ce532bc3b75cffd591bb821ba27502bf.png
[Link 12]: https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot/src/main/resources/org/springframework/boot/logging
[Spring _ Servlet]: https://springhow.com/filters-in-spring-boot/
[Spring _ Spring Data JPA_hibernate _ SQL]: https://springhow.com/spring-boot-show-sql/
[Link 13]: https://springhow.com/spring-boot-startup-banner/
[Spring _ Setter]: https://springhow.com/setter-dependency-injection-in-spring/