【SpringBoot】整合日志框架

2024-03-15 10:21:17

一、日志框架概述

1.1 日志框架的产生

  • 假想，你是某一公司的大型系统的项目经历，你想要记录系统运行是的一些信息：
    • 首先想到的是利用 System.out.println("") 将关键数据打印在控制台，但是这样着实是太麻烦，
    • 于是你就想将其日志信息输入到文件中，于是开发了一个框架来记录系统的一些运行时信息，这就是初代的日志框架zhanglogging.jar;
    • 后来你又想为其加入几个高级功能（异步模式、自动归档等等）zhanglogging-good.jar，于是第二代框架开发完毕但是由于系统用了初代的日志框架，将以前框架卸下来的话，换上新的框架，但是这样会有很大的工作量。
    • 为了以后框架的灵活性，于是你又重新修改之前相关API;这时想到了JDBC 数据库驱动的设计思路，设计出了 zhanglogging-prefect.jar;

1.2 市面上的日志框架

  • JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....

【SpringBoot】整合日志框架

  • 左边选一个门面(抽象层)、右边来选一个实现。
    • 日志门面: SLF4J;
    • 日志实现: Logback;
  • SpringBoot:底层是Spring框架，Spring框架默认是用JCL;
  • SpringBoot 选用SLF4j和logback;

二、SLF4j 使用与整合

2.1 如何在系统中使用SLF4j

官网地址

  • 以后开发的时候,日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法; 给系统里面导入slf4j的jar和 logback的实现jar

【SpringBoot】整合日志框架

  • 图中第一列：项目中只导入了slf4j的jar包，由于slf4j是抽象层，所以只能输出null
  • 图中第二列：项目中只导入了slf4j的jar包，而且还导入了logback 日志实现，这样正好可以进行日志输出，slf4j+lobback
  • 图中第三列：如果要使用slf4j+log4j ，由于log4j出现的比较早，并没有想到后面会出现slf4j这样的日志抽像层，所以就需要中间的一个适配层来进行适配，slf4j-log412.jar，上面实现了实现了slf4j抽象层，下面真正的实现有调用了log4j的日志实现。
  • 图中第四列：同上

  • 图中第五、六列：是slf4j的一个简单实现层

  • 每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件;

2.2 如何整合日志框架

  • SpringBoot中默认使用的日志框架slf4j+logback ，但是 Spring 中默认用commons-logging、Hibernate默认用jboss-logging ... ，
  • SpringBoot中 如何 统一日志记录，即使是别的框架和我一起统一使用slf4j进行输出?
  • 从下图可以看出，要将原来的日志框架替换成与其相对应的sf4j日志转换包就可以了。图片来源

【SpringBoot】整合日志框架

  • 如何让系统中所有的日志都统一到slf4j;
  • 1、将系统中其他日志框架先排除出去;
  • 2、用中间包来替换原有的日志门面框架;
  • 3、我们导入slf4j其他的实现

2.3 SpringBoot中的日志关系

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

底层依赖关系

【SpringBoot】整合日志框架

总结:

  • 1)、SpringBoot底层也是使用slf4j+logback的方式进行日志记录
  • 2)、SpringBoot也把其他的日志都替换成了slf4j;
  • 3)、中间替换包?
  • 4)、如果我们要引入其他框架?一定要把这个框架的默认日志依赖移除掉? Spring框架用的是commons-logging;
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring‐core</artifactId>
    <exclusions>
        <exclusion>
            <groupId>commons‐logging</groupId>
            <artifactId>commons‐logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
  • SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；

三、日志使用

3.1 默认配置

  • SpringBoot默认帮我们配置好了日志;

Logger logger = LoggerFactory.getLogger(getClass());
    
    @Test
    public void logTest1() {
        //System.out.println();
        //日志的级别；
        //由低到高   trace<debug<info<warn<error
        //可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效
        logger.trace("这是trace日志...");
        logger.debug("这是debug日志...");
        //SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别；root级别
        logger.info("这是info日志...");
        logger.warn("这是warn日志...");
        logger.error("这是error日志...");
    }

3.2 日志格式

日志输出格式符号含义:

%d表示日期时间，
%thread表示线程名，
%‐5level:级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 %msg:日志消息，
%n是换行符
‐‐>
%d{yyyy‐MM‐dd HH:mm:ss.SSS} [%thread] %‐5level %logger{50} ‐ %msg%n

SpringBoot修改日志的默认配置

# 不指定路径在当前项目下生成springboot.log日志
logging.path=
# 可以指定完整的路径；
# 使用 spring.log 作为默认文件
#logging.file=G:/springboot.log
# 也可以在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；
#logging.path=/spring/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

3.2 指定配置

  • 给类路径下放上每个日志框架自己的配置文件即可;SpringBoot就不使用他默认配置的了

【SpringBoot】整合日志框架

  • logback.xml:直接就被日志框架识别了;
  • logback-spring.xml:日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能。
  • 如，下面可以可以指定某段配置只在某个环境下生效
 <layout class="ch.qos.logback.classic.PatternLayout">
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
        </layout>
  • 如果使用logback.xml作为日志配置文件的名称，还要使用profile功能，会有以下错误
  • no applicable action for [springProfile]

四、切换日志框架

可以按照slf4j的日志适配图，进行相关的切换;
slf4j+log4j的方式;

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring‐boot‐starter‐web</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>logback‐classic</artifactId>
            <groupId>ch.qos.logback</groupId>
        </exclusion>
        <exclusion>
            <artifactId>log4j‐over‐slf4j</artifactId>
            <groupId>org.slf4j</groupId>
        </exclusion>
    </exclusions>
</dependency>
  
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j‐log4j12</artifactId>
</dependency>

切换为log4j2


<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring‐boot‐starter‐web</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>spring‐boot‐starter‐logging</artifactId>
            <groupId>org.springframework.boot</groupId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring‐boot‐starter‐log4j2</artifactId>
</dependency>
上一篇：每天进步一点点---------SpringBoot与log4j2


下一篇：log4j不打印日志问题的解决方案