Log4j写入数据库详解

Log4j写入数据库详解

 log4j是一个优秀的开源日志记录项目，我们不仅可以对输出的日志的格式自定义，还可以自己定义日志输出的目的地，比如：屏幕，文本文件，数据库，甚至能通过socket输出。本节主要讲述如何将日志信息输入到数据库（可以插入任何数据库，在此主要以MSSQL为例进行详解）。
用log4j将日志写入数据库主要用到是log4j包下的JDBCAppender类，它提供了将日志信息异步写入数据的功能，我们可以直接使用这个类将我们的日志信息写入数据库；也可以扩展JDBCAppender类，就是将JDBCAppender类作为基类。下面将通过一个实例来讲解log4j是如何将日志信息写入数据库的。
我们的需求：我们在软件开发的过程中需要将调试信息、操作信息等记录下来，以便后面的审计，这些日志信息包括用户ID、用户姓名、操作类、路径、方法、操作时间、日志信息。
设计思想：我们采用JDBCAppender类直接将日志信息插入数据库，所有只需要在配置文件配置此类就可以;要获得用户信息需要用过滤器来实现；（假如不需要用户的信息，就不需要设计过滤器，其实大部分情况下都是需要这些用户信息，尤其是在web应用开发中）在日志信息中获得用户信息，就的通过过滤器的request或session对象，从session中拿到用户信息怎样传到log4j呢，log4j为我们提供了MDC（MDC是log4j种非常有用类，它们用于存储应用程序的上下文信息（context infomation），从而便于在log中使用这些上下文信息。MDC内部使用了类似map的机制来存储信息，上下文信息也是每个线程独立地储存，所不同的是信息都是以它们的key值存储在”map”中。相对应的方法，

MDC.put(key, value); MDC.remove(key); MDC.get(key); 

在配置PatternLayout的时候使用：%x{key}来输出对应的value）。有了MDC，我们可以在过滤器中先获得用户信息，再用MDC.Put（“key”）方法，log在执行sql语句时通过%x{key}来输出对应的value。

实现步骤：
1、在你的项目中要确保有log4j和commons-logging这两个jar文件；
2、设置要你要插入日志信息的表结构

1 if exists (select * from dbo.sysobjects where id = object_id(N'[dbo].[WDZLOG]') and OBJECTPROPERTY(id, N'IsUserTable') = 1)  

2 drop table [dbo].[WDZLOG]  

3 GO  

4   

5 CREATE TABLE [dbo].[WDZLOG] (  

6     [WDZLOGID] [int] IDENTITY (1, 1) NOT NULL ,  

7     [LogName] [varchar] (255) COLLATE Chinese_PRC_CI_AS NULL ,//用户ID   

8     [UserName] [varchar] (255) COLLATE Chinese_PRC_CI_AS NULL ,//用户姓名   

9     [Class] [varchar] (255) COLLATE Chinese_PRC_CI_AS NULL ,//类名   

10     [Mothod] [varchar] (255) COLLATE Chinese_PRC_CI_AS NULL //,方法名   

11     [CreateTime] [varchar] (255) COLLATE Chinese_PRC_CI_AS NULL ,//产生时间   

12     [LogLevel] [varchar] (20) COLLATE Chinese_PRC_CI_AS NULL ,//日志级别   

13     [MSG] [varchar] (555) COLLATE Chinese_PRC_CI_AS NULL //日志信息   

14 ) ON [PRIMARY]  

15 GO  

 

3、配置文件（摘自我们的项目）后面将对此配置文件进行详细讲解，它也log4j的核心部分。

16 log4j.properties  

17 log4j.rootLogger=INFO,stdout  

18               

19 log4j.logger.org.springframework.web.servlet=INFO,db  

20   

21 log4j.logger.org.springframework.beans.factory.xml=INFO  

22 log4j.logger.com.neam.stum.user=INFO,db  

23   

24 log4j.appender.stdout=org.apache.log4j.ConsoleAppender  

25 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout  

26 log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %p [%c] - - <%m>%n  

27   

28 log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender  

29 log4j.appender.logfile.File=${webapp.root}/WEB-INF/logs/exppower.log  

30 log4j.appender.logfile.DatePattern=.yyyy-MM-dd  

31 log4j.appender.logfile.layout=org.apache.log4j.PatternLayout  

32 log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] wang- <%m>%n  

33  

34 ########################  

35  

36 # JDBC Appender  

37  

38 #######################  

39  

40  

41 #log4j.logger.business=INFO,db  

42 #log4j.appender.db=com.neam.commons.MyJDBCAppender   

43 log4j.appender.db=JDBCExtAppender  

44   

45 log4j.appender.db.BufferSize=10  

46   

47 log4j.appender.db.sqlname=log  

48   

49 log4j.appender.db.driver=net.sourceforge.jtds.jdbc.Driver  

50                         

51 log4j.appender.db.URL=jdbc:jtds:SqlServer://localhost:1433;DatabaseName=pubs   

52   

53 log4j.appender.db.user=sa  

54   

55 log4j.appender.db.password=sa  

56   

57 log4j.appender.db.sql=insert into WDZLOG (LogName,UserName,Class,Mothod,createTime,LogLevel,MSG) values ('%X{userId}','%X{userName}','%C','%M','%d{yyyy-MM-dd HH:mm:ss}','%p','%m')  

58   

59 log4j.appender.db.layout=org.apache.log4j.PatternLayout  

 

4、编写过滤器（ResFilter.java）

60 import java.io.IOException;  

61 import javax.servlet.Filter;  

62 import javax.servlet.FilterChain;  

63 import javax.servlet.FilterConfig;  

64 import javax.servlet.ServletException;  

65 import javax.servlet.ServletRequest;  

66 import javax.servlet.ServletResponse;  

67 import javax.servlet.http.HttpServletRequest;  

68 import javax.servlet.http.HttpSession;  

69   

70 import org.apache.log4j.Logger;  

71 import org.apache.log4j.MDC;  

72   

73 import com.neam.domain.User;  

74   

75 public class ResFilter implements Filter{  

76   

77        

78     private final static double DEFAULT_USERID= Math.random()*100000.0;    

79   

80     public void destroy() {  

81     }  

82   

83     public void doFilter(ServletRequest request, ServletResponse response,  

84            FilterChain chain) throws IOException, ServletException {  

85        HttpServletRequest req=(HttpServletRequest)request;  

86         HttpSession session= req.getSession();  

87         if (session==null){  

88             MDC.put("userId",DEFAULT_USERID);    

89         }  

90         else{  

91             User customer=(User)session.getAttribute("user");  

92             if (customer==null){  

93                 MDC.put("userId",DEFAULT_USERID);  

94                 MDC.put("userName",DEFAULT_USERID);  

95             }  

96             else  

97             {  

98                 MDC.put("userId",customer.getName());  

99                 MDC.put("userName",customer.getName());  

100             }  

101         }  

102         //logger.info("test for MDC.");   

103   

104        chain.doFilter(request, response);  

105     }  

106     public void init(FilterConfig Config) throws ServletException {  

107 //     this.filterConfig = Config;   

108 //     String ccc = Config.getServletContext().getInitParameter("cherset");   

109 //     this.targetEncoding = Config.getInitParameter("cherset");   

110   

111     }  

112 }  

 

5、在需要写入日志的地方引入

 

113 private Log logger = LogFactory.getLog(this.getClass());  

114   

115 在具体方法中就可以写入日志  

116 logger.info("");  

117 logger.debug("");  

118 logger.warn("");  

119 logger.error("");  

 

 

 

配置文件详解：
log4j.properties
log4j.properties
log4j.rootLogger=INFO,stdout

//配置根Logger，其语法为：
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
level : 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。
appenderName:就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。
例如：log4j.rootLogger＝info,A1,B2,C3 配置了3个输出地方我们可以设置让A1在控制台输出；B2生产日志文件；C3让日志信息插入数据库中。
本例中是将所有的日志信息在控制台打印出来。
log4j.logger.org.springframework.web.servlet=INFO,db
//设置将spring下包的某些类的日志信息写入数据库中，并且在控制台上打印出来。（是通过log4j.rootLogger=INFO,stdout来体现的）db是将日志信息写入数据库中
log4j.logger.org.springframework.beans.factory.xml=INFO
//本实例中为了让某些包下的日志信息能写入数据库
log4j.logger.com.neam.stum.user=INFO,db
//设置自己某个模块下的日志信息既在控制台上打印而且往数据库中保存

//下面是配置在控制台上打印日志信息，在这里就不再仔细描述了
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %p [%c] - - <%m>%n

//下面是配置将日志信息写入文件中，在这里也就不再仔细描述了
log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.logfile.File=${webapp.root}/WEB-INF/logs/exppower.log
log4j.appender.logfile.DatePattern=.yyyy-MM-dd
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] wang- <%m>%n

########################

# JDBC Appender

#######################


#log4j.appender.db=com.neam.commons.MyJDBCAppender
//下面是配置将日志信息插入数据库，
log4j.appender.db=org.apache.log4j.jdbc.JDBCAppender
//配置输出目标为数据库（假如要将日志在控制台输出，配置为log4j.appender. stdout =org.apache.log4j.ConsoleAppender；将日志写入文件，配置为log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender
这样的配置在许多地方都要有，需要可查有关资料）,当然你也可以自己扩展org.apache.log4j.jdbc.JDBCAppender这个类，只需要在这里配置就可以了例如我们配置我自己扩展的MyJDBCAppender，配置为#log4j.appender.db=com.neam.commons.MyJDBCAppender

log4j.appender.db.BufferSize=10
//设置缓存大小，就是当有10条日志信息是才忘数据库插一次

log4j.appender.db.driver=net.sourceforge.jtds.jdbc.Driver
//设置要将日志插入到数据库的驱动                    
log4j.appender.db.URL=jdbc:jtds:SqlServer://localhost:1433;DatabaseName=pubs

log4j.appender.db.user=sa

log4j.appender.db.password=sa

log4j.appender.db.sql=insert into WDZLOG (LogName,UserName,Class,Mothod,createTime,LogLevel,MSG) values ('%X{userId}','%X{userName}','%C','%M','%d{yyyy-MM-dd HH:mm:ss}','%p','%m')
//设置要插入日志信息的格式和内容，%X{userId}是置取MDC中的key值，因为我们在过滤器中是将用户id和用户姓名放入MDC中，所有在这里可以用%X{userId}和%X{userName}取出用户的ID和用户姓名；'%C'表示日志信息是来自于那个类；%M表示日志信息来自于那个方法中；%d{yyyy-MM-dd HH:mm:ss}表示日志信息产生的时间，{yyyy-MM-dd HH:mm:ss}表示一种时间格式，你也可以直接写成%d；%p表示日志信息的级别（debug info warn error）；
%m表示你写入的日志信息
log4j.appender.db.layout=org.apache.log4j.PatternLayout

 

<!--EndFragment-->