Java for Web学习笔记（五十）：Log（2）配置log4j2

相关maven

<!-- log4j-api提供logging的API。这是log4j2中唯一需要在compile时加入，含有你所需的所有类 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.8.1</version>
    <scope>compile</scope>
</dependency>  

<!-- log4j-core含有Log4j 2的实现，根据配置具体实现，而API不需要配置，也选择在运行时。不过配置为compile似乎也没什么问题 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.8.1</version>
    <scope>runtime</scope>
</dependency>  

<!-- log4j-jcl是支持API的adapter。有lib采用Commons Logging API（Log4j），这个adapter可将Log4j 2作为它的实现。 -->
<!-- 如果我们想看到这些第三方库的log，我们可以采用这种方式，例如httpclient，采用了commons-logging（具体参见 https://hc.apache.org/httpcomponents-client-4.3.x/httpclient-cache/dependencies.html ），通过加入log4j-jcl可以将log通过log4j2，也就是我们自己项目的log来输出。 -->
<!-- 这个怎么看了，有时也挺烦的。httpclient可以在debug情况下看出交互的包内容。 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-jcl</artifactId>
    <version>2.8.1</version>
    <scope>runtime</scope>
</dependency>

<!-- log4j-slf4j-impl是SLF4J的adapter，例如C3P0，如果开到DEBUG级别，那log就是眼花缭乱了。 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.8.1</version>
    <scope>runtime</scope>
</dependency>

<!-- log4j-taglib是JSP Tag lib的adapter。和之前一样采用runtime，避免在编译时出现不兼容。 -->
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-taglib</artifactId>
    <version>2.8.1</version>
    <scope>runtime</scope>
</dependency>

配置文件位置

缺省位置

　　缺省是在console中显示error级别。配置文件依次寻找为

1. log4j.configurationFile
2. log4j2-test.json 或 log4j2-test.jsn
3. log4j2-test.xml
4. log4j2.json 或 log4j2.jsn
5. log4j2.xml
6. 可以在代码中指定位置

　　开发中缺省位置如下，war包将存放在classpath中。

代码指定配置文件

private static Logger logger = null;
/**
 * 指定log4j2的配置文件
 * 参考：http://logging.apache.org/log4j/2.x/log4j-core/apidocs/index.html
 * 
 * @param file  配置文件名字，建议绝对路径的方式
 * @throws FileNotFoundException 异常
 * @throws IOException 异常
 */
public static void initLogger(String file) throws FileNotFoundException,IOException{
    ConfigurationSource source = new ConfigurationSource(new FileInputStream(file),new File(file));
    Configurator.initialize(null, source);
    //【注意】必须要初始化之后，才设置logger的值，否则会出错。          
    logger = LogManager.getLogger(); 
}

web.xml指定配置文件

<context-param>
    <param-name>log4jConfiguration</param-name> 
    <param-value>D:\develop\eclipse-jee-mars-2-win32\book\customer-support\conf\log4j2.xml</param-value>
</context-param>

编写配置文件

一个简单的配置文件

　　我们先从一个极为简单的配置文件开始

<?xml version="1.0" encoding="UTF-8"?>
<!-- configuration status的级别指的是log4j2自己本身的log，一般WARN就足以。
 monitorInterval强烈要求加上，本例表示每5分钟（300秒）重新读取配置文件，我们可以准实时地修改log的级别。 -->
<configuration status="WARN" monitorInterval="300"> 
    <!-- appenders中定义log的目的地，本例第一个了名字为Console的appender，为SYSTEM_OUT方式输出到Console -->
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </appenders>

    <!-- 代码中通过getLogger()获得的logger实例。本例只定义了根looger，采用名字叫做Console的appender，级别为debug -->
    <loggers>
        <root level="debug">
            <appender-ref ref="Console"/>
        </root>
    </loggers>
</configuration>

appender

　　在appenders中可以定义多个appender，在实际应用中，我们希望将log记录在文件中，以便事后调阅，相关的appender如下：

<configuration ... ...>
    <!-- 为了方便修改，通常将log目录和log名字定义为一个参数 -->
    <properties>
        <property name="logPath">/usr/local/log</property>
        <property name="logName">mytest</property>
    </properties>

    <appenders>
        ... 其他 appender ...
       <!-- log文件名字为mytest.log，当达到policy的条件时，将压缩为zip文件，并重新写mytest.log。
            压缩文件名字样式在filepattern中定义，本例例子mytest-20170418-1.log.zip，%d{yyyyMMdd}表示以年月日，%i表示序号。%i的最大值在DefaultRolloverStrategy中定义，如果已经达到最大值，则删除-1，将-2改名为-1，如此类推。 -->
       <RollingFile name="RollingFile" filename="${logPath}/${logName}.log"  filepattern="${logPath}/${logName}-%d{yyyyMMdd}-%i.log.zip">
           <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] [%-5level] - %msg%n"/> 
           <Policies>
               <!-- 当log文件达到25M的时候，需要进行压缩，新起一个log -->
               <SizeBasedTriggeringPolicy size="25 MB"/>
               <!-- 当新的1天（根据yyyyMMdd的最小时间间隔确定），需要进行压缩，新起一个log -->
               <TimeBasedTriggeringPolicy interval="1" modulate="true" />
           </Policies>    
           <DefaultRolloverStrategy max="20"/>
       </RollingFile>    
    </appenders>

    <loggers>
         ......
    </loggers>
</configuration>

PatternLayout的pattern

　　这里定义输出log的样式

说明	样式	例子
%d 时间戳	%d{HH:mm:ss.SSS}  %d{yyyy-MM-dd HH:mm:ss.SSS}  %d{DEFAULT}  %d{ISO8601}  %d{UNIX}  %d{UNIX_MILLIS}	16:20:22.257 2017-04-18 16:20:22.257 2017-04-18 16:20:22,257 2017-04-18T16:20:22,257 1492503622 1492503622257
%t 线程名字	[%t]	[localhost-startStop-1] 我们可以利用线程名字，将请求和响应对应起来
%logger，%c：类名	%c  %c{2}  %c{1}  %c{2.}  %c{1.}	cn.wei.flowingflying.chapter10.tictactoe.GlobalListener 全部信息 tictactoe.GlobalListener 显示最后2个 GlobalListener 显示最后1个 cn.we.fl.ch.ti.GlobalListener 缩写2个字母 c.w.f.c.t.GlobalListener 缩写1个字母
%l		cn.wei.flowingflying.chapter10.tictactoe.GlobalListener.contextInitialized(GlobalListener.java:58)
方法名	%M	contextInitialized
文件名字	%F	GlobalListener.java
所在的行号	%L	58
消息	%m %msg %message
换行	%n
日志级别	%level
%X	%X{username}	显示ThreadContext中map里面的信息，在后面详细说明

Loggers

　　在loggers中定义一个或多个logger，代码中的logger实例将匹配其中某个。

<?xml version="1.0" encoding="UTF-8"?>
<configuration ... ...>
    ...... 

    <!-- 为了方便修改，通常将log目录和log名字定义为一个参数 -->
    <loggers>
        <!-- root为最基本的根logger，匹配所有的logger实例。-->
        <root level="warn">
            <appender-ref ref="Console" />
        </root>

        <!-- 如果logger实例的前缀cn.wei，则匹配此项。如果additivity为true，则最优匹配，不再往下匹配，即不在匹配root；如果为flase，则继续匹配，本例还匹配root，相当还要在Console中输出，级别为INFO，由本logger确定。-->
        <logger name="cn.wei" level="info" additivity="false">
            <appender-ref ref="WroxFileAppender" />
                <MarkerFilter marker="WROX_CONSOLE" onMatch="NEUTRAL" onMismatch="DENY" />
            </appender-ref>
        </logger>

        <!-- 匹配名字前缀为org.apache的实例。缺省additivity为true，即会在console中显示 -->
        <logger name="org.apache" level="info">
            <appender-ref ref="WroxFileAppender" />
        </logger>
    </loggers>
</configuration>

Filter

　　在前面已经提供了fiter的例子

<!-- NETUTAL表示继续匹配，直到DENY或者ACCEPT，最后的缺省为ACCEPT，本例maker为WROX_CONSOLE的log要ACCEPT，利用filter可以进行log的过滤 -->
<logger name="cn.wei" level="info" additivity="false">
     <appender-ref ref="WroxFileAppender" />
         <MarkerFilter marker="WROX_CONSOLE" onMatch="NEUTRAL" onMismatch="DENY" />
     </appender-ref>
</logger>

　　除了在logger外，在Appender也可以定义filter，在configuration下面可以定义context-wide的filter。

　　相关链接： 我的Professional Java for Web Applications相关文章