记录Log4j2

Springboot中使用

1.在pom.xml中加入jar包依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <!--去除系统自带的日志工具-->
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!--引入想用的日志工具-->
         <dependency>
           <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-log4j2</artifactId>
       </dependency>

2.在application.properties配置

logging.config=classpath:log4j2.xml
logbook.write.level=TRACE
logbook.format.style=http

3.在项目的resources下添加

log4j2.xml文件

1.配置全解

• a.关于配置文件的名称以及在项目中的存放位置
  log4j的2.x版本不再支持像1.x中的.properties后缀的文件配置方式，2.x版本配置文件后缀名只能为".xml"，".json"，".jsn"
• b.系统选择配置文件的优先级(从先到后)如下
  (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即可
• c.缺省默认配置文件

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

2.配置文件节点解析

• 1.根节点Configuration有两个属性:status和monitorinterval,有两个子节点:Appenders和Loggers(表明可以定义多个Appender和Logger)
  • status用来指定log4j本身的打印日志的级别.
  • monitorinterval用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s.
• 2.Appenders节点，常见的有三种子节点:Console、RollingFile、File
  • Console节点用来定义输出到控制台的Appender
    • name:指定Appender的名字.
    • target:SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.
    • PatternLayout:输出格式，不设置默认为:%m%n
    • ThresholdFilter： 临界值过滤器，过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时，过滤器返回NEUTRAL；当日志级别低于临界值时，日志会被拒绝
• 3.File节点用来定义输出到指定位置的文件的Appender
  • name:指定Appender的名字.
  • fileName:指定输出日志的目的文件带全路径的文件名.
  • PatternLayout:输出格式，不设置默认为:%m%n
• 4.RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender
  • name:指定Appender的名字.
  • fileName:指定输出日志的目的文件带全路径的文件名.
  • PatternLayout:输出格式，不设置默认为:%m%n.
  • filePattern:指定新建日志文件的名称格式.
  • Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
  • TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am.
  • SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
  • DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)
• 5.Loggers节点，常见的有两种:Root和Logger
  • a.Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
    • level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
    • AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.
  • b.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中进行输出
• 6.关于日志level.
  • 共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
    • All:最低等级的，用于打开所有日志记录.
    • Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.
    • Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
    • Info:消息在粗粒度级别上突出强调应用程序的运行过程.
    • Warn:输出警告及warn以下级别的日志.
    • Error:输出错误信息日志.
    • Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
    • OFF:最高等级的，用于关闭所有日志记录.
      程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少

<?xml version="1.0" encoding="UTF-8"?>
 <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
 <!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
 <!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
 <configuration status="WARN" monitorInterval="30">
     <!--先定义所有的appender-->
     <appenders>
     <!--这个输出控制台的配置-->
         <console name="Console" target="SYSTEM_OUT">
         <!--输出日志的格式-->
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%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="${sys:user.home}/logs/info.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
             <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->        
             <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         </RollingFile>
         <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
             <DefaultRolloverStrategy max="20"/>
         </RollingFile>
         <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
                      filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
             <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
             <Policies>
                 <TimeBasedTriggeringPolicy/>
                 <SizeBasedTriggeringPolicy size="100 MB"/>
             </Policies>
         </RollingFile>
     </appenders>
     <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
     <loggers>
         <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
         <logger name="org.springframework" level="INFO"></logger>
         <logger name="org.mybatis" level="INFO"></logger>
         <root level="all">
             <appender-ref ref="Console"/>
             <appender-ref ref="RollingFileInfo"/>
             <appender-ref ref="RollingFileWarn"/>
             <appender-ref ref="RollingFileError"/>
         </root>
     </loggers>
 </configuration>

以上是同步日志的介绍，下面是异步日志

需要再引入一个依赖
        <!--// 如果开启了异步日志，这里需要加这个依赖，不然控制台不会打印。-->
        <!--// Disruptor是一个高性能的异步处理框架，或者可以认为是线程间通信的高效低延时的内存消息组件，-->
        <!--// 它最大特点是高性能，其LMAX架构可以获得每秒6百万订单，用1微秒的延迟获得吞吐量为100K+-->
        <dependency>
            <groupId>com.lmax</groupId>
            <artifactId>disruptor</artifactId>
            <version>3.4.1</version>
        </dependency>

完整的异步日志配置如下
<?xml version="1.0" encoding="UTF-8"?>
<configuration status="debug">

    <!--全局参数-->
    <Properties>
        <Property name="pattern">%d{yyyy-MM-dd HH:mm:ss} [%highlight{%level}] - %l - %msg%n</Property>
        <Property name="projectName">sanrenxing</Property>
        <!-- TimeBasedTriggeringPolicy滚动策略和CronTriggeringPolicy一样，但是
        没有CronTriggeringPolicy灵活-->
        <Property name="timeRollover">1</Property>
        <!--最多个数-->
        <Property name="rolloverStrategyMax">30</Property>
        <!--最少满足多少个-->
        <Property name="rolloverStrategyMin">30</Property>
        <!--每天的0点、12点、18点执行一次-->
        <Property name="scheduleCron">0 0 00,12,18 * * ?</Property>
        <!--最多删除个数-->
        <Property name="deleteMaxDepth">1</Property>
        <!--60天以前-->
        <Property name="lastModifiedAge">10d</Property>
    </Properties>

    <appenders>
        <!--控制台输出-->
        <Console name="STDOUT" target="SYSTEM_OUT" follow="true">
            <!--输出级别  过滤掉低于指定临界值的日志-->
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY"/>
            <!--输出格式-->
            <PatternLayout>
                <Pattern>${pattern}</Pattern>
            </PatternLayout>
        </Console>

        <!--
        fileName:指定输出日志的目的文件带全路径的文件名
        filePattern:指定新建日志文件的名称格式,logs/xxx:当前运行jar包同级目录下
        ThresholdFilter：输出级别
        TimeBasedTriggeringPolicy：基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour
        DefaultRolloverStrategy：用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的。
            min:限定必须最少几个才并且max="10"同时存在10个才满足
            必须满足最少min个，最多max个进来
        CronTriggeringPolicy:按照Cron表达式设置的时间点进行切割日志. 每小时 0 0 * * * ?
        Delete的maxDepth：删除多少个
            满足上面的还必须满足这里的
            age以前的，删除个数为maxDepth
        IfLastModified的age: xh:x小时前  xd:x天前 xm:x分钟前 xs:x秒前
        -->
        <RollingFile
                name="FILE-INFO"
                fileName="logs/${projectName}-info.log"
                filePattern="logs/${projectName}-info.%d{yyyy-MM-dd-HH}.log">
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout charset="UTF-8">
                <Pattern>${pattern}</Pattern>
            </PatternLayout>
            <CronTriggeringPolicy schedule="${scheduleCron}"/>
            <DefaultRolloverStrategy min="${rolloverStrategyMin}" max="${rolloverStrategyMax}"  >
                <Delete basePath="logs" maxDepth="${deleteMaxDepth}">
                    <IfFileName glob="*${projectName}-info.*.log" />
                    <IfLastModified age="${lastModifiedAge}" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>



        <!--RollingRandomAccessFile 默认日志文件写入策略为异步刷盘，
        引出一个缓冲区（buffer）的概念，RollingRandomAccessFile 会将日志信息先写入到缓冲区，
        然后缓冲区满后刷到磁盘，并清空缓冲区，默认缓冲区的大小在8-256kb，
        具体大小需要自己设置，所以说不会立即产生日志-->
        <RollingFile
                name="FILE-DEBUG"
                fileName="logs/${projectName}-debug.log"
                filePattern="logs/${projectName}-debug.%d{yyyy-MM-dd-HH}.log">
            <ThresholdFilter level="debug" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout charset="UTF-8">
                <Pattern>${pattern}</Pattern>
            </PatternLayout>
            <CronTriggeringPolicy schedule="${scheduleCron}"/>
            <DefaultRolloverStrategy min="${rolloverStrategyMin}" max="${rolloverStrategyMax}"  >
                <Delete basePath="logs" maxDepth="${deleteMaxDepth}">
                    <IfFileName glob="*${projectName}-debug.*.log" />
                    <IfLastModified age="${lastModifiedAge}" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>

        <RollingFile
                name="FILE-WARN"
                fileName="logs/${projectName}-warn.log"
                filePattern="logs/${projectName}-warn.%d{yyyy-MM-dd-HH}.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout charset="UTF-8">
                <Pattern>${pattern}</Pattern>
            </PatternLayout>
            <CronTriggeringPolicy schedule="${scheduleCron}"/>
            <DefaultRolloverStrategy min="${rolloverStrategyMin}" max="${rolloverStrategyMax}"  >
                <Delete basePath="logs" maxDepth="${deleteMaxDepth}">
                    <IfFileName glob="*${projectName}-warn.*.log" />
                    <IfLastModified age="${lastModifiedAge}" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>

        <RollingFile
                name="FILE-ERROR"
                fileName="logs/${projectName}-error.log"
                filePattern="logs/${projectName}-error.%d{yyyy-MM-dd-HH}.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY" />
            <PatternLayout charset="UTF-8">
                <Pattern>${pattern}</Pattern>
            </PatternLayout>
            <CronTriggeringPolicy schedule="${scheduleCron}"/>
            <DefaultRolloverStrategy min="${rolloverStrategyMin}" max="${rolloverStrategyMax}"  >
                <Delete basePath="logs" maxDepth="${deleteMaxDepth}">
                    <IfFileName glob="*${projectName}-error.*.log" />
                    <IfLastModified age="${lastModifiedAge}" />
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>
    </appenders>

    <loggers>

        // Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等
        <AsyncLogger name="com.project.userservice.mapper" level="DEBUG" additivity="false">
            <appender-ref ref="FILE-DEBUG" />
            <appender-ref ref="STDOUT" />
        </AsyncLogger>

        // 节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
        <AsyncRoot level="INFO" includeLocation="true" >
            <AppenderRef ref="FILE-INFO" />
            <AppenderRef ref="FILE-WARN" />
            <AppenderRef ref="FILE-ERROR" />
            <AppenderRef ref="STDOUT" />
        </AsyncRoot>
    </loggers>
</configuration>