springboot日志

A.日志框架

1. 引入

• 我在开发阶段通过 System.out.print("") 进行测试，上线之后把日志输出到一个日志里记录运行情况
• 我们可以自定义一个框架，用于记录运行时的一些信息
  • 改进：将日志进行过滤功能，异步模式，自动归档…
  • 改进：新框架出来了，要改代码替换之前的框架
    • 面向接口编程
    • 日志抽象层
    • 向项目中导入不同的日志实现

2. 市面上的日志框架

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

日志门面（日志的抽象层）	日志实现
JCL（Jakarta Commons Logging） SLF4j（Simple Logging Facade for Java） jboss-logging	Log4j JUL（java.util.logging） Log4j2 Logback

• 左边选一个接口(抽象层)，右边选一个实现
  • 左边(抽象): SLF4J
  • 右边(实现): Logback(Log4j的升级版)
• SpringBoot 底层是 Spring 框架，默认使用的是 JCL
  • 但是 SpringBoot 选用了 SLF4J–> Logback

3. slf4j 使用原理

• 以后开发的时候，日志记录方法的调用应该调用抽象层，而不是调用实现类
  • 只要调用抽象层的方法，框架自动使用实现类来输出日志

1. 给系统里导入 slf4j 的依赖
2. 导入 logback 的实现依赖
3. 使用日志记录

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以后，配置文件还是做成日志实现框架自己本身的配置文件

4. 遗留问题

• 如果我们开发的系统使用 slf4j + logback 作为日志框架
  • 但是我们使用了别的框架如: Spring, MyBatis, Hibernate 等开源框架
  • 但是这些框架不是使用 slf4j + logback 作为日志框架的
• 这样就导致我们的工程使用了多个日志记录框架
  • 我们需要统一日志记录的方式
  • 统一使用 slf4j 进行配置
• 偷天换日方式
  • 引入适配包，把其他类型的日志实现依赖排除掉，然后加入自己对其他日志类的实现
  • 但是这个实现会把日志输出到我们的 slf4j 中，这样就偷偷的把进行了转换
• 如何让系统中所有的日志都统一到slf4j
  1. 将系统中其他日志框架先排除出去
  2. 用中间包来替换原有的日志框架
  3. 我们导入slf4j其他的实现

B. SpringBoot日志关系

• 每一个启动器里面都有 spring-boot-starter 这个依赖

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

• spring-boot-starter 里面就有日志启动器: spring-boot-starter-logging

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

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

C. 日志使用

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

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

• SpringBoot修改日志的默认配置
  • logging.file 和 logging.path 是一对冲突设置
  • 指定了 logging.file 就不需要指定 logging.path
    • 一般指定 logging.path

# 设置日志级别，要指定包
logging.level.com.study=trace

# 不指定路径在当前项目下生成springboot.log日志
# 可以指定完整的路径；
# logging.file=G:/springboot.log

# 在当前磁盘的根路径下创建spring文件夹和里面的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

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

logging.file	logging.path	Example	Description
(none)	(none)		只在控制台输出
指定文件名	(none)	my.log	输出日志到my.log文件
(none)	指定目录	/var/log	输出到指定目录的 spring.log 文件中

E. 指定配置

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

Logging System	Customization
Logback	logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)	logging.properties

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

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

<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">
        <!-- 在开发模式中按照这个格式输出 -->
        <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>
</appender>

• 如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误

no applicable action for [springProfile]

F. 切换日志框架

• SpringBoot 默认使用的是 SLF4J + Logback 框架
• 如果我们想切换日志框架
  • 可以按照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>