Log4j使用实例

矫情吗；* 2021-09-14 06:48 342阅读 0赞

### Log4j使用实例    ###

通过Logger类的静态方法Logger.getRootLogger得到RootLogger。所有其他的loggers是通过静态方法Logger.getLogger来实例化并获取的。这个方法Logger.getLogger把所想要的logger的名字作为参数。 Logger类的一些其它基本方法在下面列出：

<table style="line-height:25px"> 
 <tbody> 
 <tr> 
 <td> package org.apache.log4j; public class Logger { &nbsp; &nbsp; // Creation and retrieval methods: &nbsp; public static Logger getRootLogger(); &nbsp; public static Logger getLogger(String name); &nbsp; &nbsp; // printing methods: &nbsp; public void debug(Object message); &nbsp; public void info(Object message); &nbsp; public void warn(Object message); &nbsp; public void error(Object message); &nbsp; public void fatal(Object message); &nbsp; &nbsp; // generic printing method: &nbsp; public void log(Level l, Object message); } &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

2. getLogger方法

以一样的参数名字调用getLogger方法，返回的reference总是指向完全相同的logger对象。例如，在这里：

Logger x = Logger.getLogger("wombat");

Logger y = Logger.getLogger("wombat");

x和y指向完全相同的logger对象。

3.Log4j使用流程

1）根据配置文件初始化log4j

log4j可以使用3种配置器来初始化：

BasicConfigurator,DOMConfigurator,PropertyConfigurator。

这里用的是PropertyConfigurator。使用PropertyConfigurator适用于所有的系统。如下的语句。

PropertyConfigurator.configure("log4j.properties");

就以log4j.properties为配置文件初始化好了log4j环境。对于一般的java project 可以不使用上面的语句初始化log4j，log4j会自动在classpath下，找到配置文件并初始化。如果log4j不能自动初始化配置文件，那么就需要用上面的方法进行初始化。

注意：初始化配置文件，最好只在系统启动的时候执行一次，如果执行多次，一是浪费资源，二就是对于老版本的log4j，使用DailyRollingFileAppender时，可能会出现问题。

2）导入org.apache.log4j.Logger;及相关包。

3）在需要使用log4j的地方获取Log实例。

static Logger log = Logger.getLogger("MyCLASS.class");

4）使用Logger对象的debug,info,fatal...方法。

log.debug("it is the debug info");

4.Log4j使用示例

Test.java

<table style="line-height:25px"> 
 <tbody> 
 <tr> 
 <td> import org.apache.log4j.Logger; &nbsp; public class Test { &nbsp;&nbsp;&nbsp; static Logger log= Logger.getLogger(Test.class); &nbsp;&nbsp;&nbsp; public void log(){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; log.debug("Debug info."); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; log.info("Info info"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; log.warn("Warn info"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; log.error("Error info"); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; log.fatal("Fatal info"); &nbsp;&nbsp;&nbsp; } &nbsp;&nbsp;&nbsp; public static void main(String[] args) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Test test = new Test(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; test.log(); &nbsp;&nbsp;&nbsp; } } &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

Log4j.properties（具体配置属性定义见《Log4j配置说明》）

结果

INFO \[main\] (Test.java:16) - Info info

WARN \[main\] (Test.java:17) - Warn info

ERROR \[main\] (Test.java:18) - Error info

FATAL \[main\] (Test.java:19) - Fatal info

分析：

Test.java

“Logger.getLogger(Test.class);”这里的“Test.class”事实上传进去的是Test这个类的完整路径（包名+类名），“test.Test”。这样如果存在“test”这个Log那么Test这个Log就继承它，否则就继承rootLogger。

Log4j.properties

第一行，配置log4j.rootLogger。应为它是根，必须配置，否则别的Log无法继承。其他的Log可以配置也可以不配置。等号后面的第一个参数表示日志级别，可以填五个级别中的一种（Log4j默认把日志信息分为五个等级debug < info < warn < error < fatal），后面的参数都是让Log知道输出到哪里，如果你想让日志输出到两个地方就加两个输出参数，比如：

log4j.rootLogger=info, stdout

这里的info表示，该Log的日志级别为info，所有级别小于info的日志都不会被记录。比如使用这个配置文件的话，我刚开始举的那个类中

log.debug("Debug info.");

这句话是不起作用的，因为debug的级别小于info。这样就很容易控制什么信息在调试的时候要显示，什么信息在发布的时候要去掉。这些都不用改代码。

配置stdout，这个名字是随便取的，你可以叫它A：

log4j.appender.A=org.apache.log4j.ConsoleAppender

那么上面的rootLogger的参数stdout也要改成A，其他用到的地方当然也要改。这里的关键不是名字，而是appender类型，比如这里的“ConsoleAppender”，指输出到Console。后面两行都是设置日志格式的。

付：log4j.property

1) 把log4j.properties或是log4j.xml放在src根下(ClassPath路径中)，或者结合spring的配置在web.xml中  
> log4j.properties内容举例如下：  
log4j.rootCategory=DEBUG, stdout, R

\#Console config 
log4j.appender.stdout=org.apache.log4j.ConsoleAppender 
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 
log4j.appender.stdout.layout.ConversionPattern=<%d> <%-5p> <%c> - %m(%F:%M:%L)%n

\#File config 
log4j.appender.R=org.apache.log4j.RollingFileAppender 
log4j.appender.R.File=$\{catalina\_home\}/logs/test.log 
log4j.appender.R.MaxFileSize=100KB 
log4j.appender.R.MaxBackupIndex=0 
log4j.appender.R.layout=org.apache.log4j.PatternLayout 
log4j.appender.R.layout.ConversionPattern=<%d> <%-5p> <%c> - %m(%F:%M:%L)%n

\#Package config  
log4j.logger.org.apple=DEBUG  
log4j.logger.org.apache.commons=ERROR  
log4j.logger.org.springframework=ERROR  
log4j.logger.org.apache.struts=ERROR

===========================++++++++++++++++++++++++++++++++++++++++++++======================

### [log4j输出多个自定义日志文件，动态配置路径][log4j] ###

分类：  [文字&记号][Link 1]2009-07-29 14:12  4157人阅读  [评论][Link 2](5)  [收藏][log4j]  [举报][Link 3]

1.    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**

2.动态配置路径

若程序需要的日志路径需要不断的变化，而又不可能每次都去改配置文件，那就要采取两种方法。

第一种

log4j的配置文件支持windows的环境变量，格式类似velocity:$\{env\}，那我们就用环境变量表示可能会变化的路径。上文已使用“log4j.appender.test1.File=$\{myweb.root\}/WEB-INF/log/**test1.log**”。

第二种

这种方法是不用配置文件，而是在程序里用代码配置，代码是活的，所以路径肯定可以写活。示例如下：

**\[java\]**  [view plain][] [copy][view plain]

1.  Logger myTest = Logger.getLogger("myTest");  
2.    
3.  Layout layout = new PatternLayout("%d %p \[%c\] - %m%n");  
4.    
5.  Appender appender = new FileAppender(layout, logFilePath);  
6.    
7.  myTest.addAppender(appender);

附：ConversionPattern参数的格式含义

%c 输出日志信息所属的类的全名  
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d\{yyy-MM-dd HH:mm:ss \}，输出类似：2002-10-18- 22：10：28  
%f 输出日志信息所属的类的类名  
%l 输出日志事件的发生位置，即输出日志信息的语句处于它所在的类的第几行  
%m 输出代码中指定的信息，如log(message)中的message  
%n 输出一个回车换行符，Windows平台为“/r/n”，Unix平台为“/n”  
%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL。如果是调用debug()输出的，则为DEBUG，依此类推  
%r 输出自应用启动到输出该日志信息所耗费的毫秒数  
%t 输出产生该日志事件的线程名

[log4j]: http://blog.csdn.net/wiwipetter/article/details/4390579
[Link 1]: http://blog.csdn.net/wiwipetter/article/category/572971
[Link 2]: http://blog.csdn.net/wiwipetter/article/details/4390579#comments
[Link 3]: http://blog.csdn.net/wiwipetter/article/details/4390579#report
[view plain]: http://blog.csdn.net/wiwipetter/article/details/4390579#