Spring Boot 日志

Spring Boot

发布日期: 2022-06-04

更新日期: 2022-06-07

文章字数: 1.8k

阅读时长: 7 分

阅读次数:

📄 日志

1. 日志框架

写了一个统一的接口层，日志门面（日志的一个抽象层）

给项目中导入具体的日志实现就行了；我们的日志框架都是实现的抽象层；

市面上的日志框架；

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 使用

① 如何在系统中使用 SLF4j

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

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

https://www.slf4j.org

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

② 遗留问题

💬 比如：a 系统使用的日志框架（slf4j+logback）: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx

❓ 如何统一日志记录呢？即使是别的框架也统一使用 slf4j 进行输出

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

⭐ slf4j 的日志适配图如下：

3. SpringBoot日志关系

SpringBoot使用它来做日志功能；

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

底层依赖关系

分析依赖关系，如何在 IDEA 中打开下图所示的依赖关系图：

总结：

SpringBoot 底层使用 slf4j+logback 的方式进行日志记录
SpringBoot 把其他的日志都替换成了 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 Boot 会排除掉 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. 日志使用

① 默认配置

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

日志的级别：由低到高

trace < debug < info < warn < error

可以调整输出的日志级别，日志就只会在这个级别以以后的高级别生效。在全局配置文件中进行调整，比如：

logging.level.com.smallbeef = trace

SpringBoot默认给我们使用的是 info 级别的，没有指定级别的就用SpringBoot默认规定的级别

💬 示例代码如下：

@SpringBootTest
class DemoApplicationTests {

    //记录器
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    public void contextLoads() {
        //System.out.println();
        logger.trace("这是trace日志...");
        logger.debug("这是debug日志...");
        //SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别；root级别
        logger.info("这是info日志...");
        logger.warn("这是warn日志...");
        logger.error("这是error日志...");
    }
}

输出结果如下：

⚙ SpringBoot 修改日志的默认配置：

loggin.path = springboot.log：指定生成日志文件的位置（可以指定完整的路径，不指定路径在当前项目下生成日志）

logging.file = /spring/log：和 path 是冲突设置，同样用于指定生成日志文件的位置，在当前磁盘的根路径下创建spring 文件夹和 log 子文件夹；使用 spring.log 作为默认文件

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

logging.pattern.console = %d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n：在控制台输出的日志的格式

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

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

logging.level.com.smallbeef = 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

② 指定配置

在 resources 文件夹下添加每个日志框架自己的配置文件即可，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：直接就被日志框架识别了，跳过 Spring Boot

如果日志配置文件名为 logback-spring.xml：日志框架就不直接加载日志的配置项，由Spring Boot解析日志配置，可以使用 Spring Boot 的高级 Profile 功能，可以指定某段配置只在某个环境下生效

💬 示例代码如下：

<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} ----> [%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>

在全局配置文件中激活环境

spring.profiles.aactive = dev

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

no applicable action for [springProfile]

5. 切换日志框架

可以按照 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>