🐽铛铛~ 到了我们SpringBoot系列的第三篇了
🛠这一篇章，我们聊聊SpringBoot中的日志与配置

三、日志

1、日志

小郑准备开发一个大型系统
1. System.out.println("");将关键数据打印在控制台；or卸载一个文件里
2. 框架来记录系统一些运行时信息；日志框架；zhenglogging-beta.jar
3. 高大上的功能：异步模式、自动归档、xxxx；zhenglogging-alpha.jar
4. 将以前的框架卸载下来，换上新框架，重新修改之前相关的API；zhenglogging-better.jar
5. JDBC---数据库驱动；
  - 写一个统一的接口层；日志门面（日志的一个抽象层）；zhenglogging-abstract.jar;
  - 给项目导入具体的日志实现就行了；我们之前的日志框架都是实现的抽象层

市面上的日志框架

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；

SpringBoot：底层是Spring框架，Spring默认使用的JCL
- SpringBoot选用 SLF4J 和 logback

2、SLF4j使用

1、如何在系统中使用SLF4j

slf4j官网
以后开发的时候，入职记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法。

给系统里面导入slf4j的jar和logback实现jar

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

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

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

2、遗留问题

a（slf4j + logback）：Spring（commons-logging）、Hiernaate（jboss-logging）、MyBatis、xxxx
统一日志记录，即让其他框架和我一起统一使用slf4j进行输出
如何让系统中所有的日志都统一到slf4j
1. 将系统中其他日志框架先排除出去
2. 用中间件来替换原有的日志框架
3. 我们导入slf4j的其他按时限

3、SpringBoot日志关系

pom文件依赖如下

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

SpringBoot使用它来做日志功能

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

底层依赖关系
总结：
1. SpringBoot底层也是使用slf4j+logback的方式进行日志记录
2. SpringBoot也把其他的日志都替换成了slf4j
3. 中间替换包

查看jcl-over-slf4j的源码

@SuppressWarnings("rawtypes")
public abstract class LogFactory {

    static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";

    static LogFactory logFactory = new SLF4JLogFactory();
}

如果需要引入其他日志框架呢？

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的方式记录日志，引入其他框架的时候，只需要吧这个额框架依赖的日志框架排除即可

4. 日志使用：

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日志...");
}

可以在默认的配置文件中进行日志的配置

# 设置日志的默认级别
logging.level.com.zth = trace 
# logging.path=
# 不指定路径在当前项目下生成springboot.log日志
# 可以指定完整的路径；
# logging.file=/Users/3zz/log/springboot.log
# 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件
logging.path=/spring/log

#  在控制台输出的日志的格式 {日期-线程号-级别-全类名字符-logger消息}
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

详细日志输出格式配置参照如下
1. %d表示日期时间
2. %thread表示线程名
3. %-5level：级别从左显示5个字符宽度
4. %logger{50} 表示logger名字最长50个字符，否则按照句点分割
5. %msg：日志消息
6. %n是换行符

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

2. 指定配置

给类路径下放上每个日志框架自己的配置文件即可，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功能

<springProfile name="staging">
  <!-- configuration to be enabled when the "staging" profile is active -->
  可以指定某段配置只在某个环境下生效
</springProfile>

下面是一个例子

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
  <layout class="ch.qos.logback.classic.PatternLayout">
    <springProfile name="dev">
      <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ---> %-5level %logger{50} - %msg%n</pattern>
    </springProfile>
    <springProfile name="!dev">
      <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== %-5level %logger{50} - %msg%n</pattern>
    </springProfile>
  </layout>
</appender>

运行时可以看到，在dev环境下和非dev环境下，日志打印结果不相同

风袖

SpringBoot系列(3) ---- 日志