你的位置:首页 > Java教程

[Java教程]log4j在javaWeb项目中的使用


在前边的文章中对log4j的配置文件进行了说明,今天介绍如何在普通的javaWeb项目中使用log4j。

在日常的开发过程中,日志使用的很频繁,我们可以利用日志来跟踪程序的错误,程序运行时的输出参数等,很多情况下可能会使用System.out.println()这个方法,但是还有一种更加简洁的方式,那就是使用日志框架,今天就看看log4j这个日志框架如何在javaWeb的类中使用。

一、log4j的配置文件

我们要使用log4j必须要有log4j的配置文件,前面一篇文章提到,log4j的配置文件格式有两种,一种是

### set log levels ### log4j.rootLogger = info,stdout,D ##对com.mucfc包下的所有error级别日志进行输出
log4j.logger.com.mucfc=errorlog4j.appender.stdout = org.apache.log4j.ConsoleAppender log4j.appender.stdout.Target = System.out log4j.appender.stdout.layout = org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n log4j.appender.D = org.apache.log4j.DailyRollingFileAppender log4j.appender.D.File = F://logs/log.log log4j.appender.D.Append = false log4j.appender.D.Threshold = DEBUG log4j.appender.D.layout = org.apache.log4j.PatternLayout log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n


从上边的配置文件可以看到对整个项目来说,日志界别为info,单独对com.mucfc包配置了error级别,输出目的地有两种:stdout(控制台)、D(文件,输出日志最低级别为debug),也就是说如果在类中有logger.debug()、logger.info()、logger.warn()、logger.error()这样的方法都会输出,详见下边。

二、初始化log4j配置文件

上边第一步我们配置了log4j配置文件,下边就是初始化log4j。我们这里建的是普通的javaWeb项目,且没有用任何的框架(如,spring,和spring的结合放在下篇中说明),那么我们要如何在项目刚启动就加载配置文件呢?我们知道在web项目中有Filter、listener他们都会在项目启动时进行初始化,Filter是过滤的在这里不适合,listener是监听,这里可以使用listener,另外还有一个用的比较多的,那就是servlet,这个东西我们在开发中用的很多,且可以指定初始化顺序,这里便使用servlet,且指定初始化顺序为1,

package com.mucfc; import java.io.File;import java.io.IOException;import javax.servlet.Servlet;import javax.servlet.ServletConfig;import javax.servlet.ServletContext;import javax.servlet.ServletException;import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import org.apache.log4j.BasicConfigurator;import org.apache.log4j.PropertyConfigurator;/** * Servlet implementation class Log4JInitServlet */ public class Log4JInitServlet extends HttpServlet {   private static final long serialVersionUID = 1L;   /**   * @see HttpServlet#HttpServlet()   */   public Log4JInitServlet() {     super();     // TODO Auto-generated constructor stub   }   /**   * @see Servlet#init(ServletConfig)   */   public void init(ServletConfig config) throws ServletException {                 System.out.println("Log4JInitServlet 正在初始化 log4j日志设置信息");     String log4jLocation = config.getInitParameter("log4j-properties-location");     ServletContext sc = config.getServletContext();         String str= (String)sc.getInitParameter("test");    System.out.println("str:"+str);    if (log4jLocation == null) {       System.err.println("*** 没有 log4j-properties-location 初始化的文件, 所以使用 BasicConfigurator初始化");       BasicConfigurator.configure();     } else {       String webAppPath = sc.getRealPath("/");       String log4jProp = webAppPath + log4jLocation;       File yoMamaYesThisSaysYoMama = new File(log4jProp);       if (yoMamaYesThisSaysYoMama.exists()) {         System.out.println("使用: " + log4jProp+"初始化日志设置信息");         PropertyConfigurator.configure(log4jProp);       } else {         System.err.println("*** " + log4jProp + " 文件没有找到, 所以使用 BasicConfigurator初始化");         BasicConfigurator.configure();       }     }     super.init(config);   }   /**   * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)   */   protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {     // TODO Auto-generated method stub   }   /**   * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)   */   protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {     // TODO Auto-generated method stub   } }

从上面可以看出,此servlet会从servlet的初始化参数中读取log4j的路径,然后使用PropertyConfigurator.configure(log4jProp); 进行初始化,下面是web.

<?class>com.mucfc.Log4JTestServlet</servlet-class> </servlet> <servlet>  <servlet-name>Log4JInitServlet</servlet-name>  <servlet-class>com.mucfc.Log4JInitServlet</servlet-class>  <init-param>   <param-name>log4j-properties-location</param-name>   <param-value>log4j.properties</param-value>  </init-param>  <load-on-startup>1</load-on-startup> </servlet></web-app>

使用了log4j-properties-location参数名,配置的值为log4j.properties,我把配置文件放在了web-cotent下,即根路径下,

三、测试

我这里测试使用的是servlet,在请求servlet时调用log4j的日志输出功能,

package com.test;import java.io.IOException;import javax.servlet.ServletException;import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import org.apache.log4j.Logger;/** * Servlet implementation class MyFirstTest */public class MyFirstTest extends HttpServlet {  private static final long serialVersionUID = 1L;      private Logger logger=Logger.getLogger(this.getClass());        /**   * @see HttpServlet#HttpServlet()   */  public MyFirstTest() {    super();    // TODO Auto-generated constructor stub  }  /**   * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)   */  protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {    // TODO Auto-generated method stub        doPost(request,response);  }  /**   * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)   */  protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {    // TODO Auto-generated method stub        logger.info("this is my info message");    logger.debug("this is my debug message");    logger.warn("this is my warn message");    logger.error("this is my error message");      }}

首先得到一个日志对象logger,使用的是,Logger logger=Logger.getLogger(this.getClass()),然后调用了debug()、info()、warn()、error()方法,对日志进行了打印,根据配置文件,会打印出相应日志,我们这里整个项目的日志级别定义的为info,则,info()、warn()、error()这三个方法的内容会打印在控制台。

综上所述就是在普通的javaWeb项目中使用log4j,下一篇会说明如何在spring的项目中使用。

欢迎指出不正之处

谢谢