006-springboot2.0.4 配置log4j2，以及打印mybatis的sql

一、pom配置

普通项目

<!-- log4j2 -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>${log4j2.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>${log4j2.version}</version>
        </dependency>
        <dependency>
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-web</artifactId>
             <version>${log4j2.version}</version>
        </dependency>

springboot项目

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

注意其他项目spring-boot-starter、spring-boot-starter-web等要排除依赖

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

对于其他含有log4j的依赖也要清除，否则可能不生效

方式：https://www.cnblogs.com/bjlhx/p/7518082.html中第四项

二、log4j2使用

2.1、在配置文件中配置使用的log4j2文件【默认文件log4j2-spring.xml可以不用配置】

logging.config=classpath:log4j2-spring-dev.xml

2.2、log4j2具体配置【示例配置】

<?xml version="1.0" encoding="UTF-8"?>
<!--设置log4j2的自身log级别为warn-->
<!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，
    当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration status="warn" monitorInterval="30">
    <!--全局参数-->
    <Properties>
        <!--<Property name="logPath">/export/Logs/bt-middle-data-main</Property>-->
        <Property name="logPath">/Users/lihongxu6/log/bt-middle-data-main</Property>
    </Properties>
    <!--先定义所有的appender-->
    <appenders>
        <!--这个输出控制台的配置-->
        <console name="Console" target="SYSTEM_OUT">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
            <!--<ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>-->
            <!--输出日志的格式-->
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}-%t] [%p] - %l - %m%n"/>
        </console>
        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
        <!--<File name="log" fileName="log/test.log" append="false">-->
        <!--<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>-->
        <!--</File>-->
        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，
        则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${logPath}/info.log"
                     filePattern="${logPath}/info_%d{yyyy-MM-dd}.log">
            <!--<Filters>-->
                <!--&lt;!&ndash;控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）&ndash;&gt;-->
                <!--<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>-->
                <!--&lt;!&ndash;<ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>&ndash;&gt;-->
            <!--</Filters>-->
            <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}-%t] [%p] - %l - %m%n"/>
            <Policies>
                <!--按照filePattern 时间单位 interval 间隔生成文件-->
                <TimeBasedTriggeringPolicy modulate="true" interval="1"/>
                <!--定了当日志文件达到了指定的size时，触发rollover操作。size参数可以用KB、MB、GB等做后缀来指定具体的字节数-->
                <!--<SizeBasedTriggeringPolicy size="1G"/>-->
            </Policies>
        </RollingFile>

    </appenders>
    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>
        <!--过滤掉spring和hibernate的一些无用的debug信息-->
        <logger name="org.springframework" level="INFO">
        </logger>
        <logger name="org.elasticsearch" level="INFO">
        </logger>
        <logger name="com.jd.jsf.gd" level="warn">
        </logger>
        <logger name="org.mybatis" level="INFO">
        </logger>
        <!-- 将业务dao接口填写进去,并用控制台输出即可 -->
        <logger name="com.jd.bt.middle.data.repository" level="debug" additivity="false">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
        </logger>

        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
        </root>
    </loggers>

</configuration>

三、详细说明

3.1、配置文件加载

log4j 2.x版本不再支持像1.x中的.properties后缀的文件配置方式，2.x版本配置文件后缀名只能为".xml",".json"或者".jsn".

系统选择配置文件的优先级(从先到后)如下：

(1).classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件.
(2).classpath下的名为log4j2-test.xml的文件.
(3).classpath下名为log4j2.json 或者log4j2.jsn的文件.
(4).classpath下名为log4j2.xml的文件.

　　我们一般默认使用log4j2.xml进行命名。如果本地要测试，可以把log4j2-test.xml放到classpath，而正式环境使用log4j2.xml，则在打包部署的时候不要打包log4j2-test.xml即可。

3.2、缺省配置

<?xml version="1.0" encoding="UTF-8"?>
 <Configuration status="WARN">
   <Appenders>
     <Console name="Console" target="SYSTEM_OUT">
       <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
     </Console>
   </Appenders>
   <Loggers>
     <Root level="error">
       <AppenderRef ref="Console"/>
     </Root>
   </Loggers>
</Configuration>

3.3、配置文件节点解析

(1).根节点Configuration

　　有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger).

　　status：用来指定log4j本身的打印日志的级别.

　　monitorinterval：用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.【调试时候很实用】

(2).Appenders节点　

1、子节点　　

　　常见的有三种子节点:Console、RollingFile、File.

　　Console节点用来定义输出到控制台的Appender.

　　　　name:指定Appender的名字.

　　　　target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.

　　　　PatternLayout:输出格式，不设置默认为:%m%n,

　　File节点用来定义输出到指定位置的文件的Appender.

　　　　name:指定Appender的名字.

　　　　fileName:指定输出日志的目的文件带全路径的文件名.

　　　　PatternLayout:输出格式，不设置默认为:%m%n.

　　RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.

　　　　name:指定Appender的名字.

　　　　fileName:指定输出日志的目的文件带全路径的文件名.

　　　　PatternLayout:输出格式，不设置默认为:%m%n.

　　　　filePattern:指定新建日志文件的名称格式.

　　　　Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.

• 　　　TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am.

　　　　　　　　<!--按照filePattern 时间单位 interval 间隔生成文件-->

　　　　　　　　　　interval：（integer）该属性是相对 RollingFile.filePattern 中的%d{yyyy-MM-dd}值,例：

　　　　　　　　　　　　filePattern=”xxx%d{yyyy-MM-dd}xx” interval=”2” 表示将2天一个日志文件；
　　　　　　　　　　　　filePattern=”xxx%d{yyyy-MM-dd-HH}xx” interval=”1”表示一个小时一个日志文件

• 　　　SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.

　　　　　　　　<!--定了当日志文件达到了指定的size时，触发rollover操作。size参数可以用KB、MB、GB等做后缀来指定具体的字节数-->

• 　　　DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

2、Filters.ThresholdFilter【过滤】

　　主要用于不同类型日志放置在不同文件中

　　level 输出级别，例：level=”info”,日志级别为info或者以上(匹配的界别)
　　onMatch DENY/ACCEPT 禁止或者接受（是否接受匹配）
　　onMismatch DENY/NEUTRAL （是否接受其他高于level的级别）

　　例如：只打印info日志

            <Filters>
                <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
                <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
                <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            </Filters>

(3).Loggers节点，常见的有两种:Root和Logger.

　　Root：始祖日志，节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出

　　　　level:[属性]日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

　　　　AppenderRef：Root的子节点，ref用来指定该日志输出到哪个Appender.

　　Logger注册子日志，节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。

　　　　level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

　　　　name:用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.

　　　　AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

　　　　additivity：是否冒泡，既在本层输出日志后是否需要在父对象上输出该日志，默认为 true

(4).关于日志level.

　　共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

　　All:最低等级的，用于打开所有日志记录.

　　Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.

　　Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.

　　Info:消息在粗粒度级别上突出强调应用程序的运行过程.

　　Warn:输出警告及warn以下级别的日志.

　　Error:输出错误信息日志.

　　Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.

　　OFF:最高等级的，用于关闭所有日志记录.

　　程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少。

3.4、log4j2 logger 加载规则

logger name 相同时，以 level 级别高的为准
logger name = “org” 会被 name=”org.xxx” 继承
logger 中的 additivity=”true” 表示子日志所获得的日志也会在父日志中出现，即使 父日志的 level 远高于子日志的 level
当子日志 level 大于 父日志时，父日志只能接收到子日志过滤后的日志

3.5、类图

编译理解的一个示例

<?xml version="1.0" encoding="UTF-8"?>
<!-- configure.status 为设置日志输出级别，级别如下：OFF 、FATAL 、ERROR、WARN、INFO、DEBUG、TRACE 、ALL  -->
<!-- configure.monitorInterval 监控间隔
         指log4j2每隔600秒（10分钟），自动监控该配置文件是否有变化，如果变化，则自动根据文件内容重新配置 -->
<configuration status="off" monitorInterval="600">
  <properties>
    <property name="LOG_HOME">E:/webbase/logs</property>
    <property name="LOG_BACK_HOME">${LOG_HOME}/backup</property>
    <property name="ERROR_FILE_NAME">error</property>
    <property name="WARN_FILE_NAME">warn</property>
    <property name="INFO_FILE_NAME">info</property>
    <property name="DEBUG_FILE_NAME">debug</property>
  </properties>
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} {%t} %-5level %logger{36} - %msg%n"/>
    </Console>
    <!-- 配置日志输出文件名字     追加读写 -->
    <!-- Error console log -->
    <RollingFile name="ErrLog" fileName="${LOG_HOME}/${ERROR_FILE_NAME}.log" filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/${ERROR_FILE_NAME}.%d{yyyy-MM-dd}.log" append="true">
        <!-- 输出格式 -->
        <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/>
        <!-- 设置策略 -->
        <Policies>
            <!-- 基于时间的触发策略。该策略主要是完成周期性的log文件封存工作。有两个参数：
                interval，integer型，指定两次封存动作之间的时间间隔。单位:以日志的命名精度来确定单位，
                    比如yyyy-MM-dd-HH 单位为小时，yyyy-MM-dd-HH-mm 单位为分钟
                modulate，boolean型，说明是否对封存时间进行调制。若modulate=true，
                    则封存时间将以0点为边界进行偏移计算。比如，modulate=true，interval=4hours，
                    那么假设上次封存日志的时间为03:00，则下次封存日志的时间为04:00，
                    之后的封存时间依次为08:00，12:00，16:00
             -->
            <TimeBasedTriggeringPolicy interval="1" modulate="true" />
        </Policies>
        <Filters>
         <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
        </Filters>
    </RollingFile> 

    <!-- Warn console log -->
    <RollingFile name="WarnLog" fileName="${LOG_HOME}/${WARN_FILE_NAME}.log" filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/${WARN_FILE_NAME}.%d{yyyy-MM-dd}.log" append="true">
        <!-- 输出格式 -->
        <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/>
        <!-- 设置策略 -->
        <Policies>
            <TimeBasedTriggeringPolicy interval="1" modulate="true" />
        </Policies>
        <Filters>
          <ThresholdFilter level="error" onMatch="DENY" onMismatch="NEUTRAL"/>
          <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
        </Filters>
    </RollingFile>
    <!-- Info console log -->
    <RollingFile name="InfoLog" fileName="${LOG_HOME}/${INFO_FILE_NAME}.log" filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/${INFO_FILE_NAME}.%d{yyyy-MM-dd}.log" append="true">
        <!-- 输出格式 -->
        <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/>
        <!-- 设置策略 -->
        <Policies>
            <TimeBasedTriggeringPolicy interval="1" modulate="true" />
        </Policies>
        <Filters>
          <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL"/>
          <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </Filters>
    </RollingFile>
    <!-- Debug console log -->
    <RollingFile name="DebugLog" fileName="${LOG_HOME}/${DEBUG_FILE_NAME}.log" filePattern="${LOG_BACK_HOME}/$${date:yyyy-MM}/${DEBUG_FILE_NAME}.%d{yyyy-MM-dd}.log" append="true">
        <!-- 输出格式 -->
        <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n"/>
        <!-- 设置策略 -->
        <Policies>
            <TimeBasedTriggeringPolicy interval="1" modulate="true" />
        </Policies>
        <Filters>
          <ThresholdFilter level="info" onMatch="DENY" onMismatch="NEUTRAL"/>
          <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
        </Filters>
    </RollingFile>
  </Appenders>
  <Loggers>
    <Logger name="org.webbase" level="debug" additivity="true">
        <AppenderRef ref="DebugLog" />
        <AppenderRef ref="InfoLog" />
    </Logger>
    <Root level="warn">
        <AppenderRef ref="WarnLog" />
        <AppenderRef ref="ErrLog" />
        <AppenderRef ref="Console"/>
    </Root>
  </Loggers>
</configuration>

github：https://github.com/bjlhx15/spring-cloud-base/tree/master/service2-log

3.6、日志Layout布局方式

SimpleLayout：以简单的形式显示

HTMLLayout：以HTML表格显示

PatternLayout：自定义形式显示

在Log4J2中基本采用PatternLayout自定义日志布局。含有CSV/JSON/HTML/RFC-5424/pattern/XML

自定义格式PatternLayout：

%t：线程名称

%p：日志级别

%c：日志消息所在类名

%m：消息内容

%M：输出执行方法

%d：发生时间，%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2011-10-18 22:10:28,921

%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

%L：代码中的行数

%n：换行

个人常用：<PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss:SSS}-%t] [%p] - %l - %m%n"/>

关于几个参数特殊说明

　　%c: Logger的名称。它可以接受一个整型的参数。规则如下：

Conversion Pattern	Logger Name	Result
%c{1}	org.apache.commons.Foo	Foo
%c{2}	org.apache.commons.Foo	commons.Foo
%c{1.}	org.apache.commons.Foo	o.a.c.Foo
%c{1.1.~.~}	org.apache.commons.test.Foo	o.a.~.~.Foo
%c{.}	org.apache.commons.test.Foo	....Foo

　　%d：日志事件的时间。参考示例如下：

Pattern	Example
%d{DEFAULT}	2012-11-02 14:34:02,781
%d{ISO8601}	2012-11-02T14:34:02,781
%d{ISO8601_BASIC}	20121102T143402,781
%d{ABSOLUTE}	14:34:02,781
%d{DATE}	02 Nov 2012 14:34:02,781
%d{COMPACT}	20121102143402781
%d{HH:mm:ss,SSS}	14:34:02,781
%d{dd MMM yyyy HH:mm:ss,SSS}	02 Nov 2012 14:34:02,781
%d{HH:mm:ss}{GMT+0}	18:34:02
%d{UNIX}	1351866842
%d{UNIX_MILLIS}	1351866842781

四、打印sql日志

　　将dao或mapper等包注册logger

        <!-- 将业务dao接口填写进去,并用控制台输出即可 -->
        <logger name="com.github.bjlhx15.repository" level="trace" additivity="false">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileInfo"/>
        </logger>