3. springBoot日志

1. 日志框架的分类

        市面上日志框架有很多，例如：JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j....，那么这些框架怎么选用了？之间又有什么关系了？简单来说，这些框架可以分为两类，一类是日志门面（接口），一类是日志实现。

1）日志门面：JCL、slf4j、Jboss-logging

2）日志实现：log4j、log4j2、JUL、logback

其中slf4j与log4j，logback出自同一人之手。在spring中默认的日志框架是JCL，所以我们在spring项目中必须要导入Commons Logging日志包，而在springBoot中选用的是slf4j与logback作为其日志框架。

2. SLF4j使用

        官网：https://www.slf4j.org

        我们在开发中，日志记录的方法的调用，不应该直接调用日志的实现类，而是调用日志抽象层里面的方法，如图所示是官网给的SLF4J的调用示意图

例如：

package com.bjc.logging.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class Hello {
	private static Logger log = LoggerFactory.getLogger(Hello.class);
	@RequestMapping("/hello")
	public String hello(){
		log.info("info......");
		return "hello";
	}
}

注意：每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件；
那么，我们系统中使用的框架很多，可能每一个框架的日志框架都不一样，那么我们可否统一日志记录，即使是别的框架和我一起统一使用slf4j进行输出了？如图所示，官网给出的示意图：

从图中，我们可以知道对于那些常用的日志框架，都有对应的适配器类，如图所示：Commons-logging 就对应jcl-over-slf4j.jar。

我们只需要执行如下步骤即可实现

1）将系统中利用exclusions将其他日志框架先排除出去

2）用中间包（jcl-over-slf4j.jar）来替换原有的日志框架（Commons-logging）

3）我们导入slf4j其他的实现

3. SpringBoot日志关系

如图，

利用idea查看其依赖关系，如图：

从图中可以知道

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

2）SpringBoot也把其他的日志都替换成了slf4j

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

4. 日志使用

在Boot中既支持log4j也支持logback，如图所示：

关于log4j就不多说了，这里主要说一说logback的使用

logback算的上是log4j的一个扩展，其性能要高于log4j，所以，之后日志记录logback有替换log4j的趋势，所以在boot的web启动器中也包含了logback的jar。

4.1 默认配置

SpringBoot默认帮我们配置好了日志

例如：

package com.bjc.logging.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class Hello {
	private static Logger log = LoggerFactory.getLogger(Hello.class);
	@RequestMapping("/hello")
	public String hello(){
		log.trace("trace...,");
		log.info("info......");
		log.debug("debug......");
		log.warn("warn...");
		log.error("error......");
		return "hello";
	}
}

打印结果：

从中可以知道

1）日志的级别默认有四个

2）日志级别由低到高：trace<debug<info<warn<error

3）可以调整输出的日志级别，日志就只会在这个级别以以后的高级别生效

4）SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别root级别，所以默认级别下trace和debug级别的日志不会打印

4.2 日志输出格式

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

例如：

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

4.3 SpringBoot修改日志的默认配置

我们可以在全局配置文件中修改日志的默认设置，例如：

logging.level.com.bjc=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	说明
none	none		只在控制台输出
指定文件名	none	my.log	输出日志到my.log文件
none	指定目录	/var/log	输出到指定目录的spring.log文件中

4.4 指定配置

        有时候，我们不希望使用boot提供的默认日志功能，我们希望使用我们自己的，这时候可以在类路径下放上每个日志框架自己的配置文件，SpringBoot就不使用他默认配置的了

Logging System	Customization
Logback	logback-spring.xml logback-spring.groovy logback.xml logback.groovy
Log4j2	log4j2-spring.xml log4j2.xml
JDK (Java Util Logging)	logging.properties

我们在boot中使用日志记录配置文件一般使用logback.xml或者logback-spring.xml，这两者有什么区别了？

1）logback.xml：直接就被日志框架识别了

2）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]

完整的配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/app/log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="atguigu-springboot"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <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>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式： -->     
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 
		logger主要用于存放日志对象，也可以定义日志类型、级别
		name：表示匹配的logger类型前缀，也就是包的前半部分
		level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
		false：表示只用当前logger的appender-ref，true：
		表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="com.atguigu" level="debug" />
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>



    <!-- 
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout" />
        <appender-ref ref="appLogAppender" />
    </root>
</configuration> 

5. logback的使用

5.1 包含的jar

logback-classic-1.1.11.jar

logback-core-1.1.11.jar

当然log4j相关的jar也需要

5.2 配置文件

logback.xml

<?xml version="1.0" encoding="UTF-8" ?>
 <configuration>
<!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->  
    <property name="LOG_HOME" value="${catalina.base}/logs/" />  
    <!-- 控制台输出 -->   
    <appender name="Stdout" class="ch.qos.logback.core.ConsoleAppender">
       <!-- 日志输出编码 -->  
        <layout class="ch.qos.logback.classic.PatternLayout">   
             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n   
            </pattern>   
        </layout>   
    </appender>   
    <!-- 按照每天生成日志文件 -->   
    <appender name="RollingFile"  class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/server.%d{yyyy-MM-dd}.log</FileNamePattern>   
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>   
        <layout class="ch.qos.logback.classic.PatternLayout">  
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n   
            </pattern>   
       </layout> 
        <!--日志文件最大的大小-->
       <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
         <MaxFileSize>10MB</MaxFileSize>
       </triggeringPolicy>
    </appender>     

    <!-- 日志输出级别 -->
    <root level="info">   
        <appender-ref ref="Stdout" />   
        <appender-ref ref="RollingFile" />   
    </root> 



<!--日志异步到数据库 -->  
<!--     <appender name="DB" class="ch.qos.logback.classic.db.DBAppender">
        日志异步到数据库 
        <connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">
           连接池 
           <dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">
              <driverClass>com.mysql.jdbc.Driver</driverClass>
              <url>jdbc:mysql://127.0.0.1:3306/databaseName</url>
              <user>root</user>
              <password>root</password>
            </dataSource>
        </connectionSource>
  </appender> -->

</configuration>