java引入日志 springboot maven

实现Java引入日志的步骤

1. 引入依赖

首先，在项目的pom.xml文件中引入日志相关的依赖。在使用Spring Boot和Maven构建项目的情况下，通常使用logback作为日志框架。可以在pom.xml文件的<dependencies>标签中添加以下依赖：

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
</dependency>

2. 配置日志文件

在src/main/resources目录下创建一个名为logback.xml的文件，用于配置日志文件的输出方式和格式。以下是一个简单的logback.xml配置示例：

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

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

此配置将日志输出到控制台，并显示日志的日期、线程、日志级别、类名和消息。

3. 添加日志代码

在需要进行日志记录的Java类中，使用日志框架提供的API来记录日志。以下是一个使用logback的示例：

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

public class ExampleClass {
    private static final Logger logger = LoggerFactory.getLogger(ExampleClass.class);

    public void doSomething() {
        logger.info("This is an info message");
        logger.error("This is an error message");
    }
}

上述代码中，通过LoggerFactory.getLogger()方法获取Logger实例，参数为当前类的Class对象。然后可以使用logger的不同方法来记录不同级别的日志。

4. 运行项目并查看日志输出

配置完成后，可以运行Spring Boot项目并查看日志输出。日志将显示在控制台或指定的日志文件中，根据logback.xml中的配置进行输出。

整体流程示意图

pie
    "引入依赖" : 1
    "配置日志文件" : 1
    "添加日志代码" : 1
    "运行项目并查看日志输出" : 1

代码注释解释

1. 引入依赖：

   <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
   </dependency>
   

   该代码片段在pom.xml文件中添加了logback-classic依赖，使得我们能够使用logback作为日志框架。

2. 配置日志文件：

   <configuration>
       <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
           <encoder>
               <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern>
           </encoder>
       </appender>
   
       <root level="INFO">
           <appender-ref ref="STDOUT" />
       </root>
   </configuration>
   

   这段代码配置了日志文件的输出方式和格式，使用ConsoleAppender将日志输出到控制台，并指定了一个简单的日志格式。

3. 添加日志代码：

   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   
   public class ExampleClass {
       private static final Logger logger = LoggerFactory.getLogger(ExampleClass.class);
   
       public void doSomething() {
           logger.info("This is an info message");
           logger.error("This is an error message");
       }
   }
   

   这段代码使用slf4j提供的LoggerFactory和Logger类来记录日志。通过getLogger方法，我们可以获取一个Logger实例，参数为当前类的Class对象。然后，我们可以使用logger的不同方法来记录不同级别的日志。

4. 运行项目并查看日志输出： 运行项目后，可以在控制台或指定的日志文件中查看日志输出。根据logback.xml中的配置，日志将以指定的格式输出。