java日志组件学习3：log4j2配置使用

1、快速开始

maven配置：log4j-core、log4j-api

新建log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN"> 
	<properties>
		<property name="LOG_HOME">D:/logs</property>
		<property name="FILE_NAME">mylog</property>
		<property name="log.sql.level">info</property>
	</properties>
	
	 
    <Appenders>  
        <Console name="Console" target="SYSTEM_OUT">  
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %l - %msg%n" />  
        </Console>
        
        <RollingRandomAccessFile name="RollingRandomAccessFile" fileName="${LOG_HOME}/${FILE_NAME}.log" filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i.log">
        	<PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %l - %msg%n"/>
        	<Policies>
        		<TimeBasedTriggeringPolicy interval="1"/>
        		<SizeBasedTriggeringPolicy size="10 MB"/>
        	</Policies>
        	<DefaultRolloverStrategy max="20"/>
        </RollingRandomAccessFile>
    </Appenders>  
    
    <Loggers>  
    	<Root level="info">  
    		<AppenderRef ref="Console" />  
	        <AppenderRef ref="RollingRandomAccessFile" />  
	    </Root>
	    
	    <Logger name="com.mengdee.dao" level="${log.sql.level}" additivity="false">
             <AppenderRef ref="Console" />
        </Logger>
    </Loggers>  
</Configuration>

2、log4j2配置文件详解

log4j2.xml文件的配置大致如下：

<Configuration>
    <properties></properties>
    <Appenders>
    	<Console>
        	<PatternLayout></PatternLayout>
        </Console>
        <File></File>
    	<RollingRandomAccessFile></RollingRandomAccessFile>
        <Async></Async>
    </Appenders>
    <Loggers>
    	<Logger></Logger>
        <Root>
        	<AppenderRef></AppenderRef>
        </Root>
    </Loggers>
</Configuration>

---

1）Configuration：为根节点，有status和monitorInterval等多个属性（可以定义多个Appender和Logger）

• status：值有 “trace”, “debug”, “info”, “warn”, “error” and “fatal”。用于控制log4j2日志框架本身的日志级别，如果将stratus设置为较低的级别就会看到很多关于log4j2本身的日志，如加载log4j2配置文件的路径等信息
• monitorInterval：含义是每隔多少秒重新读取配置文件，可以不重启应用的情况下修改配置。单位是s,最小是5s。

2）Appenders：输出源，用于定义日志输出的地方

• log4j2支持的输出源有很多，有控制台Console、文件File、RollingRandomAccessFile、MongoDB、Flume 等

3）Console：控制台输出源是将日志打印到控制台上，开发的时候一般都会配置，以便调试。属性有：name，target，PatternLayout。

• name：指定Appender的名字.

• target：SYSTEM_OUT 或 SYSTEM_ERR,一般只设置默认:SYSTEM_OUT.

• PatternLayout：输出格式，不设置默认为:%m%n.

4）File：文件输出源，用于将日志写入到指定的文件，需要配置输入到哪个位置（例如：D:/logs/mylog.log）

• name：指定Appender的名字.

• fileName：指定输出日志的目的文件带全路径的文件名.

• PatternLayout：输出格式，不设置默认为:%m%n.

5）RollingRandomAccessFile: 该输出源也是写入到文件，不同的是比File更加强大，可以指定当文件达到一定大小（如20MB）时，另起一个文件继续写入日志，另起一个文件就涉及到新文件的名字命名规则，因此需要配置文件命名规则
这种方式更加实用，因为你不可能一直往一个文件中写，如果一直写，文件过大，打开就会卡死，也不便于查找日志。

• name：指定Appender的名字.
• fileName：指定当前日志文件的位置和文件名称
• filePattern：指定当发生Rolling时，文件的转移和重命名规则
• SizeBasedTriggeringPolicy：指定当文件体积大于size指定的值时，触发Rolling
• DefaultRolloverStrategy：指定最多保存的文件个数
• Policies：指定滚动日志的策略，就是什么时候进行新建日志文件输出日志.
• TimeBasedTriggeringPolicy：Policies子节点，这个配置需要和filePattern结合使用，注意filePattern中配置的文件重命名规则是${FILE_NAME}-%d{yyyy-MM-dd HH-mm}-%i，最小的时间粒度是mm，即分钟。指定的interval是1，结合起来就是每1分钟生成一个新文件。如果改成%d{yyyy-MM-dd HH}，最小粒度为小时，则每一个小时生成一个文件
• SizeBasedTriggeringPolicy：Policies子节点，基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小.

6）NoSql：MongoDb, 输出到MongDb数据库中

7）Flume：输出到Apache Flume（Flume是Cloudera提供的一个高可用的，高可靠的，分布式的海量日志采集、聚合和传输的系统，Flume支持在日志系统中定制各类数据发送方，用于收集数据；同时，Flume提供对数据进行简单处理，并写到各种数据接受方（可定制）的能力。）

• Async：异步，需要通过AppenderRef来指定要对哪种输出源进行异步（一般用于配置RollingRandomAccessFile）

8）PatternLayout：控制台或文件输出源（Console、File、RollingRandomAccessFile）都必须包含一个PatternLayout节点，用于指定输出文件的格式（如 日志输出的时间 文件 方法 行数 等格式），例如 pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"

  %d{HH:mm:ss.SSS} 表示输出到毫秒的时间
  %t 输出当前线程名称
  %-5level 输出日志级别，-5表示左对齐并且固定输出5个字符，如果不足在右边补0
  %logger 输出logger名称，因为Root Logger没有名称，所以没有输出
  %msg 日志文本
  %n 换行
  其他常用的占位符有：
  %F 输出所在的类文件名，如Log4j2Test.java
  %L 输出行号
  %M 输出所在方法名
  %l 输出语句所在的行数, 包括类名、方法名、文件名、行数

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

10）Root节点用来指定项目的根日志，如果没有单独指定Logger，那么就会默认使用该Root日志输出

• level：日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF，不指定时level默认为ERROR。
• AppenderRef：Root的子节点，用来指定该日志输出到哪个Appender.

11）Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。

• level：日志输出级别，共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF，不指定时level默认为ERROR。
• name：用来指定该Logger所适用的类或者类所在的包全路径,继承自Root节点.
• additivity：指定是否同时输出log到父类的appender，缺省为true。
• AppenderRef：Logger的子节点，用来指定该日志输出到哪个Appender,如果没有指定，就会默认继承自Root.如果指定了，那么会在指定的这个Appender和Root的Appender中都会输出，此时我们可以设置Logger的additivity="false"只在自定义的Appender中进行输出。

12）properties: 属性，使用来定义常量，以便在其他配置的时候引用，该配置是可选的，例如定义日志的存放位置：D:/logs。

13）关于日志level

​ 共有8个级别，按照从低到高为：All < Trace < Debug < Info < Warn < Error < Fatal < OFF.

• All:最低等级的，用于打开所有日志记录.
• Trace:是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出.
• Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.
• Info:消息在粗粒度级别上突出强调应用程序的运行过程.
• Warn:输出警告及warn以下级别的日志.
• Error:输出错误信息日志.
• Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.
• OFF:最高等级的，用于关闭所有日志记录.

​ 程序会打印高于或等于所设置级别的日志，设置的日志等级越高，打印出来的日志就越少。

3、加载配置文件

得到记录器：

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
Logger logger = LogManager.getLogger(ConfigTest.class.getName())

3.1 src下的配置文件会默认的被log4j的框架加载

3.2 绝对路径的配置文件

ConfigurationSource source;
//方法1  使用  public ConfigurationSource(InputStream stream) throws IOException 构造函数
source = new ConfigurationSource(new FileInputStream("D:\\log4j2.xml"));
//方法2 使用 public ConfigurationSource(InputStream stream, File file)构造函数
File config=new File("D:\\log4j2.xml");
source = new ConfigurationSource(new FileInputStream(config),config);
//方法3 使用 public ConfigurationSource(InputStream stream, URL url) 构造函数
String path="D:\\log4j2.xml";
source = new ConfigurationSource(new FileInputStream(path),new File(path).toURL());
//source.setFile(new File("D:\log4j2.xml"));        
//source.setInputStream(new FileInputStream("D:\log4j2.xml"));        
Configurator.initialize(null, source);      

3.3 相对路径的配置文件加载

//这里需要注意路径中不要出现中文和空格，如果存在中文，请使用url转码
ConfigurationSource source;
//方法1  使用getResource()
String path="/com/herman/config/log4j2.xml";
URL url=ConfigTest.class.getResource(path);
source = new ConfigurationSource(new FileInputStream(new File(url.getPath())),url);
Configurator.initialize(null, source);    
//方法2 使用System.getProperty
String config=System.getProperty("user.dir");
source = new ConfigurationSource(new FileInputStream(config+"\\src\\com\\herman\\config\\log4j2.xml"));
Configurator.initialize(null, source);