Log4j日志的使用及配置文件

tyvincent

浏览: 7591 次
性别:
来自: 长沙

最近访客更多访客>>

yyi.mailer

博主相关

博客

微博

相册

留言

关于我

文章分类

全部博客 (9)

社区版块

存档分类

log4j Apache Servlet XML JDBC

其实日志的使用很简单，1.导入log4j包，2.定义配置文件，3.使用。使用的大致步骤：定义日志对象→读取配置文件→输出到日志。that all .

一、log4j的三个组成部分

Log4j由三个重要的组件构成：日志信息的优先级 priority，日志信息的输出目的地Appender，日志信息的输出格式（布局）layout。

1、日志的优先级

从低到高，依次有：DEBUG,INFO,WARN,ERROR,分别用来指定这条日志信息的重要程度；如果定义了了输入的级别为INFO，则只有等于及高于这个级别的才进行处理，此时将输入INFO,WARN,ERROR。值得注意的是，级别中还有两个关键字，

ALL:打印所有的日志，

OFF：关闭所有的日志输出。

2、输出端 Appender

log4j提供了以下几种常用的输出目的地：

org.apache.log4j.ConsoleAppender，将日志信息输出到控制台

org.apache.log4j.FileAppender，将日志信息输出到一个文件

org.apache.log4j.DailyRollingFileAppender，将日志信息输出到一个，并且每天输出到一个新的日志文件,

按照不同的配置可以定义每月一个日志文件，或者每周，每天，每小时，每分钟等输出一个新的日志文件。

org.apache.log4j.RollingFileAppender，将日志信息输出到一个文件，通过指定文件的的尺寸，当文件大小

到达指定尺寸的时候会自动把文件改名，如名为example.log的文件会改名为example.log.1，同时产生一个新的

example.log文件。如果新的文件再次达到指定尺寸，又会自动把文件改名为example.log.2，同时产生一个example.log

文件。依此类推，直到example.log. MaxBackupIndex，MaxBackupIndex的值可在配置文件中定义。

org.apache.log4j.WriterAppender，将日志信息以流格式发送到任意指定的地方。

org.apache.log4j.jdbc.JDBCAppender，通过JDBC把日志信息输出到数据库中。

org.apache.log4j.net.SMTPAppender,将日志信息以邮件的方式发送到指定的邮箱。

3、输出格式（布局）layout

通过appender可以控制输出的目的地，而如果要控制输出的格式，就可通过log4j的layout组件来实现。通过配

置文件定义一个appender的输出格式，Log4j提供的布局模式有以下几种：

org.apache.log4j.ConsoleAppender，输出到控制台

org.apache.log4j.HTMLLayout，以HTML表格形式布局

org.apache.log4j.PatternLayout，可以灵活地指定布局模式

org.apache.log4j.SimpleLayout，包含日志信息的级别和信息字符串

值得一提的是org.apache.log4j.PatternLayout 以Pattern方式的布局，使用Pattern的方式来指定布局。

pattern 的参数如下：ConversionPattern参数的格式含义

格式名含义

%c 输出日志信息所属的类的全名

%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy-MM-dd

HH:mm:ss }，输出类似：2002-10-18- 22：10：28 ;比如 %d{HH:mm:ss,SSS} 或 %d{dd MMM yyyy HH:mm:ss,SSS}.

格式可以参考 java类 SimpleDateFormat,不过按照此类的设置会影响速度。你可以选择更快的方式 %d{ISO8601},

%d{ABSOLUTE}, %d{RELATIVE}.或者使用log4j的ISO8601DateFormat, AbsoluteTimeDateFormat,

RelativeTimeDateFormat 和 DateTimeDateFormat 方式.

%f 输出日志信息所属的类的类名

%l 输出日志事件的发生位置，即输出日志信息的语句处于它所在的类的第几行

%m 输出代码中指定的信息，如log(message)中的message

%M 输出日志信息中所发生的方法名。

%n 输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n”

%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL。如果是调用debug()输出的，则为DEBUG，依此类推

%r 输出自应用启动到输出该日志信息所耗费的毫秒数

%t 输出产生该日志事件的线程名

二、配置文件

log4j支持两种方式的配置方式，.properties 二进制文件和xml文件的方式。

1 .以.properties文件的格式定义两种输出方式，一种是输出到文件中，另一种是输出到数据库中。

首先定义test.properties文件,文件定义如下：

#定义了两个输出端

log4j.rootLogger = INFO,f,db

# 定义f输出到文件,并且文件是随着大小而增加的

log4j.appender.f = org.apache.log4j.RollingFileAppender

log4j.appender.f.File = F:\\nepalon\\classes\\test.log

log4j.appender.f.MaxFileSize = 512KB

log4j.appender.f.MaxBackupIndex = 3

log4j.appender.f.layout = org.apache.log4j.PatternLayout

log4j.appender.f.layout.ConversionPattern = %d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n

#定义db输出到数据库

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

log4j.appender.db.BufferSize = 40

log4j.appender.db.Driver = com.microsoft.jdbc.sqlserver.SQLServerDriver

log4j.appender.db.URL = jdbc:microsoft:sqlserver://127.0.0.1:1433;DatabaseName=test

log4j.appender.db.User = sa

log4j.appender.db.Password =

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

log4j.appender.db.layout.ConversionPattern = INSERT INTO log4j (createDate, thread, priority,

category, message) values('%d{ISO8601}', '%t', '%-5p', '%c', '%m')

然后程序中将引用这配置文件。定义如下：

import org.apache.log4j.Logger;

import org.apache.log4j.PropertyConfigurator;

public class Test {

static Logger logger = Logger.getLogger(Test.class.getName());//定义日志对象

public static void main(String args[]) {

PropertyConfigurator.configure ( "test.properties" ) ; //以property方式读到配置文件。

logger.debug("DEBUG");//输出日志信息到日志

logger.info("INFO");

logger.warn("WARN");

logger.error(" ERROR");

logger.fatal(" FATAL");

}

2 .以xml配置

程序如下：

import org.apache.log4j.Logger;

import org.apache.log4j.xml.DOMConfigurator;

public class Test {

static Logger logger = Logger.getLogger(Test.class.getName());//定义日志对象

public static void main(String args[]) {

DOMConfigurator.configure("log4jconfig.xml");//以XML方式读到配置文件。

logger.debug(" DEBUG");//输出日志信息到日志

logger.info(" INFO");

logger.warn(" WARN");

logger.error(" ERROR");

logger.fatal(" FATAL");

}

log4jconfig.xml 如下：

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

</layout>

</appender>

<root>

<appender-ref ref="appender"/>

</root>

</log4j:configuration>

对比properties方式和xml方式，可以看出他们程序中，除了定义读取配置文件的方式不同外,其它的根本就没

有区别了，这也就是log4j的魅力所在了，不需要改变程序，只需要通过改变定义的配置文件，我们就可以控制日志的输出方式，是否输出，输出格式。我们可以通过定义不同的xml文件来控制输出方式.

三、应用中的使用步骤

1.在工程中导入log4j-1.2.14.jar包

2.在src包下面新建log4j的配置文件，.properties或者.xml文件。

3.使用步骤

     3.1.在应用程序中的使用方法：

    a.获取Logger实例：static Logger logger = Logger.getLogger(TestLog4j.class);

    b.读取配置文件：

        PropertyConfigurator.configure ( "test.properties" ) ; //以property方式读到配置文件。

        DOMConfigurator.configure("log4jconfig.xml");//以XML方式读到配置文件。

    c.写日至：

         logger.debug(" DEBUG");//输出日志信息到日志

         logger.info(" INFO");

         logger.warn(" WARN");

         logger.error(" ERROR");

         logger.fatal(" FATAL");

3.2.在web应用中的使用方法

    应该在哪儿对Log4J进行配置呢？首先要明确，Log4J必须在应用的其它代码执行前完成初始化。因为Servlet是在Web服务器启动时立即装入的，所以，在Web应用中一般使用一个专门的Servlet来完成Log4J的配置，并保证在web.xml的配置中，这个Servlet位于其它Servlet之前。下面是一个例子，代码如下：

A、初始化配置的servlet

package com.foo;

import org.apache.log4j.PropertyConfigurator;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import java.io.PrintWriter;

import java.io.IOException;

public class Log4jInit extends HttpServlet {

public void init() {

    String prefix = getServletContext().getRealPath("/");

    String file = getInitParameter("log4j-init-file");

    // if the log4j-init-file is not set, then no point in trying

    if(file != null) {

      PropertyConfigurator.configure(prefix+file);

    }

}

public void doGet(HttpServletRequest req, HttpServletResponse res) {

}

}

B、在你的web应用程序的web.xml文件中定义下面servlet

<servlet>

    <servlet-name>log4j-init</servlet-name>

    <servlet-class>com.foo.Log4jInit</servlet-class>

    <init-param>

      <param-name>log4j-init-file</param-name>

      <param-value>WEB-INF/classes/log4j.properties</param-value>

    </init-param>

    <load-on-startup>1</load-on-startup>

</servlet>

C、在需要使用log4j的地方获取Logger实例

    static Logger log = Logger.getLogger(TestLog4j.class);

D、写日至：

         logger.debug(" DEBUG");//输出日志信息到日志

         logger.info(" INFO");

         logger.warn(" WARN");

         logger.error(" ERROR");

         logger.fatal(" FATAL");