学习总结——在springboot中使用slf4j日志

1. slf4j简单介绍：

        slf4j（Simple Logging Facade for Java）是一个简单、通用的日志门面，它可以用来在Java应用程序中进行日志记录。 slf4j为开发人员提供了一个统一的接口，使他们可以在不同的日志实现之间进行切换，而无需改变应用程序的代码。

         slf4j的设计目标是使日志记录操作对于开发人员来说尽可能简单，同时保持灵活性和可扩展性。它提供了一组简单的接口，开发人员可以使用这些接口来记录日志消息，包括调试信息、警告、错误等。

         slf4j并不直接实现日志记录功能，而是为开发人员提供了一个抽象层，使他们可以选择和切换不同的日志框架，如logback、log4j、java.util.logging等。通过这种方式，开发人员可以根据自己的需求选择最合适的日志实现，而无需修改应用程序的代码。

         slf4j的使用非常简单，开发人员只需要在应用程序中引入相应的SLF4J接口和实现，然后通过 slf4j接口进行日志记录操作。 slf4j提供了多个不同级别的日志记录方法，开发人员可以根据需要选择适当的级别。

        总的来说， slf4j是一个轻量级、灵活且易于使用的日志门面，它可以帮助开发人员在Java应用程序中实现简单、统一的日志记录。它的设计使得日志记录变得简单而灵活，并且可以与不同的日志实现无缝集成。

2.  slf4j的相关配置

2.1 在pom文件中的相关依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j</artifactId>
    <version>1.3.8.RELEASE</version>
</dependency>

2.2 在 resources 根目录下创建一个 log4j 的配置文件 log4j.properties

log4j.rootLogger=DEBUG, stdout 根日志记录器，参数 1 为需要输出的日志等级，
参数 2 为日志输出的目标地名称 stuout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender 设置 stdout 是控制台
输出
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 配置日志输出的
格式
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

2.3 编程中使用日志记录器输出用户自定义日志信息

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

Log4j 输出的目的地

org.apache.log4j.ConsoleAppender（控制台）

org.apache.log4j.FileAppender（文件）

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）

org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

3. logback.xml 配置文件解析

        在 application.yml 文件中，指定了日志配置文件 logback.xml，logback.xml 文件中主要用来做日志的相关配置。在 logback.xml 中可以定义日志输出的格式、路径、控制台输出格式、文件大小、保存时长等。

3.1 定义日志输出格式和存储路径

<configuration> 可以理解为定义常量，name 就是常量名称，value 就是对应的值
    <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level%logger{36} - %msg%n" />
    <property name="FILE_PATH" value="D:/logs/demo.%d{yyyy-MM-dd}.%i.log" />
</configuration>

        配置文件的含义：首先定义一个格式，命名为 LOG_PATTERN，该格式中%date 表示日期，%thread 表示线程 名，%-5level 表示级别从左显示 5 个字符宽度，%logger{36}表示 logger 名字最长 36 个字符，%msg 表示日 志消息，%n 是换行符。 然后再定义一下名为 FILE_PATH 文件路径，日志都会存储在该路径下。%i 表示第 i 个文件，当日志文件达到 指定大小时，会将日志生成到新的文件里，这里的 i 就是文件索引，日志文件允许的大小可以设置。这里需要 注意的是，不管是 windows 系统还是 Linux 系统，日志存储的路径必须要是绝对路径。

3.2 定义控制台输出

<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder><!-- 按照上面配置的 LOG_PATTERN 来打印日志 -->
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
</configuration>

        使用节点设置个控制台输出 class="ch.qos.logback.core.ConsoleAppender"的配置，定义为CONSOLE。使用上面定义好的输出格式 LOG_PATTERN 来输出，使用${}引用进来即可。

3.3 定义日志文件的相关参数

<configuration>
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按照上面配置的 FILE_PATH 路径来保存日志 -->
            <fileNamePattern>${FILE_PATH}</fileNamePattern>
            <maxHistory>15</maxHistory> <!--日志保存 15 天-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize> 单个日志文件的最大，超过则新建日志文件存储
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <!-- 按照上面配置的 LOG_PATTERN 来打印日志 -->
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
</configuration>

使用<appender>定义一个名为 FILE 的文件配置，主要是配置日志文件保存的时间、单个日志文件存储的大小、 以及文件保存的路径和日志的输出格式。

3.4定义日志输出级别

<configuration>
    <logger name="com.yan" level="INFO" />
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

有了上面那些定义后，最后使用来定义一下项目中默认的日志输出级别，这里定义级别为 INFO，然 后针对 INFO 级别的日志，使用引用上面定义好的控制台日志输出和日志文件的参数。这样 logback.xml文件中的配置就设置完了。