`

log4j

    博客分类:
  • java
 
阅读更多

http://www.iteye.com/topic/378077

 

log4j是一个非常强大的log记录软件,下面我们就来看看在项目中如何使log4j。

 

首先当然是得到log4j的jar档,推荐使用1.2.X版,下载地址:

http://logging.apache.org/log4j/1.2/download.html

 

我们先看一个最简单的示例:

【示例1】

项目结构:



【注:由于这里的多个项目公用一个jar档,我们可以创建一个专门放置jar档的Java工程,然后将jar档放到lib目录下。在要使用的工程中按图所示进行引用 】


Java代码:

Java代码  收藏代码
  1. package com.coderdream.log4j;  
  2.   
  3. import org.apache.log4j.Logger;  
  4.   
  5. public class HelloLog4j {  
  6.   
  7.     private static Logger logger = Logger.getLogger(HelloLog4j.class);  
  8.   
  9.     /** 
  10.      * @param args 
  11.      */  
  12.     public static void main(String[] args) {  
  13.         // System.out.println("This is println message.");  
  14.           
  15.         // 记录debug级别的信息  
  16.         logger.debug("This is debug message.");  
  17.         // 记录info级别的信息  
  18.         logger.info("This is info message.");  
  19.         // 记录error级别的信息  
  20.         logger.error("This is error message.");  
  21.     }  
  22. }  

  配置文件log4j.properties:

Properties代码  收藏代码
  1. #可以设置级别:debug>info>error  
  2. #debug:显示debug、info、error  
  3. #info:显示info、error  
  4. #error:只error  
  5. log4j.rootLogger=debug,appender1  
  6. #log4j.rootLogger=info,appender1  
  7. #log4j.rootLogger=error,appender1  
  8.   
  9. #输出到控制台  
  10. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  11. #样式为TTCCLayout  
  12. log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  

输出结果:

Console代码  收藏代码
  1. [main] DEBUG com.coderdream.log4j.HelloLog4j - This is debug message.  
  2. [main] INFO com.coderdream.log4j.HelloLog4j - This is info message.  
  3. [main] ERROR com.coderdream.log4j.HelloLog4j - This is error message.  

  通过配置文件可知,我们需要配置3个方面的内容:

1、根目录(级别和目的地);

2、目的地(控制台、文件等等);

3、输出样式。


下面我们来看看Log4J的类图:


 

Logger - 日志写出器,供程序员输出日志信息 
Appender - 日志目的地,把格式化好的日志信息输出到指定的地方去 
ConsoleAppender - 目的地为控制台的Appender 
FileAppender - 目的地为文件的Appender 
RollingFileAppender - 目的地为大小受限的文件的Appender 
Layout - 日志格式化器,用来把程序员的logging request格式化成字符串 
PatternLayout - 用指定的pattern格式化logging request的Layout


Log4j基本使用方法 


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

  一、定义配置文件 

  其实您也可以完全不使用配置文件,而是在代码中配置Log4j环境。但是,使用配置文件将使您的应用程序更加灵活。Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件(键=值)。下面我们介绍使用Java特性文件做为配置文件的方法:

  1.配置根Logger,其语法为: 

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

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

  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(将日志信息以流格式发送到任意指定的地方)

  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有以e几种:
  org.apache.log4j.HTMLLayout(以HTML表格形式布局),
  org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
  org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
  org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)

  Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下: %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)

  二、在代码中使用Log4j 

  1.得到记录器 

  使用Log4j,第一步就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:

  public static Logger getLogger( String name)

  通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。Name一般取本类的名字,比如:

  static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

  2.读取配置文件 

  当获得了日志记录器之后,第二步将配置Log4j环境,其语法为:

  BasicConfigurator.configure (): 自动快速地使用缺省Log4j环境。
  PropertyConfigurator.configure ( String configFilename) :读取使用Java的特性文件编写的配置文件。
  DOMConfigurator.configure ( String filename ) :读取XML形式的配置文件。

  3.插入记录信息(格式化日志信息) 

  当上两个必要步骤执行完毕,您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方,其语法如下:

  Logger.debug ( Object message ) ;
  Logger.info ( Object message ) ;
  Logger.warn ( Object message ) ;
  Logger.error ( Object message ) ;

 

示例2~示例8

 

【示例2】 输出为文本文件或HTML文件

Porperties代码  收藏代码
  1. #设置级别:  
  2. log4j.rootLogger=debug,appender1  
  3.   
  4. #输出到文件(这里默认为追加方式)  
  5. log4j.appender.appender1=org.apache.log4j.FileAppender  
  6. #设置文件输出路径  
  7. #【1】文本文件  
  8. #log4j.appender.appender1.File=c:/Log4JDemo02.log  
  9. #【2】HTML文件  
  10. log4j.appender.appender1.File=c:/Log4JDemo02.html  
  11. #设置文件输出样式  
  12. #log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  
  13. log4j.appender.appender1.layout=org.apache.log4j.HTMLLayout  

 

 示例3】 输出为文本文件或HTML文件

Properties代码  收藏代码
  1. #设置级别和多个目的地  
  2. log4j.rootLogger=debug,appender1,appender2  
  3.   
  4. #输出到控制台  
  5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  6. #设置输出样式  
  7. log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  
  8.   
  9. #输出到文件(这里默认为追加方式)  
  10. log4j.appender.appender2=org.apache.log4j.FileAppender  
  11. #设置文件输出路径  
  12. #【1】文本文件  
  13. #log4j.appender.appender2.File=c:/Log4JDemo02.log  
  14. #【2】HTML文件  
  15. log4j.appender.appender2.File=c:/Log4JDemo02.html  
  16. #设置文件输出样式  
  17. #log4j.appender.appender2.layout=org.apache.log4j.TTCCLayout  
  18. log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout  
 

【示例4】 SimpleLayout样式

Properties代码  收藏代码
  1. #设置级别和目的地  
  2. log4j.rootLogger=debug,appender1  
  3.   
  4. #输出到控制台  
  5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  6. #设置输出样式  
  7. log4j.appender.appender1.layout=org.apache.log4j.SimpleLayout  

  输出结果:

控制台代码  收藏代码
  1. DEBUG - This is debug message.  
  2. INFO - This is info message.  
  3. ERROR - This is error message.  
 

【示例5】 自定义样式

Java代码  收藏代码
  1. #设置级别和目的地  
  2. log4j.rootLogger=debug,appender1  
  3.   
  4. #输出到控制台  
  5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  6. #设置输出样式  
  7. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
  8. #自定义样式  
  9. # %r 时间 0  
  10. # %t 方法名 main  
  11. # %p 优先级 DEBUG/INFO/ERROR  
  12. # %c 所属类的全名(包括包名)  
  13. # %l 发生的位置,在某个类的某行  
  14. # %m 输出代码中指定的讯息,如log(message)中的message  
  15. # %n 输出一个换行  
  16.   
  17. log4j.appender.appender1.layout.ConversionPattern=%r [%t] [%p] - %c -%l -%m%n  

输出结果:

控制台代码  收藏代码
  1. 0 [main] [DEBUG] - com.coderdream.log4j.HelloLog4j   
  2. -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:16) -This is debug message.  
  3. 31 [main] [INFO] - com.coderdream.log4j.HelloLog4j   
  4. -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:18) -This is info message.  
  5. 31 [main] [ERROR] - com.coderdream.log4j.HelloLog4j   
  6. -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:20) -This is error message.  
 

【示例6】 多目的地、自定义样式

Properties代码  收藏代码
  1. #设置级别和目的地  
  2. log4j.rootLogger=debug,appender1,appender2  
  3.   
  4. #输出到控制台  
  5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  6. #设置输出样式  
  7. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
  8. #自定义样式  
  9. # %r 时间 0  
  10. # %t 方法名 main  
  11. # %p 优先级 DEBUG/INFO/ERROR  
  12. # %c 所属类的全名(包括包名)  
  13. # %l 发生的位置,在某个类的某行  
  14. # %m 输出代码中指定的讯息,如log(message)中的message  
  15. # %n 输出一个换行符号  
  16. log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
  17.   
  18. #输出到文件(这里默认为追加方式)  
  19. log4j.appender.appender2=org.apache.log4j.FileAppender  
  20. #设置文件输出路径  
  21. #【1】文本文件  
  22. log4j.appender.appender2.File=c:/Log4JDemo06.log  
  23. #设置文件输出样式  
  24. log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
  25. log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  
 

【示例7】 【企业应用】设置 特定包的级别和目的地

先增加一个包,新建一个类:

Java代码  收藏代码
  1. package com.coderdream.log4jDao;  
  2.   
  3. import org.apache.log4j.Logger;  
  4.   
  5. public class HelloDao {  
  6.     private static Logger logger = Logger.getLogger(HelloDao.class);  
  7.   
  8.     /** 
  9.      * @param args 
  10.      */  
  11.     public static void main(String[] args) {  
  12.         // 记录debug级别的信息  
  13.         logger.debug("This is debug message from Dao.");  
  14.         // 记录info级别的信息  
  15.         logger.info("This is info message from Dao.");  
  16.         // 记录error级别的信息  
  17.         logger.error("This is error message from Dao.");  
  18.     }  
  19. }  

      如果这个类作为基类,如J2EE中的BaseDao、BaseAction、BaseService等等,则我们可以将各层的日志信息分类输出到各个文件。

 

Properties代码  收藏代码
  1. #省略根,只设置特定包的级别和目的地  
  2. log4j.logger.com.coderdream.log4j=debug,appender1  
  3. log4j.logger.com.coderdream.log4jDao=info,appender1,appender2  
  4.   
  5. #输出到控制台  
  6. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  7. #设置输出样式  
  8. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
  9. #自定义样式  
  10. # %r 时间 0  
  11. # %t 方法名 main  
  12. # %p 优先级 DEBUG/INFO/ERROR  
  13. # %c 所属类的全名(包括包名)  
  14. # %l 发生的位置,在某个类的某行  
  15. # %m 输出代码中指定的讯息,如log(message)中的message  
  16. # %n 输出一个换行符号  
  17. log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
  18.   
  19. #输出到文件(这里默认为追加方式)  
  20. log4j.appender.appender2=org.apache.log4j.FileAppender  
  21. #设置文件输出路径  
  22. #【1】文本文件  
  23. log4j.appender.appender2.File=c:/Log4JDemo07_Dao.log  
  24. #设置文件输出样式  
  25. log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
  26. log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  
 

【示例8】 log4j.xml的配置方式

Xml代码  收藏代码
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">  
  3.   
  4. <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">  
  5.   
  6.     <appender name="appender1"  
  7.         class="org.apache.log4j.RollingFileAppender">  
  8.         <param name="File" value="logfile08.html" />  
  9.         <param name="MaxFileSize" value="1MB" />  
  10.         <param name="MaxBackupIndex" value="5" />  
  11.         <layout class="org.apache.log4j.HTMLLayout">  
  12.         </layout>  
  13.     </appender>  
  14.   
  15.     <root>  
  16.         <level value="debug" />  
  17.         <appender-ref ref="appender1" />  
  18.     </root>  
  19. </log4j:configuration>  

 

为了提高效率,我们可以在写日志前增加判断:

Java代码  收藏代码
  1. // 记录debug级别的信息  
  2. if (logger.isDebugEnabled()) {  
  3.     logger.debug("This is debug message from Dao.");  
  4. }  
  5.   
  6. // 记录info级别的信息  
  7. if (logger.isInfoEnabled()) {  
  8.     logger.info("This is info message from Dao.");  
  9. }  
  10.   
  11. // 记录error级别的信息  
  12. logger.error("This is error message from Dao.");  
分享到:
评论

相关推荐

    老生常谈Log4j和Log4j2的区别(推荐)

    Log4j只需要引入一个JAR包,即log4j.jar,而Log4j2则需要引入两个核心JAR包,即log4j-core.jar和log4j-api.jar。大家可以发现,Log4j和Log4j2的包路径是不同的,Apache为了区分,包路径都更新了。 文件渲染 Log4j...

    若依框架使用的log4j2.16.0,修复log4j漏洞log4j2下载最新log4j2.16.0下载

    Log4j是一个广泛使用的Java日志记录框架,它允许开发者在应用程序中轻松地记录各种级别的日志信息,如DEBUG、INFO、WARN、ERROR等。在2021年底,一个重大的安全漏洞(CVE-2021-44228)被发现在Log4j2的早期版本中,...

    logging-log4j2-log4j-2.15.0-rc2.zip maven 资源库

    针对Log4j 2 远程代码执行漏洞,需要用到的升级资源包,适用于maven资源库,包括log4j,log4j-core,log4j-api,log4j-1.2-api,log4j-jpa等全套2.15.0 maven资源库jar包。如果是maven本地仓库使用,需要将zip包解压...

    Log4j2学习用到的jar包及apache-log4j-2.19.0-bin.zip

    分别有disruptor-3.3.4.jar(Log4j2异步日志的底层实现)、log4j-api-2.19.0.jar(log4j门面)、log4j-core-2.19.0.jar(log4j实现)、log4j-slf4j-impl-2.19.0.jar(SLF4J与Log4j绑定)、slf4j-api-1.7.30.jar(SLF...

    Log4j2简介及与Log4j效率对比

    ### Log4j2简介 Log4j2是Apache软件基金会推出的日志框架,它是Log4j 1.x的重构版本,旨在提供更为高效且灵活的日志解决方案。与Log4j 1.x相比,Log4j2在设计上进行了重大改进,并解决了Logback等其他日志框架中...

    log4j.jar各个版本

    apache-log4j-1.2.15.jar, apache-log4j-extras-1.0.jar, apache-log4j-extras-1.1.jar, apache-log4j.jar, log4j-1.2-api-2.0.2-javadoc.jar, log4j-1.2-api-2.0.2-sources.jar, log4j-1.2-api-2.0.2.jar, log4j-...

    log4j+slf4j实现 log4j测试代码,log4j+slf4j实现 log4j测试代码

    总结,SLF4J和Log4j的组合使用让日志管理更加灵活,开发者可以通过SLF4J的简洁API进行日志记录,同时利用Log4j的强大功能,如自定义输出格式和多种输出目的地。通过适当的配置和测试,我们可以确保日志系统按照预期...

    log4j-core-2.15.0.jar log4j-2.15.0-rc2

    Apache log4j2零日漏洞,根据 log4j-2.15.0-rc2 版本编译生成log4j-api-2.15.0.jar 1.解压你的jar jar xvf XXX.jar 2. 删除旧版本jar cd ./BOOT-INF/lib rm -rf log4j-api-*.jar 3. 上传新版本log4j-api-2.15.0....

    Log4j2、Fastjson、Log4j的BurpSuite插件亲测有效

    Log4j、Log4j2和Fastjson的安全性问题在过去曾引起广泛关注,例如Log4j2的CVE-2021-44228(也被称为Log4Shell漏洞),这是一个远程代码执行漏洞,影响了许多使用Log4j2的系统。这个插件可能就是为了检测和利用这些...

    log4j-api-2.12.4.ja和log4j-core-2.12.4.jar

    此次提及的`log4j-api-2.12.4.jar`和`log4j-core-2.12.4.jar`是Log4j 2框架的两个关键组件,版本号为2.12.4,这个版本主要修复了之前版本中可能存在的安全漏洞。 **log4j-api-2.12.4.jar** 是Log4j 2框架的API模块...

    logging-log4j2-log4j-2.15.0-rc2.zip

    《深入理解Log4j 2.15.0-rc2:日志处理的关键技术解析》 Log4j,作为Java领域广泛使用的日志记录框架,一直以来都是开发者们的重要工具。这次我们关注的是其最新版本——logging-log4j2-log4j-2.15.0-rc2。这个版本...

    SpringBoot框架配置log4j和log4j2的配置代码

    Log4j和Log4j2是两种广泛使用的Java日志框架,它们提供了灵活的日志配置和高性能的日志处理能力。本文将详细介绍如何在SpringBoot项目中配置Log4j和Log4j2。 ### SpringBoot与Log4j Log4j是Apache的一个开源项目,...

    log4j.properties(完整版) log4j.properties(精简版)

    **日志框架Log4j详解** 在Java开发中,日志记录是一项不可或缺的功能,它能够帮助开发者追踪程序运行状态,定位错误,优化性能,并为后期维护提供重要信息。Log4j是Apache组织开发的一个强大的、灵活的日志记录框架...

    log4j-2.18.0

    《log4j-2.18.0:修复重大安全漏洞的紧急更新》 在IT领域,安全性始终是首要关注的问题。近期,一个名为“log4j2”的严重安全漏洞引发了广泛关注,它影响了所有log4j2版本,从2.0开始直到2.18.0版本之前。这个漏洞...

    log4j-api-2.15.0.jar log4j-2.15.0-rc2

    Apache log4j2零日漏洞,根据 log4j-2.15.0-rc2 版本编译生成log4j-api-2.15.0.jar 1.解压你的jar jar xvf XXX.jar 2. 删除旧版本jar cd ./BOOT-INF/lib rm -rf log4j-api-*.jar 3. 上传新版本log4j-api-...

    log4j-API-最新稳定版本log4j-1.2.17

    标题提及的是"log4j-API-最新稳定版本log4j-1.2.17",这表明我们关注的是日志框架Log4j的一个特定版本,即1.2.17。Log4j是Apache软件基金会开发的一个用于Java应用程序的日志记录工具,它提供了灵活的日志记录功能,...

    logging-log4j2-log4j-2.16.0-rc1.zip

    总的来说,"logging-log4j2-log4j-2.16.0-rc1.zip"的发布是Log4j团队对"Log4Shell"漏洞的有力回应,通过禁用可能导致安全问题的功能,提高了整体的安全标准。这一事件提醒我们,安全无小事,及时的更新和维护是保障...

    log4j示例项目

    这个“log4j示例项目”旨在帮助开发者理解和使用Log4j,通过该项目,我们可以深入学习Log4j的配置、使用方法以及其在实际开发中的应用。 **1. Log4j的组成部分** Log4j主要包括三个核心组件:Logger(日志器)、...

    log4j-api-2.17.1.jar和log4j-core-2.17.1.jar

    《深入理解log4j-api-2.17.1.jar与log4j-core-2.17.1.jar》 在Java开发中,日志管理是不可或缺的一部分,它帮助我们跟踪程序运行状态、定位错误和调试问题。Log4j作为一款广泛使用的日志框架,历经多次迭代,现在...

    apache-log4j-2.17.0 核心jar包

    Log4j 是一个日志记录框架,Log4j 2 是对 Log4j 的升级,提供了重大改进,超越其前身 Log4j 1.x,并提供许多其它现代功能 ,例如对标记的支持、使用查找的属性替换、lambda 表达式与日志记录时无垃圾等。 Apache ...

Global site tag (gtag.js) - Google Analytics