log4j-1.2.9. 在 tomcat5.5 下面的配置
拷贝 log4j-1.2.9.jar 到 \WEB-INF\lib 目录下
在 eclipse 的 java builder path 中增加 log4j-1.2.9.jar 引用是没有用的
在拷贝 log4j-1.2.9.jar 到 \WEB-INF\lib 下
tomcat 在启动的时候需要自动查找这个目录下面的 lib, 而 eclipse 的引用是在开发的使用使用 , 在没有发布的情况下 ,tomcat 找不到这些类
建 commons-logging.properties 文件
在 \WEB-INF\classes 目录下建 commons-logging.properties 文件
内容为
org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4Jlogger
建 log4j.properties 文件
内容如下 在 \WEB-INF\classes 目录下建 log4j.properties 文件
log4j.rootLogger= INFO,logfile,stdout
# 上面的 INFO 表示日志输出的等级为 INFO
log4j.appender.stdout= org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout= org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern= %d %p [%c] - <%m>%n
log4j.appender.logfile= org.apache.log4j.RollingFileAppender
log4j.appender.logfile.File= C : /eclipse/workspace/Recommend/Log/operation.log
log4j.appender.logfile.MaxFileSize= 512KB
# Keep three backup files.
log4j.appender.logfile.MaxBackupIndex= 0
# Pattern to output: date priority [category] - message
log4j.appender.logfile.layout= org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern= %d %p [%c] - %m%n
# If programmed properly the most messages would be at DEBUG
# and the least at FATAL.
log4j/log4e 的使用
Log4j 就是帮助开发人员进行日志输出管理的 API 类库。它最重要的特点就可以配置文件灵活的设置日志信息的优先级、日志信息的输出目的地以及日志信息的输出格式。
Log4j 除了可以记录程序运行日志信息外还有一重要的功能就是用来显示调试信息。
程序员经常会遇到脱离 java ide 环境调试程序的情况,这时大多数人会选择使用 System.out
.println 语句输出某个变量值的方法进行调试。这样会带来一个非常麻烦的问题:一旦哪天程序员决定不要显示这些 System.out.println 的东西了就只能一行行的把这些垃圾语句注释掉。若哪天又需调试变量值,则只能再一行行去掉这些注释恢复 System.out.println 语句。
使用 log4j 可以很好的处理类似情况。 log4j 使用方法下面介绍的是 log4j 一些理论方面的知识
定义配置文件
首先使用配置文件将使我们的应用程序更加灵活配置 log 日志输出方式包括输出优先级、输出目的地、输出格式。 Log4j 支持两种配置文件格式,一种是 XML 格式的文件,一种是 Java 特性文件 log4j.properties (键 = 值)。
下面将介绍使用 log4j.properties 文件作为配置文件的方法:
配置根 Logger
其语法为: log4j.rootLogger = [ level ] , appenderName, appenderName, …
l 输出优先级别
[level] 是日志记录的优先级 , 优先级分为 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 ALL 或者自定义的级别。
Log4j 建议只使用四个级别,优先级从高到低分别是 ERROR 、 WARN 、 INFO 、 DEBUG 。
通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了 INFO 级别,则应用程序中所有 DEBUG 级别的日志信息将不被打印出来。
l 输出目的地
具体输出地的输出格式配置
l 输出地类型的配置
appenderName 就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。
配置日志信息输出目的地 Appender ,其语法为:
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1 …
log4j.appender.appenderName.option N = valueN
其中, Log4j 提供的 appender 有以下几种:
org.apache.log4j.ConsoleAppender (控制台),
org.apache.log4j.FileAppender (文件),
org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件),
org.apache.log4j.RollingFileAppender (文件大小到达指定尺寸的时候产生一个新的文件),
org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方)
l 配置日志信息的格式(布局)
其语法为:
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 (包含日志产生的时间、线程、类别等等信息)
Log4J 采用类似 C 语言中的 printf 函数的打印格式格式化日志信息,
打印参数如下:
%m 输出代码中指定的消息
%p 输出优先级,即 DEBUG , INFO , WARN , ERROR , FATAL
%r 输出自应用启动到输出该 log 信息耗费的毫秒数
%c 输出所属的类目,通常就是所在类的全名
%t 输出产生该日志事件的线程名
%n 输出一个回车换行符, Windows 平台为“ \r\n ”, 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
l 获取日志记录器
使用 Log4j ,第一步就是获取日志记录器,这个记录器将负责控制日志信息。
其语法为:
public static Logger getLogger( String name)
通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。 Name 一般取本类的名字,比如:
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )
l 读取配置文件
当获得了日志记录器之后,第二步将配置 Log4j 环境,
其语法为: BasicConfigurator.configure () : 自动快速地使用缺省 Log4j 环境。
PropertyConfigurator.configure ( String configFilename) :
读取使用 Java 的特性文件编写的配置文件。
例: PropertyConfigurator.configure(".\\src\\log4j.properties")
DOMConfigurator.configure ( String filename ) :读取 XML 形式的配置文件。
l 插入记录信息(格式化日志信息)
当上两个必要步骤执行完毕,就可轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方,其语法如下:
Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;
log4j 范例程序
下面将使用一个最简单的范例程序来进一步说明 log4j 的使用方法。
程序代码如下:
import org.apache.log4j.*;
public class LogTest {
static Logger logger = Logger.getLogger(LogTest.class.getName());
public static void main(String[] args)
{
PropertyConfigurator.configure ( “ .\\src\log4j.properties ” ) ;
ogger.debug("Debug ...");
logger.info("Info ...");
logger.warn("Warn ...");
logger.error("Error ...");
}
}
程序说明:
① static Logger logger = Logger.getLogger(LogTest.class.getName());
就是创建一个属于 LogTest 类的 Logger 对象,创建时要告知 Logger 你当前的 Class 是什么。
② PropertyConfigurator.configure ( “ log4j.properties ” )
就是说使用当前工程目录下的 src 文件夹中的 log4j.properties 文件作为配置文件。
若将 log4j.properties 放在工程根目录下也可不写此句,程序会自动找到配置文件。
③ logger.debug 就是输出 debug 的信息,
logger.info 就是输出提示信息,
logger.warn 就是显示警告信息,
logger.error 就是显示错误信息。
下面是配置文件 log4j.properties 的内容: log4j.rootLogger
log4j. rootLogger =DEBUG, stdout , R
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p (%F:%L) - %m%n
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=log.txt log4j.appender.R.MaxFileSize=100KB
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy MMM dd HH:mm:ss} %-5p %c - %m%n
程序说明:
l log4j. rootLogger =DEBUG, stdout , R
就是说我要显示所有优先权等於和高于 Debug 的信息。 "stdout" ,” R ”表示我定义了两个输出端 ( 随便什么名字都好 ) 。下面的三行说 stdout 输出端其实是标准输出 Console ,也就是屏幕。
l 输出的格式是 PatternLayout 。转换方式是 %5p (%F:%L) - %m%n ,
即前五格用来显示优先权,再显示当前的文件名,加当前的行数。
最后是 logger.debug() 或 logger.info() 或 logger.warn() 或 logger.error() 里的信息。
%n 表示回车空行。
再加上下面六行则 log 信息不光显示在屏幕上,而且将被保存在一个叫 "log.txt" 的文件里,文件最大为 100KB 。如果文件大小超过 100KB ,文件会被备份成 "log.txt.1" ,新的 "log.txt" 继续记录 log 信息。接下来我们可以改变 log4j.properties ,而不需重新编译就可以控制 log 信息是否显示、 log 信息的输出端类型、输出方式、输出格式,等等。
举例如下:
在 log4j.properties 文件里把 "log4j. rootLogger =DEBUG,stdout,R"
改写成 "log4j.rootCategory=OFF, stdout,R" ,这样所有的 log 信息都不会显示了;解决了本文开始提出的问题。
在 log4j.properties 文件里把 "log4j. rootLogger =DEBUG,stdout,R" 改写成 "log4j.rootCategory=INFO, stdout,R" ,这样只显示 INFO, WARN, ERROR 的 log 信息,而 DEBUG 信息不会被显示; 在 web 程序中使用 log4j 注意问题
1、 由于 jsp 或 servlet 在执行状态时没有当前路径概念,所有使用
PropertyConfigurator.configure ( String )语句找 log4j.properties 文件时要给出相对于
当前 jsp 或 servlet 的路径转化成为一个绝对的文件系统路径。
方法是使用 servletcontext.getrealpath(string) 语句。
例: // 得到当前 jsp 路径 String prefix = getServletContext().getRealPath("/");
// 读取
log4j.properties PropertyConfigurator.configure(prefix+"\\WEB-INF\\log4j.properties");
2、 相应的 log4j.properties 设置某个属性时也要在程序中设置绝对路径。
例: log4j.appender.R.File 属性设置日志文件存放位置。
我们可以用读写 .properties 配置文件的方法进行灵活设置。
log4e 使用说明在了解了 log4j 的功能后
我们肯定会我们的程序中编写一些 Log4j 日志记录。
对于使用 Eclipse 的程序员 Log4e 将是我们最得力的 log4j 日志编写助手,现在开始 Log4e 之旅。 Log4e 是一个免费的 Eclipse Plugin ,它可帮助你在你的 Java 工程中快速加入 Log ;我们可以在 http://log4e.jayefem.de/index.php/Download 网站上下载 Log4e 最新版本。
下载后将相应文件夹拷贝到 Eclipse 的插件目录下,重新 Eclipse ,在首选项中会多出一个 Log4e 选项。 Log4e 可以有多个插入 Log 为一个方法、类,当然也可以在当前位置插入 Log ,
同时其也可以把 Sysout.out.println() 的转换为 log ;所有的这一切只需要你点点鼠标或者按一次快捷键,下面我们只以为一个方法插入 Log 为例来讲解在 Java 编辑上下文中点击右键,
选择 Log4E ,你将看到如下界面: 点击 Insert Log Statement For This Method ,你将看到验证页面: Finish 后这时你将看到插入 Log 后的函数如下:
Log4e 更多的实例参照 http://log4e.jayefem.de