springboot与日志（springboot学习笔记03）

1、日志框架的起源

1、System.out.println("")，将关键数据打印在控制台；去掉sout，写在一个文件里

​ 2、框架来记录系统的一些运行信息；日志框架 ，1.jar；

​ 3、增加功能（如异步模式、自动归档等；2.jar

​ 4、将以前框架卸下来，换上新的框架，重新修改之前相关的API；3.jar；

​ 5、JDBC—数据库驱动；写一个统一的接口层，即日志门面（日志的一个抽象层）logging-abstract.jar，使用的时候给项目中导入具体的日志实现就行了，之前的日志框架都是实现的抽象层

市面上的日志框架：

日志门面 （日志的抽象层）	日志实现
JCL(Jakarta Commons Logging)(老) SLF4j（Simple Logging Facade for Java） jboss-logging	Log4j JUL（java.util.logging） Log4j2(太高级，不适配) Logback(log4j升级)

左边选一个门面（抽象层）、右边来选一个实现
日志门面： SLF4J；
日志实现：Logback；

Spring框架默认使用JCL
SpringBoot选用 SLF4j和logback；

2、SLF4j使用

2.1、如何在系统中使用SLF4j

官方文档:https://www.slf4j.org

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

• 使用：
  给系统导入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以后，配置文件还是做成日志实现框架自己本身的配置文件（slf4j只提供一个统一的抽象层）

2.2、遗留问题-统一日志记录

a系统（slf4j+logback）使用 Spring（commons-logging框架）、Hibernate（jboss-logging框架）、MyBatis、xxxx等框架

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

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

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

3、再来导入slf4j其他的实现
图示（http://www.slf4j.org/legacy.html）：

3、SpringBoot日志关系

• idea查看依赖的关系(适配图)：
  
• spring-boot-starter-web的spring-boot-starter：

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

• spring-boot-starter的spring-boot-starter-logging（SpringBoot使用它来做日志功能）：

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

• springboot的底层依赖关系：
  
  总结：

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

​ 2）、SpringBoot也把其他的日志都替换成了slf4j（导入了中间替换包）

@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";
	//内部使用的是SLF4J的工厂
    static LogFactory logFactory = new SLF4JLogFactory();

3）、如果我们要引入其他框架，一定要把这个框架的默认日志依赖移除掉
如Spring框架的commons-logging被移除：

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

SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，我们唯一要做的是引入其他框架的时候，把这个框架依赖的日志框架排除掉即可

4、日志使用；

4.1、默认配置

• SpringBoot已经默认配置日志，我们也可以自行添加日志

	//创建记录器 - 用以记录日志
	Logger logger = LoggerFactory.getLogger(getClass());
	@Test
	public void contextLoads() {
		//System.out.println();

		//日志的级别由低到高：trace<debug<info<warn<error
		//可以调整日志输出级别，只有比这个级别更高的日志才会生效。SpringBoot默认使用info作为最高级别（root级别）
		logger.trace("这是trace日志...");//捕获跟踪信息
		logger.debug("这是debug日志...");//调试信息
		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.file优先级比logging.path高
#logging.file不指定路径：在当前项目下生成springboot.log日志；指定路径：在路径下生成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 文件中

4.2、指定配置

不让springboot使用默认配置：将对应日志框架的配置文件存放在类路径下即可

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

不同命名的影响：
ogback.xml：直接被日志框架识别，直接加载该配置项
logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，方便了SpringBoot高级Profile功能的使用

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

如：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <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>

5、切换日志框架

• 先在适配图里面，将logback-classic和log4j-over-slf4j这两个依赖删除（右键，exclude）
• 再添加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>

• 还可以添加log4j的配置文件
• 另外，切换为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>