Servlet3.0+springmvc5+log4j2正确的开启姿势(WebLookUp)

前言

　java社区占据市场份额比较大的日志组件由log4j 1.×，到logback，再到整合后的升级版 log4j 2.×，有网友测试后据说log4j2的性能最NB。于是开始往自己的springmvc5项目中整合log4j2框架。第一次使用，没什么经验，再加上网上出现的资料大多是旧版本，还有些介绍过于集中log4j2的属性说明，对于项目集成益处有限。接下来我结合自己这次的整合经验，跟大家分享下时下流行环境的正确开启姿势。

https://logging.apache.org/log4j/2.x/manual/configuration.html

一、Log4j2 jar包文件的导入（MAVEN）

　1.1、基础jar包依赖

<properties>
    <springframework.version>5.0.1.RELEASE</springframework.version>
    <!--下面这两个是springAOP需要用到 -->
    <aspectjweaver.version>1.9.0.RC2</aspectjweaver.version>
    <persistence-api.version>1.0.2</persistence-api.version>
    <hibernate.version>5.2.12.Final</hibernate.version>
    <security-version>5.0.0.RELEASE</security-version>
    <log4j2-version>2.10.0</log4j2-version>
</properties>
<dependencies>
<!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>${log4j2-version}</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-api -->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>${log4j2-version}</version>
    </dependency>

　1.2、web项目jar包依赖

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

说明：log4j-web jar包非常重要，它的存在使我们使用weblookup插件去寻找 ${web:×××}变量成为可能。这种方式基本可以获取所有跟web上下文环境相关的变量，包括全局属性文件、系统初始化参数、rootDir、contextPath、servletContextName等等信息，从此不再为获取项目根路径，而去特意存储系统属性(SystemProperties)或者环境变量(Environment)。而在servlet3.0+的web项目中，Log4jServletContainerInitializer初始化类还可以全自动注入log4jServletFilter，获取servletContext，这个jar包的功能绝对的能让你舒爽。

http://logging.apache.org/log4j/2.x/manual/lookups.html

　　Log4jServletContainerInitializer源码截图

　　

　　WebLookup源码截图

　　

二、配置log4j2.xml文件

　 log4j2.xml文件的配置项可以参考下《Log4j2配置文件详解》,web.xml中配置的集成方案可以忽略。下面给出我的log4j2.xml文件，使用变量${web:rootDir}获得web应用根路径，将日志文件存放到项目下，各级别日志存放在各自的文件中。

<?xml version="1.0" encoding="UTF-8"?>
<!-- 设置log4j2的自身log级别为warn -->
<!-- OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
<Configuration status="WARN">
    <Appenders>
        <!-- 控制台输出 -->
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>

        <RollingFile name="RollingFileDebug" fileName="${web:rootDir}/logs/debug.log"
            filePattern="${web:rootDir}/logs/$${date:yyyy-MM}/debug-%d{yyyy-MM-dd}-%i.log">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <Filters>
                <ThresholdFilter level="DEBUG"/>
                <ThresholdFilter level="INFO" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!--最多保留20个日志文件-->
            <DefaultRolloverStrategy max="20" min="0" />
        </RollingFile>

        <RollingFile name="RollingFileInfo" fileName="${web:rootDir}/logs/info.log"
            filePattern="${web:rootDir}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <ThresholdFilter level="INFO"/>
                <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!--最多保留20个日志文件-->
            <DefaultRolloverStrategy max="20" min="0" />
        </RollingFile>

        <RollingFile name="RollingFileWarn" fileName="${web:rootDir}/logs/warn.log"
            filePattern="${web:rootDir}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <Filters>
                <ThresholdFilter level="WARN"/>
                <ThresholdFilter level="ERROR" onMatch="DENY" onMismatch="NEUTRAL"/>
            </Filters>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!--最多保留20个日志文件-->
            <DefaultRolloverStrategy max="20" min="0" />
        </RollingFile>

        <RollingFile name="RollingFileError" fileName="${web:rootDir}/logs/error.log"
            filePattern="${web:rootDir}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="ERROR"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!--最多保留20个日志文件-->
            <DefaultRolloverStrategy max="20" min="0" />
        </RollingFile>

        <RollingFile name="RollingFileFatal" fileName="${web:rootDir}/logs/fatal.log"
            filePattern="${web:rootDir}/logs/$${date:yyyy-MM}/fatal-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="FATAL"/>
            <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <!--最多保留20个日志文件-->
            <DefaultRolloverStrategy max="20" min="0" />
        </RollingFile>
    </Appenders>
    <Loggers>
         <!--过滤掉simm.spring.restapi一些无用的DEBUG信息-->
        <logger name="simm.spring.restapi" level="INFO"></logger>
        <Root level="all">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFileDebug"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
            <appender-ref ref="RollingFileFatal"/>
        </Root>
    </Loggers>
</Configuration>

三、集成完毕，运行看效果

　　

日志文件完美输出，保存在项目运行根目录下。是不是特别简单？没错，servlet3.0以上版本的web项目集成log4j2框架就是这么赞，不需要在web.xml中做任何配置，只要引入jar包，配置好自己的log4j2.xml文件，其它的事情都交给框架自己搞定就好了！假如你的项目使用的环境比较时尚，碰巧你又不怎么会用log4j2，那么希望这篇分享能对你有所帮助。