日志框架-SLF4J

无奇不有不置可否

已于 2023-04-13 16:09:01 修改

阅读量362

点赞数 1

文章标签： java spring boot log4j

于 2023-03-20 10:18:10 首次发布

本文链接：https://blog.csdn.net/qq_45759354/article/details/127427410

版权

一、日志框架简介

市面上许多的日志框架，例如JCL,JUL,log4j,log4j2,logback,slf4j,jboss-logging等。SpringBoot框架内部使用JCL，Spring-boot-starter-logging采用slf4j+logback的形式。

二、SLF4J

2.1 slf4j理解

开发的时候，日志记录方法的，不应该直接调用日志的实现类，而是调用日志抽象层中的方法
编写代码的时候，只会使用这个jar包里的API，应用程序在运行时去类路径下查找绑定的具体日志框架，并使用该绑定的日志框架进行实际的日志操作
如果在应用程序的类路径下面没有找到合适的绑定的话，slf4j默认使用一个没有任何操作的实现
每一个日志的实现框架都有自己的配置文件，使用slf4j时，配置文件还是做成日志实现框架的配置文件

2.2 slf4j的使用逻辑

如何让系统中所有的日志都统一到sIf4j ：

将系统中其他日志框架先排除出去;
用中间包来替换原有的日志框架;
我们导入slf4j其他的实现

2.3 SpringBoot日志关系

SpringBoot使用它来做日志场景：

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

在这里插入图片描述

SpringBoot底层也是使用slf4j+logback的方式进行日志记录
SpringBoot也把其他的日志都替换成了slf4j
SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉

2.4 SpringBoot使用slf4j

2.4.1 代码编写

日志的级别：由低到高 trace < debug < info < warn < error

package com.study.java_jdk8_springboot;

import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class JavaJdk8SpringBootApplicationTests {

    Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    void contextLoads() {
        // 日志的级别：由低到高 trace < debug < info < warn < error
        // 可以调整输出的日志级别
        logger.trace("这是trace日志...");
        logger.debug("这是debug日志...");
        // SpringBoot默认使用info级别的日志，所以只输出info以上级别的日志
        logger.info("这是info日志...");
        logger.warn("这是warn日志...");
        logger.error("这是error日志...");
    }
}

2.4.2 默认配置

spring.application.name=Java_JDK8_SpringBoot
server.port=8080
# 日志
# 指定整个项目的日志级别
logging.level.root=trace
# 指定某个包的日志级别
logging.level.com.study=trace
# 将日志输出成文件
logging.file.name=springboot.log
# 在控制台输出的日志格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 在指定文件中日志输出格式
logging.pattern.file=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n

日志输出格式:
%d表示日期时间，
%thread表示线程名，
%-5level :级别从左显示5个字符宽度
%logger{5e}表示logger名字最长50个字符，否则按照句点分割。
%msg :日志消息，
%n是换行符

2.4.3 指定配置

给类路径下放上每个日志框架自己的配置文件即可，SpringBoot就不使用它默认配置的了
在这里插入图片描述

logback.xml :直接就被日志框架识别了;
logback-spring.xml:日志框架就不直接加载日志的配置项,由SpringBoot解析日志配置，可以使用SpringBoot的高级profile功能

<!-- 可以指定某段配置只在某个环境下生效 -->
<!-- 比如指定在dev环境下生效 -->
<!-- 需要在配置文件中加入spring.profiles.active=dev配置 -->
<appender name=" stdout" class=" ch.qos.logback.core.ConsoleAppender">
	<layout class="ch.qos.logback.classic.PatternLayout">
		<springProfile name="dev">
			<pattern>%d{yyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{5e} - %msg%n</pattern>
		</springProfile>
		<springProfile name="!dev">
			<pattern>%d{yyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} %msg%n</pattern>
		</springProfile>
	</layout>
</appender>

三、普通项目使用slf4j

3.1 进入依赖

普通项目使用slf4j，需要slf4j日志门面，中间层和实现层合作，才能使用slf4j。可以增加lombok依赖，进行注解开发。

<!-- 日志门面 -->
<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-api</artifactId>
	<version>2.0.5</version>
</dependency>
<!-- 中间层 -->
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
  <version>1.8.0-beta4</version>
</dependency>
<!-- 实现层 -->
<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>1.2.17</version>
</dependency>
<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.18.24</version>
</dependency>

3.2 配置文件

<?xml version="1.0" encoding="UTF-8"?>
<!--
    status : 这个用于设置log4j2自身内部的信息输出,可以不设置,当设置成trace时,会看到log4j2内部各种详细输出。
    因此我们直接设置成OFF
 -->
<Configuration status="OFF">
    <!-- 配置输出端  -->
    <Appenders>
        <!-- 输出到控制台  -->
        <Console name="Console" target="SYSTEM_OUT">
<!--            <PatternLayout pattern="[%-level]%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %logger{36} - %msg%n"/>-->
            <PatternLayout pattern="%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n"/>
        </Console>

        <!-- 输出到文件 -->
        <!--
            name:           输出端的名字
            fileName:       指定当前日志文件的位置和文件名称
            filePattern:    指定当发生自动封存日志时，文件的转移和重命名规则
            这个filePatten结合下面的TimeBasedTriggeringPolicy一起使用，可以实现控制日志按天生成文件.
            自动封存日志的策略可以设置时间策略和文件大小策略（见下面的Policies配置）
            时间策略：
                文件名_%d{yyyy-MM-dd}_%i.log  这里%d表示自动封存日志的单位是天
                如果下面的TimeBasedTriggeringPolicy的interval设为1,
                表示每天自动封存日志一次;那么就是一天生成一个文件。
            文件大小策略：
                如果你设置了SizeBasedTriggeringPolicy的size的话，
                超过了这个size就会再生成一个文件，这里的%i用来区分的
            %d{yyyy-MM-dd}会自动替代为日期，如2017-06-30
        -->
        <RollingFile name="RollingFileInfo" fileName="/log/guitool_info.log"
                     filePattern="/log/%d{yyyy-MM-dd}/guitool_%d{yyyy-MM-dd}_%i.log">
            <!-- 只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <!-- 输出的格式  -->
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <!--
                Policies：自动封存日志策略，表示日志什么时候应该产生新日志，
                可以有时间策略和大小策略等，并且：只有满足一个策略，就好生成一个新的文件。
                这里使用的是时间和大小都使用了，每隔1天产生新的日志文件
                如果果今天的文件大小到了设定的size，则会新生成一个文件，上面的%i就表示今天的第几个文件
             -->
            <Policies>
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="20MB"/>
            </Policies>
            <!--
                DefaultRolloverStrategy属性如不设置，
                则默认为最多同一文件夹下7个文件，这里设置了20
             -->
            <DefaultRolloverStrategy max="20"/>
        </RollingFile>
    </Appenders>
    <!-- 配置Loggers  -->
    <Loggers>
        <!--
            Logger： 用于指定部分包的日志级别
                日志级别局部的会覆盖全局的
                比如这里hibernate的级别设为debug，而控制台没有设级别，那么控制台会打印debug级别的日志
                而输出到文件这个输出端设置了info级别，那么hibernate的debug级别的日志还是看不了。
                所以最终输出的级别和输出端设置的级别是有关系的。
            name: 包名
            level：日志级别
            additivity：是否冒泡，既在当前logger的输出端输出日志后
                             是否需要在父输出端上输出该日志，默认为 true。
                             如果设为false，则必须配置AppendRef。
         -->
        <Logger name="cn.bjca.sdk" level="error" additivity="true"/>

        <!-- 这个root是配置全局日志级别和输出端功能和老版的log4j中根的配置是一样的 -->
        <Root level="info">
            <!-- 这里引用上面定义的输出端，千万不要漏了。 -->
            <AppenderRef ref="Console"/>
            <!--<AppenderRef ref="RollingFileInfo"/>-->
        </Root>
    </Loggers>
</Configuration>