Spring Boot学习笔记（三）Spring Boot日志

Spring Boot实现日志原理及使用（1.x版本)

Spring Boot默认采用的是slf4j+logback的形式来实现日志功能的。slf4j用来做抽象层，相当与一个接口，属于日志门面；logback用来做日志的具体实现，相当于接口的实现类，属于日志实现。常见日志：

1、slf4j使用

我们以后开发系统时可以参照spring boot的日志实现来做我们自己系统的日志实现。日志记录方法调用的是日志抽象（日志门面）的方法。这里以slf4j+logback为例，在系统里面导入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会自动绑定日志实现，不需要我们做多余的操作。如果我们不使用logback实现日志，而是使用其他的日志框架例如log4j，那怎么使用slf4j实现？我们可以参考下图：

图片来源（https://www.slf4j.org/manual.html）
上图中使用Log4j和JUL（java.util.logging）时中间多了一层适配层，这是由于log4j和JUL比较早，当时没有和slf4j做适配，所以需要一个适配层。slf4j调用日志实现时，先调用适配层的实现，然后适配层再调用具体日志实现。每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件；
当项目中引入了多个日志实现框架，slf4j优先使用先导入的日志框架。
具体可以参考slf4j官方用户手册。

2、统一日志框架

如果我们项目使用的slf4j+logback的方式做日志，当我们项目需要使用sping、Hibernate时，因为spring使用的是commons-logging，Hibernate使用的是jboss-logging，这样会造成日志框架混乱，我们需要使用统一的日志框架来做日志，使用slf4j可以参考下图来做日志框架的统一：

从上图我们可以知道，假设我们统一使用slf4j+logback的方式，那么我们可以使用一个替换包（jcl-over-slf4j.jar、log4j-over-slf4j、jul-to-slf4j.jar）将co’mmons-logging、log4j等日志框架的jar包替换掉。原理是因为这些替换包里面结构，包名，类名其实和对应的日志框架实现包相同，但是实际调用的是slf4j，然后再调用我们使用的日志实现框架。步骤：
1、将系统中其他日志框架先排除出去；
2、用替换包来替换原有的日志框架；
3、我们导入slf4j真正的实现框架；
具体可参考slf4j弥合传统API

3、Spring Boot实现日志原理

我们可以分析Spring Boot项目的pom文件的Dependency Hierarchy视图：

Spring Boot将其他框架引用的日志实现jar包排除掉了，以spring框架为例：

总结：
Spring Boot默认时使用slf4j+logback的方式进行日志记录，它将其他日志框架都用替换包替换了。当我们需要使用其他框架时，必须把其他框架的默认的日志框架排除掉，否则会与替换包发生冲突。前提是该框架使用的日志框架是jcl、jul、log4j、logback。

4、Spring Boot使用日志

Spring boot默认将日志配置好了，直接使用就行了：

@RunWith(SpringRunner.class)
@SpringBootTest
public class LoggerTests {
	
	private static final Logger logger =  LoggerFactory.getLogger(LoggerTests.class);
	
	@Test
	public void logTest(){
		
		//日志的级别；        
		//由低到高   trace<debug<info<warn<error        
		//可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效 
		logger.trace("这是trace日志！");
		logger.debug("这是debug日志!");
		//SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别；
		logger.info("这是info日志!");
		logger.warn("这是warn日志!");
		logger.error("这是error日志!");
	}

}

我们可以在application.properties中修改日志输出级别以及其他配置：

##com.dmf包下的日志等级为trace
logging.level.com.dmf=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

path和file的区别

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

        %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

配置文件：
一般日志框架都需要相对于的配置文件xml或者properties，Spring Boot为我们写好了logback的配置文件，所以我们可以直接用，如图：

当我们要使用自己的配置时，我们可以给类路径下放上每个日志框架自己的配置文件即可；SpringBoot就不使用他默认配置的了。

Spring Boot推荐使用-sping命名日志文件。logback.xml由日志文件加载，logback-spring.xml则是由Spring Boot加载，这样就可以使用spring boot的Profile功能了。示例：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
     
        <layout class="ch.qos.logback.classic.PatternLayout">
         <!--dev环境就使用这个-->
            <springProfile name="dev"> 
                <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ‐‐‐‐> [%thread] ‐‐‐> %‐5level
%logger{50} ‐ %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev"> <!--不是dev环境就使用这个-->
                <pattern>%d{yyyy‐MM‐dd HH:mm:ss.SSS} ==== [%thread] ==== %‐5level
%logger{50} ‐ %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

至于怎么激活profile，我上一篇博客介绍过了，这里不复述了。

5、切换日志实现框架

以slf4j+log4j为例：
1、排除logback实现包和log4j替换包：

<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
			<!-- 排除logback和 log4j替换包，使用log4j作为日志记录文件时用-->
			<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>

2、导入log4j实现包和适配slf4j的中间包：

<!-- 导入log4j引用slf4j中间包 -->
         <dependency>
          <groupId>org.slf4j</groupId>
          <artifactId>slf4j-log4j12</artifactId>
        </dependency>

因为这个包默认引用log4j包，所以不需额外引入log4j包。版本Spring Boot帮我们控制好了。
切换log4j2：

从官方文档的这个图我们知道，log4j2有一个专门的starter。那么我们可以这么做：

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

将Spring Boot默认的日志starter（starter-logging）排除，然后引入log4j2的starter即可。
参考：Spring Boot官方文档网站