1. 日志框架

日志框架的出现是为了更好的控制软件运行记录的信息，如果使用大量的System.out.println("")将无法有效的控制输出，市面上常见的日志框架有：
JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…

日志门面(日志的抽象层)	日志实现
~~JCL(Jakarta Commons Logging)~~ SLF4j(Simple Logging Facade for Java) ~~jboss-logging~~	Log4j logback JUL(java.util.loggin) log4j2

JCL和jboss-logging的目前使用场景很少见，因此日志的门面框架基本上使用的都是slf4j，门面框架的作用类似于Java中的接口，我们无需关心使用哪种实现，只需要知道该接口的作用即可。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * SpringBoot单元测试：
 * 可以在测试期间很方便的类似编码一样进行自动注入等容器的功能
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootQuickApplicationTests {
    public static Logger logger = LoggerFactory.getLogger(SpringBootQuickApplicationTests.class);
    @Test
    public void contextLoads() {
        //级别由低到高,SpringBoot默认使用INFO级别
        logger.trace("I love three things in the world");
        logger.debug("sun,moon,and you");
        logger.info("sun for morning");
        logger.warn("moon for night");
        logger.error("and you forever");
    }
}

1.1 日志框架依赖

slf4j

门面日志框架slf4j与实现框架的依赖见上图，其中由于log4j和java.util.logging日志框架比slf4j更早出现，没有根据slf4j定义的规范实现，因此需要一个适配器jar包。

1.1.1 存在多个日志实现的解决

当我们开发Web项目时，会集成SpringBoot（slf4j）、Spring（commons-logging）、Hibernate（jboss-logging）等多种框架，由于它们使用的日志框架都不同，会导致要写多个日志框架的配置文件：logback.xml、log4j.properties…，那么我们能不能把所有的日志框架使用统一的框架进行输入呢？如下图解决方案：
logger

如上图若要将slf4j、commons-logging、log4j、java.util.logging统一使用slf4j+logback方式输出，可以使用jcl-over.slf4j.jar、log4j-over-slf4j.jar、jul-to-slf4j.jar将替换需要导入的commons-logging.jar、log4j.jar，这些jar包与被替换的jar包结构与类名一模一样，实现了“狸猫换太子”

1.1.2 SpringBoot的日志框架

SpringBoot使用关于日志的starter

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

logging
由此可见，SpringBoot默认使用的日志框架是slf4j+logback ，且使用转换包将其他的日志都替换成了slf4j。引入的其他框架的默认日志依赖也被移除了，如：

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-dbcp2</artifactId>
    <version>${commons-dbcp2.version}</version>
    <exclusions>
        <exclusion>
            <artifactId>commons-logging</artifactId>
            <groupId>commons-logging</groupId>
        </exclusion>
    </exclusions>
</dependency>

1.2 日志的配置

logging.file	logging.path	example	Description
(none)	(none)		只在控制台输出
指定文件名	(none)	spring.log	未指定完整路径则输出到当前项目路径下spring.log文件中
(none)	指定目录	/var/log	输出到/var/log/spring.log文件中

logging.file与logging.path同时存在时，以logging.file为准

#指定com.yt包下的类日志都使用debug级别，未被指定的仍使用INFO级别
logging:
  level:
    com:
      yt: debug
  file: spring.log
  path: ./config/
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread]  %logger{50} - %msg%n"

SpringBoot的日志默认配置在org.springframework.boot:spring-boot:2.0.0.RELEASE.jar的org.springframework.boot.logging包下，该包下有java.util.logging、log4j2和logback的默认配置，SpringBoot在未被指定配置的情况下使用的是logback。

我们还可以自定义日志配置文件，SpringBoot会加载classpath路径下的以下日志配置：

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

SpringBoot推荐是用*-spring.xml的命名方式进行日志配置，因为logback.xml和log4j2.xml会直接被日志框架所识别，而logback-spring.xml、log4j2-spring.xml日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能。

为了帮助定制，yml配置文件中也会配置一些属性作为系统属性：

Spring Environment	System Property	Comments
logging.exception-conversion-word	LOG_EXCEPTION_CONVERSION_WORD	记录异常时使用的转换字
logging.file	LOG_FILE	如果已定义，则用于默认的日志配置
logging.file.max-size	LOG_FILE_MAX_SIZE	最大日志文件大小（如果启用LOG_FILE）（仅支持默认的Logback设置）
logging.file.max-history	LOG_FILE_MAX_HISTORY	保留的归档日志文件的最大数量（如果启用LOG_FILE）（仅支持默认的Logback设置）
logging.path	LOG_PATH	如果已定义，则用于默认的日志配置
logging.pattern.console	CONSOLE_LOG_PATTERN	在控制台上使用的日志模式（stdout）（仅支持默认的Logback设置）
logging.pattern.dateformat	LOG_DATEFORMAT_PATTERN	日志日期格式的Appender模式（仅支持默认的Logback设置）
logging.pattern.file	FILE_LOG_PATTERN	在文件中使用的日志模式（如果LOG_FILE已启用）（仅支持默认的Logback设置）
logging.pattern.level	LOG_LEVEL_PATTERN	呈现日志级别时使用的格式（默认%5p）（仅支持默认的Logback设置）
PID	PID	当前进程ID（如果可能，还没有定义为OS环境变量时发现）

1.2.1 logback

logback日志框架默认会从类路径下试图查找logback-test.xml，如果找不到查找logback.groovy，如果找不到再查找logback.xml，如果没有查找的到配置文件，则logback将使用自动配置BasicConfiguration把日志记录输出到控制台

logback-spring.xml

<?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">
    <!--解析配置文件的时间戳-->
    <timestamp key="time" datePattern="yyyyMMdd'T'HHmmss"/>
    <!--上下文名称，默认名称为"default"-->
    <contextNmae>${time}</contextName>
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/var/log"/>
    <!-- 定义日志文件名称 -->
    <property name="appName" value="spring"></property>
    <!--
    SpringBoot的特性，与property类似，只是并不是直接指定给name一个value值，
    而是通过source从环境中获取值，并且可以设置一个默认值
    -->
    <springProperty  scope = "context"  name = "hostName"  source = "host.name" defaultValue = "localhost"/>

    <!-- 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">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
    <appender name="fileLogAppender" 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.yt" level="debug" />
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false">
        <!--指定appender，如果没有指定则继承root-->
        <appender-ref ref="stdout" />
    </logger>


    <!--springProfile是SpringBoot的特性，日志配置文件名必须是*-spring.xml，
        用于指定不同的profile，可以使用在configuration标签内任意位置
    -->
    <springProfile name="prod,!dev">
        <!--
        root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
        要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。
        -->
        <root level="info">
            <appender-ref ref="stdout" />
            <appender-ref ref="fileLogAppender" />
        </root>
    </springProfile>
    <springProfile name="dev">
        <root level="debug">
            <appender-ref ref="stdout" />
            <appender-ref ref="fileLogAppender" />
        </root>
    </springProfile>
</configuration>

appender

<appender>是<configuration>的子节点，是负责写日志的组件。<appender>有两个必要属性name和class，name指定appender名称，class指定appender的全限定名。

1.ConsoleAppender
将日志输出到控制台，有以下子节点：

<encoder>：对日志进行格式化
<target>：字符串 System.out 或者 System.err ，默认 System.out

2.FileAppender
将日志输出到文件中，有以下子节点：

<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值
<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true
<encoder>：对记录事件进行格式化
<prudent>：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false

3.RollingFileAppender
滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：

<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值
<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true
<encoder>：对记录事件进行格式化
<rollingPolicy>:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动
<prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制：1.不允许文件压缩；2.不能设置file属性，必须留空。

rollingPolicy：
ch.qos.logback.core.rolling.TimeBasedRollingPolicy是最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。有以下子节点：

<fileNamePattern>：必要节点，包含文件名及“%d”转换符，%d默认格式是yyyy-MM-dd：按天滚动，加上%i，可以在当天滚动文件大小超过maxFileSize时，按照i进行文件滚动。RollingFileAppender 的file字节点可有可无
<maxHistory>：可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件

ch.qos.logback.core.rolling.FixedWindowRollingPolicy：根据固定窗口算法重命名文件的滚动策略。有以下子节点：

<minIndex>：窗口索引最小值
<maxIndex>：窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12
<fileNamePattern >：必须包含“%i”，例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者log%i.log.zip

triggeringPolicy：
SizeBasedTriggeringPolicy：查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点：

<maxFileSize>：活动文件的大小，默认值是10MB

1.2.2 日志输出格式

%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
日志输出格式：

转换符	作用	示例
%{length} %lo{length} %logger{length}	输出日志的logger名，可有一个整形参数，功能是缩短logger名，设置为0表示只输入logger最右边点符号之后的字符串	%logger{50}
%C{length} %class{length}	输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用，除非执行速度不造成任何问题	%C{10}
%contextName %cn	输出上下文名称	%contextName
%d{pattern} %date{pattern}	输出日志打印的日期与时间，模式语法与java.text.SimpleDateFormat 兼容	%date{yyyy-MM-dd HH:mm:ss.SSS}
%F %file	输出执行记录请求的java源文件名。尽量避免使用，除非执行速度不造成任何问题	%file
%L %line	输出执行日志请求的行号尽量避免使用。除非执行速度不造成任何问题	%line
%m %msg %message	输出应用程序提供的信息	%msg
%M %method	输出执行日志请求的方法名。尽量避免使用，除非执行速度不造成任何问题	%method
%n	输出与平台无关的分行符“\n”或者“\r\n”	%n
%r %relative	输出从程序启动到创建日志记录的时间，单位是毫秒	%r
%t %thread	输出产生日志的线程名	%thread
%replace(p){r,t}	p 为日志内容，r 是正则表达式，将p 中符合r 的内容替换为t 例如， “%replace(%msg){‘\s’, ”}”

SpringBoot日志框架