Apache开源项目Log4J解析

–>

1.Log4J

Log4j是Apache的一个开源项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件,甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等;我们也可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。官网:http://jakarta.apache.org/log4j

log4j:最强大的记录日志的方式。可以通过配置 .properties 或是 .xml 的文件, 配置日志的目的地,格式等等。log4j启动时,默认会寻找source folder下的log4j.xml配置文件,若没有,会寻找log4j.properties文件。

2.Log4J的概念

Log4j由三个重要的组成构成:日志记录器(Loggers),输出端(Appenders)和日志格式化器(Layout)。
1.Logger:控制要启用或禁用哪些日志记录语句,并对日志信息进行级别限制。
2.Appenders : 指定了日志将打印到控制台还是文件中
3.Layout : 控制日志信息的显示格式

Log4j中将要输出的Log信息定义了5种级别,依次为DEBUGINFOWARNERRORFATAL,当输出时,只有级别高过配置中规定的 级别的信息才能真正的输出,这样就很方便的来配置不同情况下要输出的内容,而不需要更改代码,这点实在是方便啊。

3.Logger对象

两种方式获取Logger对象:

  1. Logger getRootLogger();
  2. Logger getLogger(Class clazz);

其中调用Logger.getLogger(Class clazz)是目前Logger对象最理想的方法

4.日志级别

每个Logger都有一个日志级别(log level),用来控制日志信息的输出。日志级别从高到低分为:

  1. OFF 最高等级,用于关闭所有日志记录。
  2. FATAL 指出每个严重的错误事件将会导致应用程序的退出。
  3. ERROR 指出虽然发生错误事件,但仍然不影响系统的继续运行。
  4. WARM 表明会出现潜在的错误情形。
  5. INFO 一般和在粗粒度级别上,强调应用程序的运行全程。
  6. DEBUG 一般用于细粒度级别上,对调试应用程序非常有帮助。
  7. ALL 最低等级,用于打开所有日志记录。

上面这些级别是定义在org.apache.log4j.Level类中,Log4j只建议使用4个级别,优先级从高到低分别是:

  1. ERROR
  2. WARM
  3. INFO
  4. DEBUG

通过使用日志级别,可以控制应用程序中相应级别日志信息的输出。例如,如果使用了INFO级别,则应用程序中所有低于INFO级别的日志信息(如DEBUG)将不会被打印出来。

import org.apache.log4j.BasicConfigurator;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
 
public class Log4jTest {
    public static void main(String[] args) {
        
        Logger logger = Logger.getLogger(Log4jTest.class);
        
        //使用默认的配置信息,不需要写log4j.properties
        BasicConfigurator.configure();
        //设置日志输出级别为info,这将覆盖配置文件中设置的级别
        logger.setLevel(Level.INFO);
        //下面的消息将被输出
        logger.info("this is an info");
        logger.warn("this is a warn");
        logger.error("this is an error");
        logger.fatal("this is a fatal");
    }
}

5.输出端Appender

Appender用来指定日志信息输出到哪个地方,可以同时指定多个输出目的地。Log4j允许将信息输出到许多不同的输出设备中,一个log信息输出目的地就叫做一个Appender。

每个Logger都可以拥有一个或多个Appender,每个Appender表示一个日志的输出目的地。可以使用Logger.addAppender(Appender app)为Logger增加一个Appender,也可以使用Logger.removeAppender(Appender app)为Logger删除一个Appender。

以下为Log4j几种常用的输出目的地。

  1. org.apache.log4j.ConsoleAppender:将日志信息输出到控制台。
  2. org.apache.log4j.FileAppender:将日志信息输出到一个文件。
  3. org.apache.log4j.DailyRollingFileAppender:将日志信息输出到一个日志文件,并且每天输出到一个新的日志文件。
  4. org.apache.log4j.RollingFileAppender:将日志信息输出到一个日志文件,并且指定文件的尺寸,当文件大小达到指定尺寸时,会自动把文件改名,同时产生一个新的文件。
  5. org.apache.log4j.WriteAppender:将日志信息以流格式发送到任意指定地方。
  6. org.apache.log4j.jdbc.JDBCAppender:通过JDBC把日志信息输出到数据库中。

6.日志格式化器Layout

6.1 HTMLLayout

格式化日志输出为HTML表格形式。

6.2 SimpleLayout

以一种非常简单的方式格式化日志输出,它打印三项内容:级别-信息。
例如:INFO – info

6.3 PatternLayout

根据指定的转换模式格式化日志输出,或者如果没有指定任何转换模式,就使用默认的转化模式格式。

6.4 TTCCLayout

包含日志产生的时间、线程、类别等等信息。

7.Log4j的log4j.properties配置详解

7.1 配置根Logger,其语法为:

	log4j.rootLogger = [level],appenderName,appenderName2,... 
	level是日志记录的优先级,分为OFF,TRACE,DEBUG,INFO,WARN,ERROR,FATAL,ALL
	Log4j建议只使用四个级别,优先级从低到高分别是DEBUG,INFO,WARN,ERROR 
	通过在这里定义的级别,可以控制到应用程序中相应级别的日志信息的开关
	比如在这里定义了INFO级别,则应用程序中所有DEBUG级别的日志信息将不被打印出来 
	appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的 

7.2 配置日志信息输出目的地Appender,其语法为:

	log4j.appender.appenderName = fully.qualified.name.of.appender.class 
	log4j.appender.appenderName.optionN = valueN 
	Log4j提供的appender属性值有以下几种: 
		1.org.apache.log4j.ConsoleAppender(输出到控制台) 
		2.org.apache.log4j.FileAppender(输出到文件) 
		3.org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件) 
		4.org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件) 
		5.org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方) 

		1.1 ConsoleAppender选项属性 
			-Threshold = DEBUG:指定日志消息的输出最低层次 
			-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
			-Target = System.err:默认值System.out,输出到控制台(err为红色,out为黑色)
	
	    1.2 FileAppender选项属性 
			-Threshold = INFO:指定日志消息的输出最低层次 
			-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
			-File = C:\log4j.log:指定消息输出到C:\log4j.log文件 
			-Append = FALSE:默认值true,将消息追加到指定文件中,false指将消息覆盖指定的文件内容 
			-Encoding = UTF-8:可以指定文件编码格式 
		1.3 DailyRollingFileAppender选项属性 
			-Threshold = WARN:指定日志消息的输出最低层次 
			-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
			-File = C:\log4j.log:指定消息输出到C:\log4j.log文件 
			-Append = FALSE:默认值true,将消息追加到指定文件中,false指将消息覆盖指定的文件内容 
			-DatePattern='.'yyyy-ww:每周滚动一次文件,即每周产生一个新的文件。还可以按用以下参数: 
	             '.'yyyy-MM:每月 
	             '.'yyyy-ww:每周 
	             '.'yyyy-MM-dd:每天 
	             '.'yyyy-MM-dd-a:每天两次 
	             '.'yyyy-MM-dd-HH:每小时 
	            '.'yyyy-MM-dd-HH-mm:每分钟 
			-Encoding = UTF-8:可以指定文件编码格式 
		1.4 RollingFileAppender选项属性 
			-Threshold = ERROR:指定日志消息的输出最低层次 
			-ImmediateFlush = TRUE:默认值是true,所有的消息都会被立即输出 
			-File = C:/log4j.log:指定消息输出到C:/log4j.log文件 
			-Append = FALSE:默认值true,将消息追加到指定文件中,false指将消息覆盖指定的文件内容 
			-MaxFileSize = 100KB:后缀可以是KB,MB,GB.在日志文件到达该大小时,将会自动滚动.如:log4j.log.1 
			-MaxBackupIndex = 2:指定可以产生的滚动文件的最大数 
			-Encoding = UTF-8:可以指定文件编码格式

7.3 配置日志信息的格式(布局),其语法为:

	log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class 
	log4j.appender.appenderName.layout.optionN = valueN 
	Log4j提供的layout有以下几种: 
		1.org.apache.log4j.HTMLLayout(以HTML表格形式布局) 
		2.org.apache.log4j.PatternLayout(可以灵活地指定布局模式) 
		3.org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串) 
		4.org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息) 
		5.org.apache.log4j.xml.XMLLayout(以XML形式布局) 
		
		1.1 HTMLLayout选项属性 
			-LocationInfo = TRUE:默认值false,输出java文件名称和行号 
			-Title=Struts Log Message:默认值 Log4J Log Messages 
	    1.2 PatternLayout选项属性 
			-ConversionPattern = %m%n:格式化指定的消息(参数意思下面有) 
		1.5 XMLLayout选项属性 
			-LocationInfo = TRUE:默认值false,输出java文件名称和行号 
		
		Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下: 
			%m 输出代码中指定的消息 
			%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL 
			%r 输出自应用启动到输出该log信息耗费的毫秒数 
			%c 输出所属的类目,通常就是所在类的全名 
			%t 输出产生该日志事件的线程名 
			%n 输出一个回车换行符,Windows平台为“\r\n”,Unix平台为“\n” 
			%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式 
				如:%d{yyyy年MM月dd日 HH:mm:ss,SSS},输出类似:2012年01月05日 22:10:28,921 
			%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数 
				如:Testlog.main(TestLog.java:10) 
			%F 输出日志消息产生时所在的文件名称 
			%L 输出代码中的行号 
			%x 输出和当前线程相关联的NDC(嵌套诊断环境),像java servlets多客户多线程的应用中 
			%% 输出一个"%"字符 

			可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如: 
				%5c: 输出category名称,最小宽度是5,category<5,默认的情况下右对齐 
				%-5c:输出category名称,最小宽度是5,category<5,"-"号指定左对齐,会有空格 
				%.5c:输出category名称,最大宽度是5,category>5,就会将左边多出的字符截掉,<5不会有空格 
				%20.30c:category名称<20补空格,并且右对齐,>30字符,就从左边交远销出的字符截掉 

7.4 指定特定包的输出特定的级别

	log4j.logger.org.springframework=DEBUG 
	1.输出到控制台 
	log4j.appender.systemOut = org.apache.log4j.ConsoleAppender 
	log4j.appender.systemOut.layout = org.apache.log4j.PatternLayout 
	log4j.appender.systemOut.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
	log4j.appender.systemOut.Threshold = DEBUG 
	log4j.appender.systemOut.ImmediateFlush = TRUE 
	log4j.appender.systemOut.Target = System.out 
	 
	2.输出到文件 
	log4j.appender.logFile = org.apache.log4j.FileAppender 
	log4j.appender.logFile.layout = org.apache.log4j.PatternLayout 
	log4j.appender.logFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
	log4j.appender.logFile.Threshold = DEBUG 
	log4j.appender.logFile.ImmediateFlush = TRUE 
	log4j.appender.logFile.Append = TRUE 
	log4j.appender.logFile.File = ../Struts2/WebRoot/log/File/log4j_Struts.log 
	log4j.appender.logFile.Encoding = UTF-8 
	 
	3.按DatePattern输出到文件 
	log4j.appender.logDailyFile = org.apache.log4j.DailyRollingFileAppender 
	log4j.appender.logDailyFile.layout = org.apache.log4j.PatternLayout 
	log4j.appender.logDailyFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
	log4j.appender.logDailyFile.Threshold = DEBUG 
	log4j.appender.logDailyFile.ImmediateFlush = TRUE 
	log4j.appender.logDailyFile.Append = TRUE 
	log4j.appender.logDailyFile.File = ../Struts2/WebRoot/log/DailyFile/log4j_Struts 
	log4j.appender.logDailyFile.DatePattern = '.'yyyy-MM-dd-HH-mm'.log' 
	log4j.appender.logDailyFile.Encoding = UTF-8 
	 
	4.设定文件大小输出到文件 
	log4j.appender.logRollingFile = org.apache.log4j.RollingFileAppender 
	log4j.appender.logRollingFile.layout = org.apache.log4j.PatternLayout 
	log4j.appender.logRollingFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
	log4j.appender.logRollingFile.Threshold = DEBUG 
	log4j.appender.logRollingFile.ImmediateFlush = TRUE 
	log4j.appender.logRollingFile.Append = TRUE 
	log4j.appender.logRollingFile.File = ../Struts2/WebRoot/log/RollingFile/log4j_Struts.log 
	log4j.appender.logRollingFile.MaxFileSize = 1MB 
	log4j.appender.logRollingFile.MaxBackupIndex = 10 
	log4j.appender.logRollingFile.Encoding = UTF-8 
	 
	5.用Email发送日志 
	log4j.appender.logMail = org.apache.log4j.net.SMTPAppender 
	log4j.appender.logMail.layout = org.apache.log4j.HTMLLayout 
	log4j.appender.logMail.layout.LocationInfo = TRUE 
	log4j.appender.logMail.layout.Title = Struts2 Mail LogFile 
	log4j.appender.logMail.Threshold = DEBUG 
	log4j.appender.logMail.SMTPDebug = FALSE 
	log4j.appender.logMail.SMTPHost = SMTP.163.com 
	log4j.appender.logMail.From = [email protected] 
	log4j.appender.logMail.To = [email protected] 
	#log4j.appender.logMail.Cc = [email protected] 
	#log4j.appender.logMail.Bcc = [email protected] 
	log4j.appender.logMail.SMTPUsername = xly3000 
	log4j.appender.logMail.SMTPPassword = 1234567 
	log4j.appender.logMail.Subject = Log4j Log Messages 
	#log4j.appender.logMail.BufferSize = 1024 
	#log4j.appender.logMail.SMTPAuth = TRUE 
	
	6.将日志登录到MySQL数据库 
	log4j.appender.logDB = org.apache.log4j.jdbc.JDBCAppender 
	log4j.appender.logDB.layout = org.apache.log4j.PatternLayout 
	log4j.appender.logDB.Driver = com.mysql.jdbc.Driver 
	log4j.appender.logDB.URL = jdbc:mysql://127.0.0.1:3306/xly 
	log4j.appender.logDB.User = root 
	log4j.appender.logDB.Password = 123456 
	log4j.appender.logDB.Sql = INSERT INTOT_log4j(project_name,create_date,level,category,file_name,thread_name,line,all_category,message)values('Struts2','%d{yyyy-MM-ddHH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')

本文来源 互联网收集,文章内容系作者个人观点,不代表 本站 对观点赞同或支持。如需转载,请注明文章来源,如您发现有涉嫌抄袭侵权的内容,请联系本站核实处理。

© 版权声明

相关文章