在前邊的文章中對log4j的配置文件進行了說明,今天介紹如何在普通的javaWeb項目中使用log4j。
在日常的開發過程中,日志使用的很頻繁,我們可以利用日志來跟蹤程序的錯誤,程序運行時的輸出參數等,很多情況下可能會使用System.out.println()這個方法,但是還有一種更加簡潔的方式,那就是使用日志框架,今天就看看log4j這個日志框架如何在javaWeb的類中使用。
一、log4j的配置文件
我們要使用log4j必須要有log4j的配置文件,前面一篇文章提到,log4j的配置文件格式有兩種,一種是xml的,另一種是properties的,我更傾向於使用後者,這裡也使用後者。配置文件如下,
### set log levels ### log4j.rootLogger = info,stdout,D ##對com.mucfc包下的所有error級別日志進行輸出
log4j.logger.com.mucfc=error log4j.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.xml,
<?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" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5"> <display-name>Log4j</display-name> <welcome-file-list> <welcome-file>index.html</welcome-file> </welcome-file-list> <servlet> <servlet-name>Log4JTestServlet</servlet-name> <servlet-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的項目中使用。
歡迎指出不正之處
謝謝