原文:http://www.codejava.net/coding/how-to-initialize-log4j-for-java-web-application
通常,对于Java Web应用程序,我们可以将log4j.properties文件或log4j.xml文件放在类路径(WEB-INF \ classes目录)的根目录下,在servlet类中立即使用log4j,如下所示:
Logger logger = Logger.getLogger(MyServlet.class);
logger.debug("this is a debug log message");
但是,如果将log4j配置文件放在另一个位置而不是类路径的根目录下呢?在这种情况下,我们需要明确地初始化log4j:
String log4jConfigFile = "some/path/log4j.properties";
PropertyConfigurator.configure(log4jConfigFile);
但是,当应用程序启动时,这个初始化代码只能执行一次。为此,建议声明ServletContextListener接口的实现,以监听在应用程序启动时发生的contextInitialized()事件,然后再提供客户端的请求。例如:
public class ContextListener implements ServletContextListener {
@Override
public void contextInitialized(ServletContextEvent event) {
// code to initialize log4j here...
}
}
以下是在Java Web应用程序中初始化和使用log4j的步骤:
1.创建log4j属性文件
创建一个名为log4j.properties的log4j配置文件,其中包含以下内容:
# LOG4J configuration
log4j.rootLogger=DEBUG, Appender1,Appender2
log4j.appender.Appender1=org.apache.log4j.ConsoleAppender
log4j.appender.Appender1.layout=org.apache.log4j.PatternLayout
log4j.appender.Appender1.layout.ConversionPattern=%-7p %d [%t] %c %x - %m%n
log4j.appender.Appender2=org.apache.log4j.FileAppender
log4j.appender.Appender2.File=D:/Logs/Log4jWebDemo.log
log4j.appender.Appender2.layout=org.apache.log4j.PatternLayout
log4j.appender.Appender2.layout.ConversionPattern=%-7p %d [%t] %c %x - %m%n
此配置基本上创建两个appender:第一个用于控制台日志记录,第二个用于文件记录(日志文件将在D:/Logs/Log4jWebDemo.log下创建)。
将log4j.properties文件放在Web应用程序的WEB-INF目录下。
2.在web.xml中配置log4j属性文件的位置
还建议通过web.xml文件配置log4j.properties文件的位置,如下所示:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
id="WebApp_ID" version="3.0">
<display-name>Log4jWebDemo1</display-name>
<context-param>
<param-name>log4j-config-location</param-name>
<param-value>WEB-INF/log4j.properties</param-value>
</context-param>
</web-app>
这里我们在WEB-INF目录下配置log4j.properties文件。
3.实现ServletContextListener接口
创建一个使用以下代码实现ServletContextListener接口的ContextListener类:
package net.codejava.servlet;
import java.io.File;
import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
import org.apache.log4j.PropertyConfigurator;
@WebListener("application context listener")
public class ContextListener implements ServletContextListener {
/**
* Initialize log4j when the application is being started
*/
@Override
public void contextInitialized(ServletContextEvent event) {
// initialize log4j here
ServletContext context = event.getServletContext();
String log4jConfigFile = context.getInitParameter("log4j-config-location");
String fullPath = context.getRealPath("") + File.separator + log4jConfigFile;
PropertyConfigurator.configure(fullPath);
}
@Override
public void contextDestroyed(ServletContextEvent event) {
// do nothing
}
}
在contextInitialized()方法中,我们读取log4j属性文件的位置,并构造一个完整的绝对路径,然后传递给PropertyConfigurator类的静态configure()方法。这就是log4j用给定的属性文件初始化。
请注意,@WebListener注释(Servlet 3.0)放置在类声明之前,以告知servlet容器将此类注册为侦听器。如果您使用Servlet 2.5,请在web.xml文件中使用以下等效的XML :
<listener>
<listener-class>net.codejava.servlet.ContextListener</listener-class>
</listener>
4.写一个测试servlet
现在创建一个简单的servlet来测试log4j。创建一个包含以下内容的TestLog4jServlet.java类:
package net.codejava.servlet;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.log4j.Logger;
@WebServlet("/test")
public class TestLog4jServlet extends HttpServlet {
static final Logger LOGGER = Logger.getLogger(TestLog4jServlet.class);
protected void doGet(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
LOGGER.info("This is a logging statement from log4j");
String html = "<html><h2>Log4j has been initialized successfully!</h2></html>";
response.getWriter().println(html);
}
}
这个servlet只是将一个日志条目写入记录器,并向客户端发送一个简短的HTML文本。
由于我们使用@WebServlet注解(Servlet 3.0),因此无需在web.xml文件中配置此servlet 。如果您使用Servlet 2.5,请将以下XML代码段添加到web.xml文件中:
<servlet>
<display-name>TestServlet</display-name>
<servlet-name>TestServlet</servlet-name>
<servlet-class>net.codejava.servlet.TestLog4jServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>TestServlet</servlet-name>
<url-pattern>/test</url-pattern>
</servlet-mapping>
5.测试应用程序
如果您在Eclipse IDE中执行了上述步骤,您将具有以下项目结构:
记住在WEB-INF \ lib目录下添加log4j的库jar文件(可以在这里下载log4j ),并创建一个目录D:/ Logs,其中将创建一个日志文件(在log4j.properties文件中配置)。
在Tomcat等servlet容器上部署应用程序,在浏览器的地址栏中输入以下URL来测试servlet和log4j:
HTTP://本地主机:8080 / Log4jWebDemo1 /测试
在浏览器中输出:
看看服务器的控制台日志,我们将看到一个log4j样式的日志条目,如下所示:
并检查Log4jWebDemo.log文件将在D:/ Logs目录下创建(您应该首先创建此目录)。