log4j2配合slf4j使用

说明

　　log4j2被用于日志输出，相信绝大多数程序猿都对此不陌生。笔者刚接触log4j2，因此记个博客备用。
　　log4j2是一个日志框架，slf4j是日志框架接口，之所以使用log4j2和slf4j搭配使用是为了以后如果项目对日志有其它要求而需要更换日志框架时可以不改动代码，只需要把依赖的jar包换掉就可以了。

依赖

// log4j2依赖
log4j-api-2.8.2.jar
log4j-core-2.8.2.jar
// log4j2和slf4j桥接依赖
log4j-slf4j-impl-2.8.2.jar
// slf4j依赖
slf4j-api-1.7.25.jar

注意，log4j依赖和桥接依赖的jar包版本最好保持一致。

配置文件

　　使用log4j2之前需要在classpath下新建一个配置文件。需要注意的是log4j 2.x版本不再支持像1.x中的.properties后缀的文件配置方式，2.x版本配置文件后缀名只能为”.xml”,”.json”或者”.jsn”。

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

• classpath下的名为log4j2-test.json 或者log4j2-test.jsn的文件
• classpath下的名为log4j2-test.xml的文件
• classpath下名为log4j2.json 或者log4j2.jsn的文件
• classpath下名为log4j2.xml的文件

---

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

默认配置文件：

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

配置文件实例：

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="error">
<!--     先定义所有的appender -->
    <appenders>
<!--         这个输出控制台的配置 -->
        <Console name="Console" target="SYSTEM_OUT">
<!--               控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
<!--             这个都知道是输出日志的格式 -->
            <PatternLayout pattern="[%d{HH:mm:ss.SSS}] [%-5p] %l - %m%n"/>
        </Console>

<!--         文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用 -->
<!--         append为TRUE表示消息增加到指定文件中，false表示消息覆盖指定的文件内容，默认值是true -->
        <File name="log" fileName="log/test.log" append="false">
            <PatternLayout pattern="[%d{HH:mm:ss.SSS}] [%-5p] %l - %m%n"/>
        </File>

<!--         添加过滤器ThresholdFilter,可以有选择的输出某个级别以上的类别  onMatch="ACCEPT" onMismatch="DENY"意思是匹配就接受,否则直接拒绝  -->
        <File name="ERROR" fileName="logs/error.log">
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="[%d{yyyy.MM.dd 'at' HH:mm:ss z}] [%-5p] %l - %m%n"/>
        </File>

<!--         这个会打印出所有的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
        <RollingFile name="RollingFile" fileName="logs/web.log"
                     filePattern="logs/$${date:yyyy-MM}/web-%d{MM-dd-yyyy}-%i.log.gz">
            <PatternLayout pattern="[%d{yyyy-MM-dd 'at' HH:mm:ss z}] [%-5p] %l - %m%n"/>
            <SizeBasedTriggeringPolicy size="2MB"/>
        </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的logger -->
        <root level="trace">
            <appender-ref ref="RollingFile"/>
            <appender-ref ref="Console"/>
            <appender-ref ref="ERROR" />
            <appender-ref ref="log"/>
        </root>

    </loggers>
</configuration>

配置文件说明
　　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.
• File节点用来定义输出到指定位置的文件的Appender.
  • name:指定Appender的名字.
  • fileName:指定输出日志的目的文件带全路径的文件名.
  • PatternLayout:输出格式，不设置默认为:%m%n.
• RollingFile节点用来定义超过指定大小自动删除旧的创建新的的Appender.
  • name:指定Appender的名字.
  • fileName:指定输出日志的目的文件带全路径的文件名.
  • PatternLayout:输出格式，不设置默认为:%m%n.
  • filePattern:指定新建日志文件的名称格式.
  • Policies:指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
  • TimeBasedTriggeringPolicy:Policies子节点，基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am…而不是7am.
  • SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
  • DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。

---

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

• Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出
  • level:日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
  • AppenderRef：Root的子节点，用来指定该日志输出到哪个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中进行输出。

---

输出日志

/**
 *
 */
package com.petro.test;

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

/**
 * @description 数据库工具类
 * @author PetterChen
 * @date 2017年10月14日 下午9:38:42
 */
public class LogTest {
    /**
     * 日志输出
     */
    private static Logger log = LoggerFactory.getLogger(LogTest.class);

    /**
     * @description 测试
     * @date 2017年10月14日 下午9:38:42
     * @param args
     */
    public static void main(String[] args) {
        // TODO Auto-generated method stub
        log.trace("trace");
        log.debug("debug");
        log.warn("warn");
        log.info("info");
        log.error("error");
    }

}