log4j日志存储到数据库

转载：http://blog.csdn.net/zhangchu_63/article/details/5542100 

昨天公司说要在系统中添加日志查询统计功能，刚开始第一个念头就是用IO流读取日志文件，然后持久化，最后在系统中查询。结果看了一些LOG4J的说明文档后发现，原来LOG4J本身就有将日志信息存入数据库功能，这样就大大节省了开发的时间，半天搞定。现在把方法记录下来，希望对有需要的朋友有所帮助。

 

一、前提条件

      系统必须是使用LOG4J进行日志管理，否则方法无效。

      系统必须包含commons-logging-xxx.jar，log4j-xxx.jar这两个JAR包，XXX为版本号。

 

二、操作步骤

      1、创建日志表

           要把日志持久化，必须在数据库中创建一张用来存储日志信息的表，表内字段为日志

     的一个主要属性包括：操作类，执行方法，打印时间，日志级别，日志内容。

           CREATE TABLE RESLOG (LOGID VARCHAR2(20) NOT NULL,

                                                 CLASS VARCHAR2(200),

                                                 METHOD VARCHAR2(100),

                                                 CREATETIME DATE,

                                                 LOGLEVEL VARCHAR2(50),

                                                 MSG VARCHAR2(4000))

           因为存储的类为类的全部路径，所以CLASS字段长度需要比较大。

       2、日志管理配置

            LOG4J主要有两种配置文件.properties和.xml，这里以properties文件为基础来讲

      述，关于XML文件的配置，相信大家看完下面的介绍也一样能轻松完成。

            通常在LOG4J.PROPERTIES文件的第一行是：

            log4j.rootLogger= XXX，这句是控制日志的输出，如果想吧日志输出到数据库，

      则需要在XXX中添加“DB”，如log4j.rootLogger=INFO,stdout,Platform,db。上面

      这句就是把日志中级别为INFO的信息输出到STDOUT,PLATFORM和DB

    （DATABASE）中。

            配置好如上的信息，LOG4J就知道用户是想把信息存入数据库，接下来我们就要来

      配置数据库的相关信息（包括缓存，数据库连接信息，和执行SQL），配置信息如下：

            ###JDBCAppender
            log4j.appender.db = org.apache.log4j.jdbc.JDBCAppender

            //这个配置是选择使用JDBCAppender方法，将日志信息存储到数据库。当然，如果你还要做其他操作，可以自己写个类，继承JDBCAppender就OK了。
            log4j.appender.db.BufferSize=1

            //这个配置是告诉LOG4J，有多少条日志信息后才存入数据库，我这里是1,就是说有一条就查一条，显然这样在生产环境下是很影响系统性能的。
            log4j.appender.db.driver=oracle.jdbc.driver.OracleDriver

            //这个配置是告诉LOG4J，做数据库存储所用的驱动。
            log4j.appender.db.URL=jdbc:oracle:thin:@<ip>:<port>:<sid>

            //这个配置数据库连接的URL，不用说也都知道。
            log4j.appender.db.user=XXX
            log4j.appender.db.password=XXX

            //上面两个是数据库连接时的用户名和密码
            log4j.appender.db.sql=insert into RESLOG

                  (LogId,Class,Method,createTime,LogLevel,MSG)

                  values (SQ_RESLOG_LOGID.Nextval,\'%C\',\'%M\',

                  to_date(\'%d{yyyy-MM-dd HH:mm:ss}\',\'yyyy-MM-dd

                  HH24:mi:ss\'),\'%p\',\'%m\')

            //这个配置是告诉当LOG4J吧日志存储数据库时用的SQL语句。SQ_RESLOG_LOGID.Nextval是我建的一个SEQUENCE；‘%C’是日志中的CLASS；‘%M’是打印日志是执行到类里的方法；‘%d’是打印的时间，它支持格式化；‘%P’是日志级别，包括INFO、DEBUG、ERROR等；‘%m’是MSG，日志内容。注意这里的参数区分大小写。
            log4j.appender.db.layout=org.apache.log4j.PatternLayout

 

        通过上面的配置，现在再启动服务，LOG4J就会自动把原来存储在.LOG文件中的信息，同时存储到数据库了。

        当然，LOG4J还支持自定义参数，在日志信息中获得用户信息，就的通过过滤器的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。

编写过滤器：

import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

import org.apache.log4j.Logger;
import org.apache.log4j.MDC;

import com.neam.domain.User;

public class ResFilter implements Filter{

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

    public void destroy() {
    }

    public void doFilter(ServletRequest request, ServletResponse response,
           FilterChain chain) throws IOException, ServletException {
       HttpServletRequest req=(HttpServletRequest)request;
        HttpSession session= req.getSession();
        if (session==null){
            MDC.put("userId",DEFAULT_USERID);  
        }
        else{
            User customer=(User)session.getAttribute("user");
            if (customer==null){
                MDC.put("userId",DEFAULT_USERID);
                MDC.put("userName",DEFAULT_USERID);
            }
            else
            {
                MDC.put("userId",customer.getName());
                MDC.put("userName",customer.getName());
            }
        }
        //logger.info("test for MDC.");

       chain.doFilter(request, response);
    }
    public void init(FilterConfig Config) throws ServletException {
//     this.filterConfig = Config;
//     String ccc = Config.getServletContext().getInitParameter("cherset");
//     this.targetEncoding = Config.getInitParameter("cherset");

    }
}

 

 

 

如果系统中的部分组件打印信息中包含"\'"（单引号），系统会报“确实逗号”的错误，搞了半天也解决不了，还好打印的都是INFO，把打印级别设为“WARN”就OK了