SpringBoot和日志

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使用的是SLF4j+Logback。

2 SLF4j的使用

2.1 如何在系统中使用SLF4j

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

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 遗留问题

• 项目中的日志框架是SLF4j+Logback：Spring（commons-logging）、Hibernate（jboss-logging）、Mybatis……
• 统一日志框架，让别的框架统一使用SLF4j进行输出。

• 总结：如何让系统中的所有日志框架都统一到SLF4j？
• 1️⃣将系统中其他日志框架先排除出去。
• 2️⃣用中间包来替换原有的日志框架。
• 3️⃣导入SLF4j其他的实现。

3 SpringBoot日志关系

• SpringBoot 使用如下的日志场景启动器来做日志功能的：

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

• 总结：
• 1️⃣SpringBoot底层也是使用SLF4j+logback的方式进行日志记录。
• 2️⃣SpringBoot也将其他的日志都替换成SLF4j。
• 3️⃣中间的转换包如下图所示：

• 4️⃣如果要引入其它框架，一定要把这个框架的默认日志依赖移除掉。

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <exclusions>
        <exclusion>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

4 日志使用

4.1 默认配置

• SpringBoot默认已经帮助我们配置好了日志框架。

package com.sunxiaping.springboot;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootApplicationTests {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    public void test() {
        //日志的级别 trace<debug<info<warn<error
        //可以调整输出的日志级别，日志只会在这个级别以后的高级级别生效
        logger.trace("*******trace********");
        logger.debug("********debug*********");
        //SpringBoot默认的日志级别是info级别。
        logger.info("*******info********");
        logger.warn("*******warn********");
        logger.error("*******error********");
    }
}

#日志的等级，如果没有指定包的路径就是root
logging.level.com.sunxiaping=info
#logging.level.root=warn
#日志文件 如果不指定路径，默认在当前项目下生成日志文件；如果指定完整路径，在指定的路径中生成日志文件
logging.file=my.log
#日志路径，在当前磁盘的根路径下创建文件夹，并且日志文件名是spring.log
# logging.path=/var/log
# 在控制台输出的日志的格式
#logging.pattern.console=
# 在执行文件中日志输出的格式
#logging.pattern.file=

logging.file	logging.path	例子	描述
			在控制台输出
指定文件名		my.log	输出日志到my.log
	指定目录	/var/log	输出到指定目录的spring.log文件中

4.2 指定配置

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

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

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
</springProfile>

<springProfile name="dev, staging">
    <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</springProfile>

<springProfile name="!production">
    <!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>

5 切换日志框架

5.1 切换成Slf4j+Log4j（不推荐）

• 排除logback的依赖：

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

• 在类路径下引入log4j.properties文件：

### set log levels ###
log4j.rootLogger = info,stdout,D,E

### 输出到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} %5p %c{1}:%L - %m%n

#### 输出到日志文件 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/log.log
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = DEBUG ## 输出DEBUG级别以上的日志
#log4j.appender.D.layout = org.apache.log4j.PatternLayout
#log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
#
#### 保存异常信息到单独文件 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/error.log ## 异常日志文件名
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = ERROR ## 只输出ERROR级别以上的日志!!!
#log4j.appender.D.layout = org.apache.log4j.PatternLayout
#log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

5.2 切换成Slf4j+Log4j2

• 只需要导入spring-boot-starter-log4j2，并排除spring-boot-starter-logging：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>