Spring Boot |SpringBoot的日志框架及配置

---

一、常用的日志框架

市场上存在非常多的日志框架，分为日志门面(日志的抽象层)和日志实现。

1.1 日志门面

• JUL（java.util.logging)
• JCL（ApacheCommons Logging) (JCL最后一次更新是2014年)
• SLF4j
• jboss-logging (jboss只在特定的框架使用)。

1.2 日志实现

• Log4j
• Log4j2
• Logback

使用日志框架需要选择一个日志门面(抽象层)、一个日志实现，搭配使用。

1.3 Spring Boot的日志框架选择

Spring Boot在框架内容部使用JCL，spring-boot-starter-logging采用了slf4j+logback的形式，Spring Boot也能自动适配（jul、log4j2、logback） 并简化配置。

二、SLF4j的使用

2.1 SLF4j使用原理

SLF4j的官网

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

需要在系统中导入slf4j的jar包和logback的实现jar。

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.2 统一日志管理

实际开始时问题会变得更复杂，假设开发A系统使用的是slf4j+logback选型，但A系统需要依赖Spring框架、Hibernate框架、Mybatis框架…这些框架底层使用的日志框架可能各不相同。

• A系统：slf4j+logback
• • Spring框架：commons-logging
• • Hibernate框架：jboss-logging

此时就需要统一日志记录，将系统中所有的日志都统一到slf4j：

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

中间替换包：

三、SpringBoot日志关系

在项目的pom.xml文件内，右键选择Diagrams的show Dependencies可以查看项目的依赖关系。

spring-boot-starter是一个基本的启动器，它依赖了spring-boot-starter-logging。

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

SpringBoot中的日志都是由spring-boot-starter-logging完成的。

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

SpringBoot日志关系总结：

1）、SpringBoot底层使用了slf4j+logback的方式进行日志记录。
2）、SpringBoot使用中间替换包把其他的日志都替换成了slf4j。
3）、如果我们要引入其他框架，一定要把这个框架的默认日志依赖移除掉，否则容易产生jar包冲突。

SpringBoot能自动适配所有的日志，底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可。

四、SpringBoot日志使用

详细日志使用参照官网。

4.1 默认设置

SpringBoot默认已经帮我们配置好了日志，可以直接使用。

• 日志的级别由低到高:是trance<debug<info<warn<error。
• SpringBoot默认为我们提供的是info级别的，即root级别。

@SpringBootTest
class SpringBoot03LoggingApplicationTests {
    //获得记录器
    Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    void contextLoads() {
        //日志的级别由低到高:这是trance<debug<info<warn<error
        logger.trace("这是trance日志...");
        logger.debug("这是debug日志...");
        //SpringBoot默认为我们提供的是info级别的,即root级别
        logger.info("这是info日志...");
        logger.warn("这是warn日志...");
        logger.error("这是error日志...");
    }
}

日志输出格式：

%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.level.com.gql=info
#当前项目下生成springboot.log日志,也可以指定完整的路径
#logging.file.name=D:/AAA/springboot.log
#在当前磁盘的根路径下创建spring文件夹和log文件夹,此文件夹默认生成spring.log日志文件
logging.file.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

4.2 指定配置

如果自己编写了日志文件，放在类路径下即可，此时SpringBoot就不使用其默认的配置了。

• 不同的抽象类，防止不同的xml配置文件。
  

Profile高级特性

如果自定义的日志文件名为logback.xml，直接就被日志框架识别了；如果使用logback-spring.xml，日志框架就不直接加载日志的配置项，而是由SpringBoot解析日志配置，此时可以使用SpringBoot的高级Profile功能。

• 使用Profile可以指定某段配置只在某个环境下生效。

	   <springProfile name="dev">
	       <!--  configuration to be enabled when the "staging" profile is active -->
	       <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----->[%thread] %-5level %logger{50} - %msg%n</pattern>
	   </springProfile>

4.3 切换日志框架(不推荐)

SpringBoot框架采用了slf4j+logback的日志选型，如果仍然希望使用slf4j+log4j的技术选型，需要进行日志框架的切换，可以按照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>