log4j 又一点
log4j的好处在于:
1 .通过修改配置文件,就可以决定log信息输出到何处(console,文件,),是否输出。
这样,在系统开发阶段可以打印详细的log信息以跟踪系统运行情况,而在系统稳定后可以关闭log输出,从而在能跟踪系统运行情况的同时,又减少了垃圾代码(System.out.println()等)。
2 .使用log4j,需要整个系统有一个统一的log机制,有利于系统的规划。
log4j的使用本身很简单。但合理地规划一个系统的统一log机制需要周全的考虑。
其他关于log4j的信息参看log4j自带的文档。
PART II 配置文件详细解释
先看一个配置文件的例子:
1 .配置文件的例子
log4j.rootLogger = DEBUG
#将DAO层log记录到DAOLog,allLog中
log4j.logger.DAO = DEBUG,A2,A4
#将逻辑层log记录到BusinessLog,allLog中
log4j.logger.Businesslog = DEBUG,A3,A4
#A1 -- 打印到屏幕上
log4j.appender.A1 = org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout = org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern =%- 5p [ % t] % 37c % 3x - % m % n
#A2 -- 打印到文件DAOLog中 -- 专门为DAO层服务
log4j.appender.A2 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.file = DAOLog
log4j.appender.A2.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern = [ %- 5p] % d{yyyy - MM - dd HH:mm:ss,SSS} method: % l % n % m % n
#A3 -- 打印到文件BusinessLog中 -- 专门记录逻辑处理层服务log信息
log4j.appender.A3 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A3.file = BusinessLog
log4j.appender.A3.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A3.layout = org.apache.log4j.PatternLayout
log4j.appender.A3.layout.ConversionPattern = [ %- 5p] % d{yyyy - MM - dd HH:mm:ss,SSS} method: % l % n % m % n
#A4 -- 打印到文件alllog中 -- 记录所有log信息
log4j.appender.A4 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A4.file = alllog
log4j.appender.A4.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A4.layout = org.apache.log4j.PatternLayout
log4j.appender.A4.layout.ConversionPattern = [ %- 5p] % d{yyyy - MM - dd HH:mm:ss,SSS} method: % l % n % m % n
2 .Appender的使用
一个Appender代表log信息要写向的一个地方。log4j可使用的Appender有很多类型,这里只考虑3种:ConsoleAppender,FileAppender,DailyRollFileAppender
2.1 ConsoleAppender
如果使用ConsoleAppender,那么log信息将写到Console。就是直接把信息打印到System.out上了。
2.2 FileAppender
使用FileAppender,那么log信息将写到指定的文件中。这应该是比较经常使用到的情况。
相应地,在配置文件中应该指定log输出的文件名。如下配置指定了log文件名为demo.txt
log4j.appender.A2.File = demo.txt
注意将A2替换为具体配置中Appender的别名。
2.3 DailyRollingAppender
使用FileAppender可以将log信息输出到文件中,但是如果文件太大了读起来就不方便了。这时就可以使用DailyRollingAppender。DailyRollingAppender可以把Log信息输出到按照日期来区分的文件中。如下配置文件就会每天产生一个log文件,每个log文件只记录当天的log信息:
log4j.appender.A2 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.file = demo
log4j.appender.A2.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern =% m % n
3 .Layout的配置
Layout指定了log信息输出的样式。
详细信息请查看PatternLayout的javadoc。
例子1:显示日期和log信息
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern =% d{yyyy - MM - dd HH:mm:ss,SSS} % m % n
打印的信息是:
2002 - 11 - 12 11 : 49 : 42 , 866 SELECT * FROM Role WHERE 1 = 1 order by createDate desc
例子2:显示日期,log发生地方和log信息
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern =% d{yyyy - MM - dd HH:mm:ss,SSS} % l " # " % m % n
2002 - 11 - 12 11 : 51 : 46 , 313 cn.net.unet.weboa.system.dao.RoleDAO.select(RoleDAO.java: 409 ) " # " SELECT * FROM Role WHERE 1 = 1 order by createDate desc
例子3:显示log级别,时间,调用方法,log信息
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern = [ %- 5p] % d{yyyy - MM - dd HH:mm:ss,SSS} method: % l % n % m % n
log信息:
[DEBUG] 2002 - 11 - 12 12 : 00 : 57 , 376 method:cn.net.unet.weboa.system.dao.RoleDAO.select (RoleDAO.java: 409 )
SELECT * FROM Role WHERE 1 = 1 order by createDate desc
PART 3 log4j的使用
log4j使用步骤有3个:
3.1 .根据配置文件初始化log4j
配置文件如PART 2所叙述。现在讲的是如何在程序中配置log4j。
log4j可以使用3中配置器来初始化:BasicConfigurator,DOMConfigurator,PropertyConfigurator
这里用的是PropertyConfigurator。使用PropertyConfigurator适用于所有的系统。
如下的语句
PropertyConfigurator.configure( " log4j.properties " );
就以log4j.properties为配置文件初始化好了log4j环境。
注意一点:这个语句只需要在系统启动的时候执行一次。例如:在unet webOA项目中可以这么用:
在ActionServlet的init()方法中调用一次。
public class ActionServlet extends HttpServlet{
/**
* Initialize global variables
*/
public void init() throws ServletException {
// 初始化Action资源
try {
initLog4j();
} catch (IOException e){
throw new ServletException( " Load ActionRes is Error " );
}
}
protected void initLog4j(){
PropertyConfigurator.configure ( " log4j.properties " );
}
} // end class ActionServlet
3.2 在需要使用log4j的地方获取Logger实例
如下是RoleDAO类中的使用例子:
static Logger log = Logger.getLogger( " DAO " );
注意这里使用 " DAO " 标识符,那么对应的在配置文件中对应的配置信息如下:
#定义DAO Logger
log4j.logger.DAO = DEBUG,A2
#设置Appender A2的属性
log4j.appender.A2 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.file = demo
log4j.appender.A2.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern =%- 5p % d{yyyy - MM - dd HH:mm:ss} % l % n % m % n
public class RoleDAO extends BaseDBObject
{
static Logger log = Logger.getLogger( " DAO " );
public BeanCollection selectAll() throws SQLException
{
StringBuffer sql = new StringBuffer(SQLBUF_LEN);
sql.append( " SELECT * FROM " + tableName + " order by roldId " );
// System.out.println(sql.toString());
log.debug(sql);
}
}
3.3 使用Logger对象的debug,info,fatal方法
log.debug( " it is the debug info " );
附件1:log4j的一个bug
当这样使用时,DailyRollingFileAppender不能正确使用:
public Class RoleDAO(){
static Logger log = Logger.getLogger ( " DAO " );
// 在每一次new RoleDAO对象的时候都执行一次configure()操作
public RoleDAO(TransactionManager transMgr) throws SQLException
{
PropertyConfigurator.configure( " log4j.properties " );
}
public void select(){
// 使用log4j进行log记录
log.debug( " " );
}
}
怎么解决:
在系统启动时执行一次PropertyConfigurator.configure( " log4j.properties " );
之后就不再执行。
1 .通过修改配置文件,就可以决定log信息输出到何处(console,文件,),是否输出。
这样,在系统开发阶段可以打印详细的log信息以跟踪系统运行情况,而在系统稳定后可以关闭log输出,从而在能跟踪系统运行情况的同时,又减少了垃圾代码(System.out.println()等)。
2 .使用log4j,需要整个系统有一个统一的log机制,有利于系统的规划。
log4j的使用本身很简单。但合理地规划一个系统的统一log机制需要周全的考虑。
其他关于log4j的信息参看log4j自带的文档。
PART II 配置文件详细解释
先看一个配置文件的例子:
1 .配置文件的例子
log4j.rootLogger = DEBUG
#将DAO层log记录到DAOLog,allLog中
log4j.logger.DAO = DEBUG,A2,A4
#将逻辑层log记录到BusinessLog,allLog中
log4j.logger.Businesslog = DEBUG,A3,A4
#A1 -- 打印到屏幕上
log4j.appender.A1 = org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout = org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern =%- 5p [ % t] % 37c % 3x - % m % n
#A2 -- 打印到文件DAOLog中 -- 专门为DAO层服务
log4j.appender.A2 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.file = DAOLog
log4j.appender.A2.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern = [ %- 5p] % d{yyyy - MM - dd HH:mm:ss,SSS} method: % l % n % m % n
#A3 -- 打印到文件BusinessLog中 -- 专门记录逻辑处理层服务log信息
log4j.appender.A3 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A3.file = BusinessLog
log4j.appender.A3.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A3.layout = org.apache.log4j.PatternLayout
log4j.appender.A3.layout.ConversionPattern = [ %- 5p] % d{yyyy - MM - dd HH:mm:ss,SSS} method: % l % n % m % n
#A4 -- 打印到文件alllog中 -- 记录所有log信息
log4j.appender.A4 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A4.file = alllog
log4j.appender.A4.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A4.layout = org.apache.log4j.PatternLayout
log4j.appender.A4.layout.ConversionPattern = [ %- 5p] % d{yyyy - MM - dd HH:mm:ss,SSS} method: % l % n % m % n
2 .Appender的使用
一个Appender代表log信息要写向的一个地方。log4j可使用的Appender有很多类型,这里只考虑3种:ConsoleAppender,FileAppender,DailyRollFileAppender
2.1 ConsoleAppender
如果使用ConsoleAppender,那么log信息将写到Console。就是直接把信息打印到System.out上了。
2.2 FileAppender
使用FileAppender,那么log信息将写到指定的文件中。这应该是比较经常使用到的情况。
相应地,在配置文件中应该指定log输出的文件名。如下配置指定了log文件名为demo.txt
log4j.appender.A2.File = demo.txt
注意将A2替换为具体配置中Appender的别名。
2.3 DailyRollingAppender
使用FileAppender可以将log信息输出到文件中,但是如果文件太大了读起来就不方便了。这时就可以使用DailyRollingAppender。DailyRollingAppender可以把Log信息输出到按照日期来区分的文件中。如下配置文件就会每天产生一个log文件,每个log文件只记录当天的log信息:
log4j.appender.A2 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.file = demo
log4j.appender.A2.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern =% m % n
3 .Layout的配置
Layout指定了log信息输出的样式。
详细信息请查看PatternLayout的javadoc。
例子1:显示日期和log信息
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern =% d{yyyy - MM - dd HH:mm:ss,SSS} % m % n
打印的信息是:
2002 - 11 - 12 11 : 49 : 42 , 866 SELECT * FROM Role WHERE 1 = 1 order by createDate desc
例子2:显示日期,log发生地方和log信息
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern =% d{yyyy - MM - dd HH:mm:ss,SSS} % l " # " % m % n
2002 - 11 - 12 11 : 51 : 46 , 313 cn.net.unet.weboa.system.dao.RoleDAO.select(RoleDAO.java: 409 ) " # " SELECT * FROM Role WHERE 1 = 1 order by createDate desc
例子3:显示log级别,时间,调用方法,log信息
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern = [ %- 5p] % d{yyyy - MM - dd HH:mm:ss,SSS} method: % l % n % m % n
log信息:
[DEBUG] 2002 - 11 - 12 12 : 00 : 57 , 376 method:cn.net.unet.weboa.system.dao.RoleDAO.select (RoleDAO.java: 409 )
SELECT * FROM Role WHERE 1 = 1 order by createDate desc
PART 3 log4j的使用
log4j使用步骤有3个:
3.1 .根据配置文件初始化log4j
配置文件如PART 2所叙述。现在讲的是如何在程序中配置log4j。
log4j可以使用3中配置器来初始化:BasicConfigurator,DOMConfigurator,PropertyConfigurator
这里用的是PropertyConfigurator。使用PropertyConfigurator适用于所有的系统。
如下的语句
PropertyConfigurator.configure( " log4j.properties " );
就以log4j.properties为配置文件初始化好了log4j环境。
注意一点:这个语句只需要在系统启动的时候执行一次。例如:在unet webOA项目中可以这么用:
在ActionServlet的init()方法中调用一次。
public class ActionServlet extends HttpServlet{
/**
* Initialize global variables
*/
public void init() throws ServletException {
// 初始化Action资源
try {
initLog4j();
} catch (IOException e){
throw new ServletException( " Load ActionRes is Error " );
}
}
protected void initLog4j(){
PropertyConfigurator.configure ( " log4j.properties " );
}
} // end class ActionServlet
3.2 在需要使用log4j的地方获取Logger实例
如下是RoleDAO类中的使用例子:
static Logger log = Logger.getLogger( " DAO " );
注意这里使用 " DAO " 标识符,那么对应的在配置文件中对应的配置信息如下:
#定义DAO Logger
log4j.logger.DAO = DEBUG,A2
#设置Appender A2的属性
log4j.appender.A2 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.file = demo
log4j.appender.A2.DatePattern = ' . ' yyyy - MM - dd
log4j.appender.A2.layout = org.apache.log4j.PatternLayout
log4j.appender.A2.layout.ConversionPattern =%- 5p % d{yyyy - MM - dd HH:mm:ss} % l % n % m % n
public class RoleDAO extends BaseDBObject
{
static Logger log = Logger.getLogger( " DAO " );
public BeanCollection selectAll() throws SQLException
{
StringBuffer sql = new StringBuffer(SQLBUF_LEN);
sql.append( " SELECT * FROM " + tableName + " order by roldId " );
// System.out.println(sql.toString());
log.debug(sql);
}
}
3.3 使用Logger对象的debug,info,fatal方法
log.debug( " it is the debug info " );
附件1:log4j的一个bug
当这样使用时,DailyRollingFileAppender不能正确使用:
public Class RoleDAO(){
static Logger log = Logger.getLogger ( " DAO " );
// 在每一次new RoleDAO对象的时候都执行一次configure()操作
public RoleDAO(TransactionManager transMgr) throws SQLException
{
PropertyConfigurator.configure( " log4j.properties " );
}
public void select(){
// 使用log4j进行log记录
log.debug( " " );
}
}
怎么解决:
在系统启动时执行一次PropertyConfigurator.configure( " log4j.properties " );
之后就不再执行。