Spring Boot 2 Logging SLF4j Logback和LOG4j2示例

转x33g5p2x  于2022-10-06 转载在 Spring  
字(8.2k)|赞(0)|评价(0)|浏览(629)

在这篇文章中，我们将学习如何用Spring Boot有效地记录。我们将看看Spring Boot Starterfor Logging。我们将看看Spring Boot中默认的Logging - Logback和SLF4J。我们还将研究Spring Boot启动器的log4j2。
首先，我们将讨论关于Spring Boot日志功能的几个要点，然后我们将创建一个简单的例子来演示。

Spring Boot 2日志功能概述

日志是任何应用程序的一个非常重要的部分，它有助于对问题进行调试。Spring Boot默认将spring-boot-starter-logging作为spring-boot-starter模块的过渡依赖。默认情况下，Spring Boot包括SLF4J和Logbackimplementations。

如果Logback可用，Spring Boot将选择它作为日志处理器。你可以在application.properties文件中轻松地配置日志级别，而不需要创建特定于日志提供者的配置文件，如logback.xml或log4j.properties。

  1. logging.level.org.springframework.web=INFO
  2. logging.level.org.hibernate=ERROR
  3. logging.level.net.guides=DEBUG

如果你想在控制台之外将数据记录到一个文件中，请按以下方式指定文件名

  1. logging.path=/var/logs/app.log
  2. or
  3. logging.file=myapp.log

如果你想对日志配置有更多控制，可以在默认位置创建日志提供者特定的配置文件，Spring Boot会自动使用这些文件。
例如，如果你将logback.xml文件放在根classpath中，Spring Boot将自动使用它来配置日志系统

logback.xml文件

  1. <configuration>
  2.     <appender name="STDOUT"
  3.         class="ch.qos.logback.core.ConsoleAppender">
  4.         <encoder>
  5.             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
  6.         </encoder>
  7.     </appender>
  8.     <appender name="FILE" class="ch.qos.logback.core.FileAppender">
  9.         <file>app.log</file>
  10.         <encoder>
  11.             <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n </pattern>
  12.         </encoder>
  13.     </appender>
  14.     <logger name="com.apress" level="DEBUG" additivity="false">
  15.         <appender-ref ref="STDOUT" />
  16.         <appender-ref ref="FILE" />
  17.     </logger>
  18.     <root level="INFO">
  19.         <appender-ref ref="STDOUT" />
  20.         <appender-ref ref="FILE" />
  21.     </root>
  22. </configuration>

在Spring Boot中使用Log4j2进行日志记录

如果你想使用其他日志库，如Log4J or Log4j2，而不是Logback，你可以排除spring-boot-starter-logging，并包括各自的日志启动器，如下所示。

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter</artifactId>
  4.     <exclusions>
  5.         <exclusion>
  6.             <groupId>org.springframework.boot</groupId>
  7.             <artifactId>spring-boot-starter-logging</artifactId>
  8.         </exclusion>
  9.     </exclusions>
  10. </dependency>
  11. <dependency>
  12.     <groupId>org.springframework.boot</groupId>
  13.     <artifactId>spring-boot-starter-log4j</artifactId>
  14. </dependency>

现在你可以把log4j.properties文件添加到根classpath中，Spring Boot将自动使用该文件进行日志记录。

日志格式

Spring Boot的默认日志输出类似于以下例子：

  1. 2014-03-05 10:57:51.112  INFO 45469 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/7.0.52
  2. 2014-03-05 10:57:51.253  INFO 45469 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
  3. 2014-03-05 10:57:51.253  INFO 45469 --- [ost-startStop-1] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1358 ms
  4. 2014-03-05 10:57:51.698  INFO 45469 --- [ost-startStop-1] o.s.b.c.e.ServletRegistrationBean        : Mapping servlet: 'dispatcherServlet' to [/]
  5. 2014-03-05 10:57:51.702  INFO 45469 --- [ost-startStop-1] o.s.b.c.embedded.FilterRegistrationBean  : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]

输出的项目如下。

  • 日期和时间：精确到毫秒，易于排序。
  • 日志级别。ERROR, WARN, INFO, DEBUG, or TRACE。
  • 进程ID。
  • 一个---分隔符，以区分实际日志信息的开始。
  • 线程名称：包含在方括号中（对于控制台输出可能会被截断）。
  • 记录器名称：这通常是源类的名称（通常是缩写）。
  • 日志信息。

控制台输出

默认的日志配置是在写信息的时候向控制台回音。默认情况下，ERROR级,****WARN-level,和INFO级消息被记录。你也可以通过用--debug标志启动你的应用程序来启用 "调试 "模式。

你也可以在你的application.properties中指定debug=true。

文件输出

默认情况下，Spring Boot只向控制台记录日志，不写日志文件。如果你想在控制台输出之外写日志文件，你需要设置一个logging.file或logging.path属性（例如，在你的application.properties中）。

到目前为止，我们已经了解了Spring Boot中的日志工作方式和默认配置。现在是时候在我们的项目中使用Spring Boot 2的日志功能了，让我们创建一个例子来演示如何使用Spring Boot 2的日志功能。

简单的Spring Boot 2日志应用

让我们开发一个简单的内存中Spring Boot 2日志应用程序。

1. 创建和导入一个项目

创建Spring Boot应用程序的方法有很多。最简单的方法是在http://start.spring.io/使用Spring Initializr，它是一个在线Spring Boot应用程序生成器。

看上面的图，我们指定了以下细节。

Generate。Maven项目
Java版本。1.8 (默认)
Spring Boot：2.0.4
Group: net.guards.springboot2
Artifact: springboot2-logging
Name: springboot2-logging
Package Name: net.guards.springboot2.springboot2-logging
Packaging: jar (这是默认值)
Dependencies: 网络

一旦，所有的细节被输入，点击生成项目按钮将生成一个spring boot项目并下载它。接下来，解压下载的压缩文件并将其导入你最喜欢的IDE。

2. 包结构

一旦我们将生成的spring boot项目导入IDE，我们将看到一些自动生成的文件。参考上图了解项目结构。

3. pom.xml文件

  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.  <modelVersion>4.0.0</modelVersion>
  7.     <groupId>net.guides.springboot2</groupId>
  8.     <artifactId>springboot2-logging</artifactId>
  9.     <version>0.0.1-SNAPSHOT</version>
  10.     <packaging>jar</packaging>
  12.     <name>springboot2-logging</name>
  13.     <description>Demo project for Spring Boot</description>
  15.     <parent>
  16.         <groupId>org.springframework.boot</groupId>
  17.         <artifactId>spring-boot-starter-parent</artifactId>
  18.         <version>2.0.4.RELEASE</version>
  19.         <relativePath /> <!-- lookup parent from repository -->
  20.     </parent>
  22.     <properties>
  23.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  24.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  25.         <java.version>1.8</java.version>
  26.     </properties>
  28.     <dependencies>
  29.         <dependency>
  30.             <groupId>org.springframework.boot</groupId>
  31.             <artifactId>spring-boot-starter-web</artifactId>
  32.         </dependency>  
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-starter-test</artifactId>
  36.             <scope>test</scope>
  37.         </dependency> 
  38.     </dependencies>
  40.     <build>
  41.         <plugins>
  42.             <plugin>
  43.                 <groupId>org.springframework.boot</groupId>
  44.                 <artifactId>spring-boot-maven-plugin</artifactId>
  45.             </plugin>
  46.         </plugins>
  47.     </build>
  48. </project>

4. Springboot2LoggingApplication.java文件

这个类提供了一个带有*public static void main(String[] args)*方法的入口，你可以运行它来启动应用程序。

  1. import org.springframework.boot.SpringApplication;
  2. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. @SpringBootApplication
  5. public class Springboot2LoggingApplication {
  6.     public static void main(String[] args) {
  7.         SpringApplication.run(Springboot2LoggingApplication.class, args);
  8.     }
  9. }

5. 创建简单的POJO类 - Article.java

  1. package net.guides.springboot2.springboot2logging;
  3. public class Article {
  4.     private int id;
  5.     private String name;
  6.  
  7.  
  8.     public Article(int id, String name) {
  9.         super();
  10.         this.id = id;
  11.         this.name = name;
  12.     }
  13.  
  14.     public int getId() {
  15.         return id;
  16.     }
  17.     public void setId(int id) {
  18.         this.id = id;
  19.     }
  20.     public String getName() {
  21.         return name;
  22.     }
  23.     public void setName(String name) {
  24.         this.name = name;
  25.     }
  26. }

6. 创建简单的服务类--ArticleService.java

  1. package net.guides.springboot2.springboot2logging;
  3. import java.util.Arrays;
  4. import java.util.List;
  6. import org.slf4j.Logger;
  7. import org.slf4j.LoggerFactory;
  8. import org.springframework.stereotype.Service;
  10. @Service
  11. public class ArticleService {
  12.     private static final Logger logger = LoggerFactory.getLogger(ArticleService.class);
  13.     public List<Article> getArticles(){
  14.         logger.debug("inside getArticles() method");
  15.         return Arrays.asList(new Article(100, "article"),new Article(200, "article2"));
  16.     }
  17. }

注意，我们已经添加了slf4jLogger，也添加了调试语句。

  1. private static final Logger logger = LoggerFactory.getLogger(ArticleService.class);

7. 创建简单的休息控制器 - ArticleController.java

  1. package net.guides.springboot2.springboot2logging;
  3. import java.util.List;
  5. import org.slf4j.Logger;
  6. import org.slf4j.LoggerFactory;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.web.bind.annotation.GetMapping;
  9. import org.springframework.web.bind.annotation.RestController;
  11. @RestController
  12. public class ArticleController {
  13.     private static final Logger logger = LoggerFactory.getLogger(ArticleService.class);
  14.     @Autowired
  15.     private ArticleService articleService;
  16.     @GetMapping("/articles")
  17.     public List<Article> getArticles() {
  18.         logger.debug("inside ArticleController.getArticles() method");
  19.         return articleService.getArticles();
  20.     }
  21. }

注意，我们已经添加了slf4jLogger，也添加了调试语句。这些调试语句打印在控制台中。

8. application.properties文件

让我们在an application.properties文件中配置日志属性。打开一个application.properties文件，在其中添加以下日志配置。

9. 运行一个应用程序

现在将Springboot2LoggingApplication.java作为一个Java应用程序运行。调用REST API：http://localhost:8080/articles。你应该看到JSON格式的文章列表。

  1. [{"id":100,"name":"article"},{"id":200,"name":"article2"}]

注意myapp.log文件在你正确的项目位置被创建。

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://www.javaguides.net/2018/09/spring-boot-2-logging-slf4j-logback-and-log4j-example.html

内容来源于网络，如有侵权，请联系作者删除！

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com