简介

Log4j（log for java）是Apache的一个开放源代码项目，包名是org.apache.log4j.，它为Java开发的項目提供了一种细腻的、功能强大的、使用方便的日志管理方式。通过使用Log4j，我们可以控制日志信息输送的目的地（控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等）、日志的输出格式、日志的生成过程（通过定义每一条日志信息的级别）。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

通过一个配置文件，我们可以多选择的控制每条日志的输出格式和目的地；通过定义信息的级别，我们也可以灵活开关代码中的反馈信息。简单地说，log4j就是帮助开发人员进行日志输出管理的API类库。它最重要的特点就可以配置文件灵活的设置日志信息的优先级、日志信息的输出目的地以及日志信息的输出格式。也正是如此，给Log4j带来了一个缺点——需要通过java程序动态设置：如果需要修改日志输出级别等信息，则必须修改java文件，然后重新编译，很是麻烦。

组成

• Logger（记录器）：日志写出器，供程序员输出日志信息。

• Appender（输出源）：日志目的地，把格式化好的日志信息输出到指定的地方去。Log4j提供的appender有以下几种：

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

• Layout（布局）：日志格式化器，用来把程序员的logging request格式化成字符串。

  • org.apache.log4j.PatternLayout：用指定的pattern格式化logging request的Layout，可以灵活地指定布局模式。
  • org.apache.log4j.HTMLLayout：以HTML表格形式布局）
  • org.apache.log4j.SimpleLayout：包含日志信息的级别和信息字符串
  • org.apache.log4j.TTCCLayout：包含日志产生的时间、线程、类别等等信息

• Layout.ConversionPattern：指定输出日志信息的内容和格式：

  • %m 输出代码中指定的消息
  • %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
  • %r 输出自应用启动到输出该log信息耗费的毫秒数
  • %c 输出所属的类目，通常就是所在类的全名
  • %t 输出产生该日志事件的线程名
  • %n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”
  • %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
  • %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

   
  比如Layout.ConversionPattern定义为log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n，实际输出的信息是2023-04-15 16:10:17,859 method:com.bjsasc.JavaProject.Test.generateLogFileUsingLog4j(Test.java:21)

Logger 日志记录器

Logger对象是用来取代System.out或者System.err的日志写出器，用来供程序员输出日志信息。

Appender 日志目的地（Windows下的路径分隔符）※

当选用org.apache.log4j.FileAppender等将日志信息存入文件的Appender时，请注意，使用Log4j在Windows操作系统下、生成日志文件时，日志文件的路径依然使用Linux的分隔符/，比如C:/Users/lu/Desktop/ljh/logFileForLog4j/debug.log，而非Windows的\！！！

Layout 日志信息布局

layout 指定输出的样式模板？

layout = org.apache.log4j.PatternLayout

layout.ConversionPattern 指定输出的每项内容及其格式顺序

layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

日志信息等级/优先级

日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；
也有博客提到，日志信息的优先级从高到低应该是OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、ALL，待确认。

日志信息的输出目的地指定了日志将打印到控制台还是文件中；输出格式控制了日志信息的显 示内容。

使用的Log4j的jar包

此处先给出所用Log4j的jar包。

	<dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>1.2.14</version>
      <scope>provided</scope>
    </dependency>

代码示例

Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件log4j.properties（键=值）。

XML文件

待补

log4j.properties

log4j.properties文件创建的位置如下所示，在src/main/java下，与代码包package平级。

调用log4j的代码如下所示。

import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Logger;

public class Test {

	public static void main(String[] args) {
		// TODO Auto-generated method stub
		Test test = new Test();
		test.generateLogFileUsingLog4j();
	}
	
	public Test() {
		// TODO Auto-generated constructor stub
	}
	
	public void generateLogFileUsingLog4j() {
		Logger log = Logger.getLogger(Test.class);
		//Logger log = Logger.getLogger(Test.class.getName());//尚未发现二者的区别，待补
		
		BasicConfigurator.configure();// 自动快速地使用缺省Log4j环境，读取log4j.properties文件。
		log.error("Test Error");
		log.info("Test Info");
		log.debug("Test Debug");
	}

}

 
log4j的配置文件log4j.properties内容如下所示。

### 设置###  
log4j.rootLogger = debug,console,D,E  
  
### 输出INFO? 级别以上的信息到C:/Users/lu/Desktop/ljh/logFileForLog4j/info.log日志文件
log4j.appender.console = org.apache.log4j.FileAppender
log4j.appender.console.File = C:/Users/lu/Desktop/ljh/logFileForLog4j/info.log
log4j.appender.console.Append = true
log4j.appender.console.Threshold = INFO
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
  
### 输出DEBUG 级别以上的信息到C:/Users/lu/Desktop/ljh/logFileForLog4j/debug.log日志文件
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D = org.apache.log4j.FileAppender
log4j.appender.D.File = C:/Users/lu/Desktop/ljh/logFileForLog4j/debug.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
  
### 输出ERROR 级别以上的信息到C:/Users/lu/Desktop/ljh/logFileForLog4j/error.log日志文件
log4j.appender.E = org.apache.log4j.FileAppender
log4j.appender.E.File =C:/Users/lu/Desktop/ljh/logFileForLog4j/error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n