5.SpringBoot 日志

5.SpringBoot 日志

1、日志框架

1）市面上的框架：

​ JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…

日志的抽象层	日志实现
JCL（Jakarta Commons Logging）（在2014年停止更新） SLF4j（Simple Logging Facade for Java） jboss-logging（专用日志）	Log4j JUL（java.util.logging） Log4j2 Logback

左边选一个抽象层、右边来选一个实现；

日志抽象层： SLF4J；日志实现：Logback；

Springboot 底层是Spring框架，spring框架默认是用JCL；SpringBoot选用的是SLFJ和logback；

2、SLFJ使用

1）如何在使用中使用SLFJ http://www.slf4j.org/

​ 可以看看使用文档（SLF4J user manual）

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

​ 导入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）遗留问题 (API( legacy APIs))

​ 一个系统想使用slf4j+logback:但是Sping（依赖commons-logging）、Hibernate（依赖jboss-logging）等等之前的框架依赖一些日志包，我们怎么统一日志呢？slf4j 官网查看legacy APIs使用API,如下：

上图是统一日志框架的方法，例如左上角（使用SLF4J抽象层和logback的实现），使用参照slf4j-api,如果项目中有commons-logging（Spring框架依赖的日之包）需要替换成jcl-over-slf4j.jar,其他两个也需要替换成相应的jar包，这样就可以统一slf4j.

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

​ 1、将系统中其他日志框架先排除出去；

​ 2、用中间包来替换原来的日志框架；

​ 3、导入slf4j其他的实现；

3、分析Springboot日志关系

​ 在Springboot项目的maven的配置文件中，如下操作打开项目的所有jar包的依赖关系

找到Springboot的日志依赖关系如下图

总结：

​ 1）Springboot底层也是使用slf4j+logback的方式进行日志记录；

​ 2）Springboot把其他日志都替换成了slfj;

​ 3) 需要中间替换包转换（实际原理就是在转换包中编写一个类和要替换的那个类的包明和类名都一样）

@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();

4）若要起引入其他框架，一定要把这个框架的默认日志依赖移除掉。

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

4、日志使用

1）默认配置

​ SpringBoot的默认的日志配置如下：

	//记录器
	Logger logger = LoggerFactory.getLogger(getClass());
	@Test
	public void contextLoads() {
		//System.out.println();

		//日志的级别如下
		//由低到高   trace<debug<info<warn<error
		//可以调整输出的日志级别，日志就只会在这个级别以以后的高级别生效
		logger.trace("这是trace 跟踪日志...");
		logger.debug("这是debug 调试日志...");
		//SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别；
		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

SpringBoot修改日志的默认配置：

#日志的输出级别
logging.level.com.atguigu=trace

#logging.path=
# 不指定路径在当前项目下生成springboot.log日志
# 可以指定完整的路径；
#logging.file=F:/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

logging.level.com.atguigu=trace

#logging.path=
# 不指定路径在当前项目下生成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

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

2）制定配置

覆盖SpringBoot默认配置：在类路径下放每个日志框架的配置文件即可；SpringBoot官方网站有logging的介绍。

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:直接被日志框架识别；

logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
  	可以指定某段配置只在某个环境下生效
</springProfile>

如：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志输出格式：
			%d表示日期时间，
			%thread表示线程名，
			%-5level：级别从左显示5个字符宽度
			%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
			%msg：日志消息，
			%n是换行符
        -->
        <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>

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

no applicable action for [springProfile]

3）切换log4j2

​ 直接修改maven配置文件如下

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