03_SpringBoot与日志

SpringBoot与日志

1. 日志框架

为什么会有日志框架 ?

我们通过一个小故事来解释.

小张开发一个大型的系统 :

1. 以前把关键数据通过 System.out.println(); 将关键数据打印在控制台.
2. 而老板由于看着满屏的打印很不爽,于是要求小张删除该打印,这让小张愁的不行,不知道该如何记录这些关键的信息,这时老板看到了小张的无奈,给小张一个建议,何不把关键信息存放在一个文件中呢? 小张恍然大悟,于是兴致勃勃的写了一个框架,叫做 zhang_logging并一直高兴的使用着.
3. 随着项目越来越大,使得小张觉得自己写的框架不够完善,想在框架中加入新的功能,比如异步存储,分类存档… 于是小明又凭借着自己高超的技术改写原来的框架为 zhang_good_logging , 但是当小明在替换新的日志框架时发现现在的框架中又很多以前没有的API,如果每次都要进行替换很麻烦,这时聪明的他想到了 JDBC 与 数据库驱动的关系.
4. 于是小张先编写了一个接口,然后以后每个框架都是用这个接口进行实现.以后更换的时候不需要在代码中更换API

通过上面的故事我们解释了为什么会有日志框架.接下来我们看看市面上有什么日志框架供我们选择呢?

JUL, JCL, Jboss-logging,logback,log4j,log4j2,slf4j…

日志门面	日志实现
JCL,slf4j,Jboss-logging	JUL（java.util.logging),Logback,log4j,log4j2

因此,我们需要在左边选一个日志门面,右边选一个实现:

我们选择 SLF4j 与 Logback

因为这两个是由同一人编写.

SpringBoot使用的是 SLF4j 与 Logback

---

2. SLF4j的使用

1. 如何在系统中使用SLF4j

以后开发中,日志记录方法的调用,不应该调用日志的实现类,而是调用日志抽象层(门面)里面的方法.

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

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

图示 : 可以在这里找到以下的图片

每一个日志的实现框架都有自己的配置文件,使用slf4j以后,配置文件还是做成日志实现框架的配置文件.

2. 日志冲突问题

比如 :

项目用的是(slf4j 和 Logback)

spring用的是 commons-logging

mybatis使用的是其他的日志包

则 :

我们怎么把所有的框架的包都换为 slf4j 和 Logback 包呢?

slf4j 给出了实现 :

例子 : commons-logging ----> slf4j

实现方法 :

1. 将 commons-logging 包去掉
2. 然后替换为 slf4j 提供的替换包(jcl-over-slf4j.jar) , 该包有 commons-logging 的 API接口 , 但是其实现是 slf4j . 通俗的说, 就是讲 commons-logging 的实现进行了修改 , 修改为通过 slf4j 进行日志处理 , commons-logging 的 API 没有变 . (不知道说懂了没有 ^_^ , 可以参考 jcl-over-slf4j.jar 进行理解)

---

3. SpringBoot的日志关系

SpringBoot 的日志关系大体是这样的 .

可以看到 SpringBoot 底层也是使用了 SLF4j 和 Logback , 并使用了替换包.

且SpringBoot能够适配其他的日志包,因此引入其他框架的时候,应把日志包排除掉.否则会报错.

---

4. SpringBoot日志使用

SpringBoot已经帮我们配置好了日志 :

@RunWith(SpringRunner.class)
@SpringBootTest
public class Springboot03LoggingApplicationTests {
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    public void contextLoads() {
        //日志的级别
        //由低到高 trace < debug < info < warn < error
        //可以调整输出的日志级别 : 日志就会在这个级别及更高的级别生效.
        logger.trace("这是trace日志");
        logger.debug("这是debug日志");
        //SpringBoot默认使用的是info级别的 没有指定级别就使用springBoot默认的级别
        logger.info("这是info日志");
        logger.warn("这是warn日志");
        logger.error("这是error日志");
    }
}

SpringBoot默认使用的是info级别的 没有指定级别就使用springBoot默认的级别

设置SpringBoot日志的默认配置:

logging.level.com.lfy=trace

#当前项目下生成springboot.log
#也可以指定完整的路径
#logging.file=D:/springboot.log
#logging.file=springboot.log

#在当前磁盘的根路径下创建spring文件夹和和里面的log文件夹,
# 使用 spring.log 作为默认文件
logging.path=/spring/log

#在控制台输出的日志的格式
# %d 表示时间日期
# %thread 表示线程名
# %-5level 级别从左显示5个字符的宽度
# %logger{50} 表示logger名字最长50字符,否则按照句点分割
# %msg 日志消息
# %n 换行符
logging.pattern.console=%d{yyyy-MM-dd [%thread%] %-5level %logger{50} - %msg%n}

#指定文件中日志的输出的格式
logging.pattern.file=%d{yyyy-MM-dd === [%thread%] === %-5level === %lo
gger{50} === %msg%n}

---

5. 指定配置

在类路径下放下每个日志框架自己的配置文件即可,SpringBoot就不适用其他默认配置了

logback.xml : 直接被日志框架识别,相当于绕过了 SpringBoot

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/app/log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="atguigu-springboot"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志输出格式：
			%d表示日期时间，
			%thread表示线程名，
			%-5level：级别从左显示5个字符宽度
			%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
			%msg：日志消息，
			%n是换行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式： -->     
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 
		logger主要用于存放日志对象，也可以定义日志类型、级别
		name：表示匹配的logger类型前缀，也就是包的前半部分
		level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
		false：表示只用当前logger的appender-ref，true：
		表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="com.atguigu" level="debug" />
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>

    <!-- 
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，
	然后判断这个logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout" />
        <appender-ref ref="appLogAppender" />
    </root>
</configuration> 

Logback-spring.xml : 日志框架就不直接加载日志的配置项,由 SpringBoot 加载,就可以使用一个高级特性 : 可以指定某段配置只在某个环境下生效.

<springProfile name="staging">
    可以指定某段配置在某个环境下生效
<springProfile>

6. 切换日志框架

SpringBoot 默认的日志框架为 : SLF4j + Logback

可以按照 slf4j 的日志适配图进行相关的切换

slf4j + log4j 的方式

进行分析 :

再次查看 springboot 的日志框架 : slf4j + logback

1. 因为我们要把框架的实现换为 log4j , 因此我们先把 Logback 的包排除掉 .

2. 然后因为我们要把框架的实现换为 log4j , 所以不需要将 log4j 转为 slf4j .

3. 然后根据 slf4j 官网提供的替换方式进行替换 :

   可以看到我们现在走的是下面画的框框中的路线 . 现在 slf4j-api 存在(见上图), 因此我们还需要把 slf4j-log412.jar 引入 .

4. 切换完成 .

个人理解 , 仅供参考 (〃‘▽’〃)