Log4J实战

场景如下
   由于项目要做一个统计分析与记录的功能，为了后期分析用户的一些行为，同时记录的东西要同时输出多处，并且可配置输出  
想到了使用log4j，知道他是可以同时指定多个输出目的地，并且如有变更，直接修改配置文件。 

关于log4j的基本概论及使用，见http://www.iteye.com/topic/378077，这个帖子讲的很细，归纳了很多东西 

问题一：把登录用户每次访问的ip地址 时间等记录下来，存放到日志文件里，再存一份到数据库 

第一步:记录用户访问，写一个filter如下，里面MDC是一个类似map的东西，只不过做了线程方式的封装使用，每个线程会有自己的一份map,可以看这个http://www.iteye.com/topic/1112590  

Java代码  

1. public class UserLogFilter implements Filter {  
2.     private Logger logger;  
3.   
4.     @Override  
5.     public void destroy() {  
6.         // TODO Auto-generated method stub  
7.           
8.     }  
9.   
10.     @Override  
11.     public void doFilter(ServletRequest request, ServletResponse response,  
12.             FilterChain chain) throws IOException, ServletException {  
13.         HttpServletRequest httpRequest = (HttpServletRequest) request;  
14.           
15.         Object user = httpRequest.getSession().getAttribute(  
16.                 Constants.User.LOGIN_USER);  
17.         if (user != null) {  
18.             Integer usr_id = (Integer) ReflectionUtils.invokeGetterMethod(user, "usrId");  
19.             String log_ip = request.getLocalAddr();  
20.             SimpleDateFormat format=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
21.             Date now=new Date(System.currentTimeMillis());  
22.             MDC.put("usr_id", usr_id);  
23.             MDC.put("log_title", "网站访问记录");  
24.             MDC.put("log_type", "记录");  
25.             MDC.put("log_title", "网站访问记录");  
26.             MDC.put("log_datetime", format.format(now));  
27.             MDC.put("log_ip", log_ip);  
28.             logger.info(MDC.getContext());  
29.         }  
30.          chain.doFilter(request, response);   
31.           
32.     }  
33.   
34.     @Override  
35.     public void init(FilterConfig filterConfig) throws ServletException {  
36.         logger=Logger.getLogger(UserLogFilter.class);  
37.           
38.     }  
39.       
40. }  

第二部：配置log4j.properties，输出到文件与数据库  

引用

#不懂的话，参考给出的第一个连接地址一样，j2EE项目详细控制 
log4j.logger.com.bhaman.yiyaosou.util.web=INFO,,project-util,project-util-db 
#project-util-web file appender 
log4j.appender.project-util=org.apache.log4j.DailyRollingFileAppender 
log4j.appender.project-util.file=${user.home}/logs/project-util.log 
log4j.appender.project-util.layout=org.apache.log4j.PatternLayout 
log4j.appender.project-util.threshold=INFO 
log4j.appender.project-util.layout.conversionPattern=%d [%X{usr_id}/%X{log_ip}/%X{req.id} - %X{entranceMethod} - %X{req.requestURIWithQueryString}] %-5p %c - %m%n 
log4j.appender.project-util-db=com.log4j.service.DBAppender 
log4j.appender.project-util-db.bufferSize=16 
log4j.appender.project-util-db.threshold=INFO 
#此处对应filter里面的MDC里面的键值对，你懂的 
log4j.appender.project-util-db.sql=insert into user_log (usr_id,log_title,log_category,log_type,log_datetime,log_ip) VALUES ('%X{usr_id}','%X{log_title}','%X{log_type}','%X{log_title}','%X{log_datetime}','%X{log_ip}') 

第三部：由于log4j里面给出的输出JDBCappender，是有问题的，首先面对业务需求，他是用JDBC，性能上问题很大，特别是现在这个应用。log4j支持自己写appender 
直接看JDBCAppender的源码  

如下里面提到有做了缓冲，两个ArrayList，一个来存东西，一个来控制清零后默认的缓冲大小不变，具体看源码，配置文件可以直接配置初始化大小  

Java代码  

1. <p>Each append call adds to an <code>ArrayList</code> buffer.  When  
2.   the buffer is filled each log event is placed in a sql statement  
3.   (configurable) and executed.  
4.   
5.   <b>BufferSize</b>, <b>db URL</b>, <b>User</b>, & <b>Password</b> are  
6.   configurable options in the standard log4j ways.  
7.   
8.   <p>The <code>setSql(String sql)</code> sets the SQL statement to be  
9.   used for logging -- this statement is sent to a  
10.   <code>PatternLayout</code> (either created automaticly by the  
11.   appender or added by the user).  Therefore by default all the  
12.   conversion patterns in <code>PatternLayout</code> can be used  
13.   inside of the statement.  (see the test cases for examples)  
14.  protected int bufferSize = 1;  
15.   
16.   /** 
17.    * ArrayList holding the buffer of Logging Events. 
18.    */  
19.   protected ArrayList buffer;  
20.   
21.   /** 
22.    * Helper object for clearing out the buffer 
23.    */  
24.   protected ArrayList removes;  

里面执行的sql，连接url 什么的就是配置文件里面配置，，会在调用的时候set进来 

Java代码  

1. protected String databaseURL = "jdbc:odbc:myDB";  
2.   
3.  /** 
4.   * User to connect as for default connection handling 
5.   */  
6.  protected String databaseUser = "me";  
7.   
8.  /** 
9.   * User to use for default connection handling 
10.   */  
11.  protected String databasePassword = "mypassword";  

那么我自己写的appender继承它就好了，直接使用它的缓冲及sql执行，那么唯一要变的就是连接了。 
我要从连接池里面取出，怎么做呢？看下面源码中注释-->>  

引用

   <li>Override <code>getConnection()</code> to pass any connection 
    you want.  Typically this is used to enable application wide 
    connection pooling. 

     <li>Override <code>closeConnection(Connection con)</code> -- if 
     you override getConnection make sure to implement 
     <code>closeConnection</code> to handle the connection you 
     generated.  Typically this would return the connection to the 
     pool it came from. 

     <li>Override <code>getLogStatement(LoggingEvent event)</code> to 
     produce specialized or dynamic statements. The default uses the 
     sql option value. 

我不需要覆写getLogStatement，我想改变的只是连接的获取方式罢了，如上分析后，直接写我的appender，里面用到了高效的BoneCP连接池，在spring里面本来是有配置这个的，但log4j是独立于spring的，是无法获取到，只能自己再来一份  

Java代码  

1. public class DBAppender extends org.apache.log4j.jdbc.JDBCAppender {  
2.     private BoneCP connectionPool = null;  
3.     private Connection connection = null;  
4.     private static Logger logger=Logger.getLogger(DBAppender.class);  
5.     public DBAppender() {  
6.         // 设置连接池配置信息  
7.         BoneCPConfig config = new BoneCPConfig();  
8.         PropetiesUtil p;  
9.       
10.         try {  
11.             Properties P = new Properties();  
12.             P.load(DBAppender.class.getClassLoader().getResourceAsStream("application.properties"));  
13.             // 数据库的JDBC URL  
14.             config.setJdbcUrl(P.getProperty("jdbc.url"));  
15.             // 数据库用户名  
16.             config.setUsername(P.getProperty("jdbc.username"));  
17.             // 数据库用户密码  
18.             config.setPassword(P.getProperty("jdbc.password"));  
19.             // 数据库连接池的最小连接数  
20.             config.setMinConnectionsPerPartition(5);  
21.             // 数据库连接池的最大连接数  
22.             config.setMaxConnectionsPerPartition(10);  
23.             config.setPartitionCount(1);  
24.             // 设置数据库连接池  
25.             connectionPool = new BoneCP(config);  
26.               
27.           
28.         } catch (SQLException e) {  
29.             // TODO Auto-generated catch block  
30.             logger.error("连接池配置加载异常",e);  
31.         } catch (IOException e) {  
32.             // TODO Auto-generated catch block  
33.             logger.error("加载配置文件IO异常",e);  
34.         }  
35.   
36.         // fetch a connection  
37.   
38.     }  
39.   
40.     @Override  
41.     protected Connection getConnection() throws SQLException {  
42.         if(connection==null||connection.isClosed()){  
43.             connection = connectionPool.getConnection();  
44.         }  
45.         return connection;  
46.     }  
47.   
48.     @Override  
49.     protected void closeConnection(Connection con) {  
50.         // TODO Auto-generated method stub  
51.         try {  
52.             connection.close();  
53.             connection=null;  
54.         } catch (SQLException e) {  
55.             // TODO Auto-generated catch block  
56.             logger.error("连接没正常关闭",e);  
57.         }  
58.     }  
59.   
60. }  

第四步：一切OK，然后就测试  

---

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.");  

参考资料：