log4j日志集成

一、介绍 

Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务 器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。

Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显示内容。

二、配置文件

其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是properties格式的文件。下面我们介绍使用properties格式做为配置文件的方法：

示例：

log4j.rootLogger=INFO, A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n

1. 配置根Logger，其语法为：

log4j.rootLogger = [ level ] , appenderName, appenderName, …

其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。

appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。

2. 配置日志信息输出目的地Appender，其语法为：

log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
log4j.appender.appenderName.option = valueN

其中，Log4j提供的appender有以下几种：

org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

(1).ConsoleAppender选项

Threshold=WARN:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err：默认情况下是：System.out,指定输出控制台

(2).FileAppender 选项

Threshold=WARN:指定日志消息的输出最低层次。

ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

File=mylog.txt:指定消息输出到mylog.txt文件。

Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

(3).DailyRollingFileAppender 选项

Threshold=WARN:指定日志消息的输出最低层次。

ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

File=mylog.txt:指定消息输出到mylog.txt文件。

Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

DatePattern='.'yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下：

1)'.'yyyy-MM: 每月

2)'.'yyyy-ww: 每周

3)'.'yyyy-MM-dd: 每天

4)'.'yyyy-MM-dd-a: 每天两次

5)'.'yyyy-MM-dd-HH: 每小时

6)'.'yyyy-MM-dd-HH-mm: 每分钟

(4).RollingFileAppender 选项

Threshold=WARN:指定日志消息的输出最低层次。

ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。

File=mylog.txt:指定消息输出到mylog.txt文件。

Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到

mylog.log.1文件。

MaxBackupIndex=2:指定可以产生的滚动文件的最大数。

3. 配置日志信息的布局，其语法为：

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
其中，Log4j提供的layout有以下几种：
org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

4、输出格式设置

在配置文件中可以通过log4j.appender.A1.layout.ConversionPattern设置日志输出格式。

参数：

%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%r: 输出自应用启动到输出该log信息耗费的毫秒数
%c: 输出日志信息所属的类目，通常就是所在类的全名
%t: 输出产生该日志事件的线程名
%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.Java:10)
%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像Java servlets这样的多客户多线程的应用中。
%%: 输出一个”%”字符
%F: 输出日志消息产生时所在的文件名称
%L: 输出代码中的行号
%m: 输出代码中指定的消息,产生的日志具体信息
%n: 输出一个回车换行符，Windows平台为”\r\n”，Unix平台为”\n”输出日志信息换行 

可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：

1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。

2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，”-”号指定左对齐。

3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。

4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边交远销出的字符截掉。

5.简单配置log4j.properties文件如下：

###根logger设置###
log4j.rootLogger = INFO,console,file

### 输出信息到控制台###
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern = [%p] %d{yyyy-MM-dd HH:mm:ss} method: %l----%m%n

###输出INFO 级别以上的日志文件设置###
log4j.appender.file = org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.File = target/log4j_demo.log
log4j.appender.file.Append = true
log4j.appender.file.layout = org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} method: %l - [ %p ]----%m%n

三、加载log4j.properties文件

1.maven项目导入log4j的依赖

<dependency>
       <groupId>log4j</groupId>
       <artifactId>log4j</artifactId>
       <version>1.2.17</version>
</dependency>

2.例如Log4jDemo类：

package cn.xiaobing.web.auto.test;

import org.apache.log4j.Logger;
import org.testng.annotations.AfterSuite;
import org.testng.annotations.BeforeSuite;
import org.testng.annotations.Test;

public class Log4jDemo {
    //1.创建一个Logger
    Logger logger = Logger.getLogger(Log4jDemo.class);
    //2.开始记录日志
    @BeforeSuite
    public void test0() {
        logger.info(" *** 开始执行Suite *** ");
    }
    @Test
    public void test1() {
        logger.info(" --- 正在执行方法1 --- ");

    }
    @Test
    public void test2() {
        logger.info(" --- 正在执行方法2 --- ");
    }
    @Test
    public void test3() {
        logger.info(" --- 正在执行方法3 --- ");
    }
    @Test
    public void test4() {
        logger.info(" --- 正在执行方法4 --- ");
    }
    @Test
    public void test5() {
        logger.info(" --- 正在执行方法5 --- ");
    }
    @AfterSuite
    public void test_over() {
        logger.info(" *** 执行Suite结束 *** ");
    }
}

3.控制台输出如下：

[TestNG] Running:
  C:\Users\Administrator\AppData\Local\Temp\testng-eclipse--113290236\testng-customsuite.xml

[INFO] 2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test0(Log4jDemo.java:14)---- *** 开始执行Suite ***
[INFO] 2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test1(Log4jDemo.java:18)---- --- 正在执行方法1 ---
[INFO] 2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test2(Log4jDemo.java:23)---- --- 正在执行方法2 ---
[INFO] 2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test3(Log4jDemo.java:27)---- --- 正在执行方法3 ---
[INFO] 2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test4(Log4jDemo.java:31)---- --- 正在执行方法4 ---
[INFO] 2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test5(Log4jDemo.java:35)---- --- 正在执行方法5 ---
PASSED: test1
PASSED: test2
PASSED: test3
PASSED: test4
PASSED: test5

===============================================
    Default test
    Tests run: 5, Failures: 0, Skips: 0
===============================================

[INFO] 2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test_over(Log4jDemo.java:39)---- *** 执行Suite结束 *** 

===============================================
Default suite
Total tests run: 5, Failures: 0, Skips: 0
===============================================

4.记录日志到文件如下log4j_demo.log：

2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test0(Log4jDemo.java:14) - [ INFO ]---- *** 开始执行Suite ***
2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test1(Log4jDemo.java:18) - [ INFO ]---- --- 正在执行方法1 ---
2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test2(Log4jDemo.java:23) - [ INFO ]---- --- 正在执行方法2 ---
2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test3(Log4jDemo.java:27) - [ INFO ]---- --- 正在执行方法3 ---
2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test4(Log4jDemo.java:31) - [ INFO ]---- --- 正在执行方法4 ---
2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test5(Log4jDemo.java:35) - [ INFO ]---- --- 正在执行方法5 ---
2019-07-16 23:03:32 method: cn.xiaobing.web.auto.test.Log4jDemo.test_over(Log4jDemo.java:39) - [ INFO ]---- *** 执行Suite结束 *** 

小结:学习后总结分享,不足之处后续修正;

参考原文地址:https://www.jb51.net/article/134950.htm