SpringBoot中的日志

一、日志框架

常见的日志框架有：

日志抽象层：

• JCL（ApacheCommons Logging）：2014年停更了
• SLF4j（Simple Logging Facade for Java）：作者Ceki Gülcü
• jboss-logging

日志实现层：

• JUL（java.util.logging） ：JDK自带
• Log4j ：作者Ceki Gülcü
• Log4j2 ： Apache 收购log4j 后全面重构，内部实现和log4j完全不同。
• Logback ：作者Ceki Gülcü

Spring默认采用JCL（ApacheCommons Logging）框架，SpringBoot默认采用slf4j+logback的形式。

开发的时候直接调用日志抽象层的方法，而不是调用实现类中的方法：

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

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

Spring Boot也能适配（jul、log4j）,但是需要导入适配层。

注意：
每个日志框架都需要一个配置文件，这个配置文件需要按日志框架实现层进行配置。

二、日志框架的问题

springBoot中默认采用slf4j+logback的方式，Spring默认是commons-logging日志框架，Hibernate默认采用jboss-logging日志框架，即每个框架都有各自默认的日志实现方式。我们的目的是统一使用slf4j框架来做日志的输出。

如何让系统中所有的日志都统一到slf4j；

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

在pom.xml中右键，show Dependencies…来查看依赖图谱：

SpringBoot使用spring-boot-starter-logging来做日志功能（内部默认都配置好了）：

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-logging</artifactId>
      <version>2.4.0</version>
      <scope>compile</scope>
    </dependency>

注意：

• SpringBoot底层使用slf4j+logback的方式进行日志记录
• SpringBoot能自动适配所有的日志，能将其它的日志都替换成了slf4j。我们只需要在引入其它框架的时候，将其依赖的日志框架排除掉就可以了。

三、日志配置

1、日志级别
在需要打印日志的地方，加上下面的就好了：

//getClass(),代表当前打印日志的类
Logger logger = LoggerFactory.getLogger(getClass());
//日志级别由低到高
logger.trace("trace");
logger.debug("debug");
logger.info("info");
logger.warn("warn");
logger.error("error");

使用举例：

注意：

• SpringBoot默认使用的是info级别的日志打印。
• 忌用System.out.println打印输出，因为SOUT本质上属于IO操作，对性能影响比较大，所以对于语句的打印尽量使用日志的方式进行。

2、日志配置
(1) logging.level
将com.glp包下的日志级别设为warn

logging.level.com.glp=warn

(2) logging.file 和 logging.path

• 如果配置文件中这两项都不配置，则日志在控制台输出。
• 若使用logging.file指定了文件名，logging.file=C:/spring.log如果不指定路径，则将当前日志文件输出到当前根目录下。
• 使用logging.path指定路径，logging.path=/spring/log将会在根目录下创建/spring/log，并使用默认的spring.log作为日志文件。
• 若两者都指定，则以logging.file为准。

（3）指定日志的输出格式

• 指定控制台输出的日志格式： logging.pattern.console
• 指定文件中日志输出的格式： logging.pattern.file

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是换行符

(4) 日志框架的配置文件

• Logback：logback-spring.xml 或者 logback.xml
• Log4j2：log4j2-spring.xml 或者 log4j2.xml
• JDK(Java Util Logging) ：logging.properties

注意：
使用Logback日志框架实现日志打印时，如果配置文件使用logback-spring.xml，那么就可以通过profile环境配置指定某段配置只在某个环境中生效。

name=“dev”，指该段配置在开发环境下生效。

四、日志框架切换

导入所要替换日志框架及其适配层，并将其他日志框架去除，用对应的替换包去替换掉原来的框架。具体参考结构图：

如果要使用log4j2,那么需要将spring-boot-starter-logging去除，并导入依赖包：

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

这时我们发现依赖图的构造变成log4j2了：