log4j2的配置和使用中遇到的问题

log4j2 环境的配置

首先从官网 https://logging.apache.org/log4j/2.x/download.html 中下载最新版本的log4j2的jar包。

下载到本地之后，我们在eclipse中在项目名称上右击选择Build Path，选择其中的Configure Build Path。在打开的弹窗中选择Add External Jars。然后文件选择已经解压完的所有jar文件添加到build path中。

配置成功后，在Referenced Libraries中出现我们加入的jar。

log4j2 配置文件的编写

我们接下来需要写log4j2.xml作为配置文件。

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即可。

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.
   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.
   　　　　　　SizeBasedTriggeringPolicy:Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.
   　　　　　　DefaultRolloverStrategy:用来指定同一个文件夹下最多有几个日志文件时开始删除最旧的，创建新的(通过max属性)。
   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中进行输出。 　　　　　　
3. 关于日志level.
   共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
   All:最低等级的，用于打开所有日志记录.
   Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.
   Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
   Info:消息在粗粒度级别上突出强调应用程序的运行过程.
   Warn:输出警告及warn以下级别的日志.
   Error:输出错误信息日志.
   Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
   OFF:最高等级的，用于关闭所有日志记录.

3.配置文件的编写结果

<Configuration status="WARN">  
    <Appenders>
        <Console name="STDOUT" target="SYSTEM_OUT">
            <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/>
        Console>
        <File name="File1" fileName="logs/GraphPoetApp_logs.log">
            <PatternLayout>
                <Pattern>[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%nPattern>
            PatternLayout>            
        File>
        <File name="File2" fileName="logs/MovieGraphApp_logs.log">
            <PatternLayout>
                <Pattern>[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%nPattern>
            PatternLayout>            
        File>
        <File name="File3" fileName="logs/NetworkTopologyApp_logs.log">
            <PatternLayout>
                <Pattern>[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%nPattern>
            PatternLayout>            
        File>
        <File name="File4" fileName="logs/SocialNetworkApp_logs.log">
            <PatternLayout>
                <Pattern>[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%nPattern>
            PatternLayout>            
        File>
    Appenders>
    <Loggers>
        <Logger name="GraphPoetApp" level="INFO" additivity="true">
            <AppenderRef ref="File1"/>
        Logger>
        <Logger name="MovieGraphApp" level="INFO" additivity="true">
            <AppenderRef ref="File2"/>
        Logger>
        <Logger name="NetworkTopologyApp" level="INFO" additivity="true">
            <AppenderRef ref="File3"/>
        Logger>
        <Logger name="SocialNetworkApp" level="INFO" additivity="true">
            <AppenderRef ref="File4"/>
        Logger>
        <Root level="INFO">
            <AppenderRef ref="STDOUT"/>
        Root>
    Loggers>
Configuration>

配置文件设置的解释：
设置的控制台输出格式为：
%d %-5p [%t] %C{2} (%F:%L) - %m%n
设置的文件中的输出格式为：
[%-d{yyyy-MM-dd HH:mm:ss}] [%p] [%l] [%m]%n
文件的输出路径：
logs/GraphPoetApp_logs.log
logs/MovieGraphApp_logs.log
logs/NetworkTopologyApp_logs.log
logs/SocialNetworkApp_logs.log
文件输出等级：
INFO
文件输出形式：
File，Pattern Layout。

4.最后的工作

将写好的文件放在src的文件夹下即可。

如何使用log4j2进行日志记录

首先在开始的时候导入包

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

然后使用如下代码获得一个Logger的对象。

Logger logger = LogManager.getLogger("GraphPoetApp");

最后我们可以调用这个logger对象使用其info，debug，warn等方法进行文件的写入record。

logger.debug("test");

使用中遇到的问题

1.

测试log是否能正常运行的test文件

public class test{
static Logger log =Logger.getLogger(Log4jtest.class);
  public static void main(String[] args) {
     BasicConfigurator.configure();
     log.debug("This is debug message");
  }
}

但是报错：

Exception in thread "main" java.lang.ExceptionInInitializerError
Caused by: java.lang.ClassCastException: org.apache.logging.slf4j.SLF4JLoggerContext cannot be cast to org.apache.logging.log4j.core.LoggerContext

根据Stack Overflow的查询：
从build path的jars中去掉以下的包，问题解决。
log4j-to-slf4j-2.0.2.jar
log4j-to-slf4j-2.0.2-sources.jar
log4j-slf4j-impl-2.0.2.jar
log4j-slf4j-impl-2.0.2-sources.jar

2.

一开始将文件放在工程目录下，（即和src同级的文件夹中），运行测试报错找不到文件，使用默认配置：

经过查询：
查看配置文件的位置一项。
因此我们要将xml的文件放到src文件夹下。

3.

在使用log进行记录的时候，出现了log.1和log.2等文件。
根据百度的查询，知道了是因为在进行记录的时候没有将log进行关闭，会有文件的读写的保护

参考文献：

Log4J使用详解(整理)
https://blog.csdn.net/u011781521/article/details/55002553
聊一聊log4j2配置文件log4j2.xml
https://www.cnblogs.com/hafiz/p/6170702.html
log4j2 实际使用详解
https://blog.csdn.net/vbirdbest/article/details/71751835