log4j 自定义日志文件

log4j的强大功能无可置疑，但实际应用中免不了遇到某个功能需要输出独立的日志文件的情况，怎样才能把所需的内容从原有日志中分离，形成单独的日志文件呢？其实只要在现有的log4j基础上稍加配置即可轻松实现这一功能。   
先看一个常见的log4j.properties文件，它是在控制台和myweb.log文件中记录日志：    
log4j.rootLogger=DEBUG, stdout, logfile    
log4j.category.org.springframework=ERROR    
log4j.category.org.apache=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=${myweb.root}/WEB-INF/log/myweb.log    
log4j.appender.logfile.MaxFileSize=512KB    
log4j.appender.logfile.MaxBackupIndex=5    
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout    
log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n    
如果想对不同的类输出不同的文件(以cn.com.Test为例)，先要在Test.java中定义:    
private static Log logger = LogFactory.getLog(Test.class);    
然后在log4j.properties中加入:    
log4j.logger.cn.com.Test= DEBUG, test    
log4j.appender.test=org.apache.log4j.FileAppender    
log4j.appender.test.File=${myweb.root}/WEB-INF/log/test.log    
log4j.appender.test.layout=org.apache.log4j.PatternLayout    
log4j.appender.test.layout.ConversionPattern=%d %p [%c] - %m%n    
也就是让cn.com.Test中的logger使用log4j.appender.test所做的配置。    
但是，如果在同一类中需要输出多个日志文件呢？其实道理是一样的，先在Test.java中定义:    
private static Log logger1 = LogFactory.getLog("myTest1");    
private static Log logger2 = LogFactory.getLog("myTest2");    
然后在log4j.properties中加入:    
log4j.logger.myTest1= DEBUG, test1    
log4j.appender.test1=org.apache.log4j.FileAppender    
log4j.appender.test1.File=${myweb.root}/WEB-INF/log/test1.log    
log4j.appender.test1.layout=org.apache.log4j.PatternLayout    
log4j.appender.test1.layout.ConversionPattern=%d %p [%c] - %m%n    
log4j.logger.myTest2= DEBUG, test2    
log4j.appender.test2=org.apache.log4j.FileAppender    
log4j.appender.test2.File=${myweb.root}/WEB-INF/log/test2.log    
log4j.appender.test2.layout=org.apache.log4j.PatternLayout    
log4j.appender.test2.layout.ConversionPattern=%d %p [%c] - %m%n    
也就是在用logger时给它一个自定义的名字(如这里的"myTest1")，然后在log4j.properties中做出相应配置即可。别忘了不同日志要使用不同的logger(如输出到test1.log的要用logger1.info("abc"))。    
还有一个问题，就是这些自定义的日志默认是同时输出到log4j.rootLogger所配置的日志中的，如何能只让它们输出到自己指定的日志中呢？别急，这里有个开关：    
log4j.additivity.myTest1 = false    
它用来设置是否同时输出到log4j.rootLogger所配置的日志中，设为false就不会输出到其它地方啦！注意这里的"myTest1"是你在程序中给logger起的那个自定义的名字！    
如果你说，我只是不想同时输出这个日志到log4j.rootLogger所配置的logfile中，stdout里我还想同时输出呢！那也好办，把你的log4j.logger.myTest1 = DEBUG, test1改为下式就OK啦！    
log4j.logger.myTest1=DEBUG, test1, stdout    
--------------------------------------------------------------------------------------------------------------------------------------    
log4j使用示例    
--by blues(zhaochaohua@sina.com)    
PART 1 介绍    
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");    
之后就不再执行。    
---------------------------------------------------------------------------------------------------------------------------    
一、log4j.properties    
### 设置org.zblog域对应的级别INFO,DEBUG,WARN,ERROR和输出地A1，A2 ##    
log4j.category.org.zblog=ERROR,A1    
log4j.category.org.zblog=INFO,A2    
log4j.appender.A1=org.apache.log4j.ConsoleAppender    
### 设置输出地A1，为ConsoleAppender(控制台) ##    
log4j.appender.A1.layout=org.apache.log4j.PatternLayout    
### 设置A1的输出布局格式PatterLayout,(可以灵活地指定布局模式）##    
log4j.appender.A1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n    
### 配置日志输出的格式##    
log4j.appender.A2=org.apache.log4j.RollingFileAppender    
### 设置输出地A2到文件（文件大小到达指定尺寸的时候产生一个新的文件）##    
log4j.appender.A2.File=E:/study/log4j/zhuwei.html    
### 文件位置##    
log4j.appender.A2.MaxFileSize=500KB    
### 文件大小##    
log4j.appender.A2.MaxBackupIndex=1    
log4j.appender.A2.layout=org.apache.log4j.HTMLLayout    
##指定采用html方式输出    
二、log4j.xml    
<?xml version="1.0" encoding="GB2312" ?>    
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">    
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">    
<appender >    
<!-- 设置通道ID:org.zblog.all和输出方式：org.apache.log4j.RollingFileAppender -->    
<param value="E:/study/log4j/all.output.log" /><!-- 设置File参数：日志输出文件名 -->    
<param value="false" /><!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->    
<layout >    
<param value="%p (%c:%L)- %m%n" /><!-- 设置输出文件项目和格式 -->    
</layout>    
</appender>    
<appender >    
<param value="E:/study/log4j/zhuwei.output.log" />    
<param value="true" />    
<param value="10240" /> <!-- 设置文件大小 -->    
<layout >    
<param value="%p (%c:%L)- %m%n" />    
</layout>    
</appender>    
<logger > <!-- 设置域名限制，即zcw.log域及以下的日志均输出到下面对应的通道中 -->    
<level value="debug" /><!-- 设置级别 -->    
<appender-ref ref="org.zblog.zcw" /><!-- 与前面的通道id相对应 -->    
</logger>    
<root> <!-- 设置接收所有输出的通道 -->    
<appender-ref ref="org.zblog.all" /><!-- 与前面的通道id相对应 -->    
</root>    
</log4j:configuration>    
三、配置文件加载方法：    
import org.apache.log4j.Logger;    
import org.apache.log4j.PropertyConfigurator;    
import org.apache.log4j.xml.DOMConfigurator;    
public class Log4jApp {    
public static void main(String[] args) {    
DOMConfigurator.configure("E:/study/log4j/log4j.xml");//加载.xml文件    
//PropertyConfigurator.configure("E:/study/log4j/log4j.properties");//加载.properties文件    
Logger log=Logger.getLogger("org.zblog.test");    
log.info("测试");    
}    
}    
四、项目使用log4j    
在web应用中，可以将配置文件的加载放在一个单独的servlet中，并在web.xml中配置该servlet在应用启动时候加载。对于在多人项目 中，可以给每一个人设置一个输出通道，这样在每个人在构建Logger时，用自己的域名称，让调试信息输出到自己的log文件中。    
五、常用输出格式    
# -X号:X信息输出时左对齐；    
# %p:日志信息级别    
# %d{}:日志信息产生时间    
# %c:日志信息所在地（类名）    
# %m:产生的日志具体信息    
# %n:输出日志信息换行