log4j使用步骤有
3个:
默认的 Log4j initialization典型的应用是在 web-server 环境下。在 tomcat3.x和 tomcat4.x下,你应该将配置文件 Log4j.properties放在你的 web应用程序的 WEB-INF/classes 目录下。
Log4j将发现属性文件,并且以此初始化。这是使它工作的最容易的方法。
你也可以选择在运行 tomcat前设置系统属性 Log4j.configuration 。对于 tomcat 3.x, TOMCAT_OPTS 系统变量是用来设置命令行的选项。对于 tomcat4.0,用系统环境变量 CATALINA_OPTS 代替了 TOMCAT_OPTS。
UNIX 命令行
export TOMCAT_OPTS="-DLog4j.configuration=foobar.txt"
告诉 Log4j用文件 foobar.txt作为默认的配置文件。这个文件应该放在 WEB-INF/classes 目录下。这个文件将被 PropertyConfigurator所读。每个 web-application将用不同的默认配置文件,因为每个文件是和它的 web-application 相关的。
1. export TOMCAT_OPTS="-DLog4j.debug -DLog4j.configuration=foobar.xml" export TOMCAT_OPTS="-DLog4j.debug -DLog4j.configuration=foobar.xml"
告诉 Log4j输出 Log4j-internal的调试信息,并且用 foobar.xml作为默认的配置文件。这个文件应该放在你的 web-application的 WEB-INF/classes 目录下。因为有 .xml的扩展名,它将被 DOMConfigurator所读。每个 web-application将用不同的默认配置文件。因为每个文件都和它所在的 web-application 相关的。
2. set TOMCAT_OPTS=-DLog4j.configuration=foobar.lcf
-DLog4j.configuratorClass=com.foo.BarConfigurator
告诉 Log4j用文件 foobar.lcf作为默认的配置文件。这个文件应该放在你的 web-application的 WEB-INF/classes 目录下。因为定义了 Log4j.configuratorClass 系统属性,文件将用自定义的 com.foo.barconfigurator类来解析。每个 web-application将用不同的默认配置文件。因为每个文件都和它所在的 web-application 相关的。
3. set TOMCAT_OPTS=-DLog4j.configuration=file:/c:/foobar.lcf set TOMCAT_OPTS=-DLog4j.configuration=file:/c:/foobar.lcf
告诉 Log4j用文件 foobar.lcf作为默认的配置文件。这个配置文件用 URL file:/c:/foobar.lcf定义了全路径名。这样同样的配置文件将被所有的 web-application所用。
不同的 web-application将通过它们自己的类装载器来装载 Log4j。这样,每个 Log4j的环境将独立的运作,而没有任何的相互同步。例如:在多个 web-application中定义了完全相同的输出源的 FileAppenders将尝试写同样的文件。结果好象是缺乏安全性的。你必须确保每个不同的 web-application的 Log4j配置没有用到同样的系统资源。
用一个特别的 servlet来做 Log4j的初始化也是可以的。如下是一个例子:
public class Log4jInit extends HttpServlet {
public void init() {
String prefix = getServletContext().getRealPath("/");
String file = getInitParameter("Log4j-init-file");
if(file != null) {
PropertyConfigurator.configure(prefix+file);
}
}
public void doGet(HttpServletRequest req, HttpServletResponse res) {
}
}
在 web.xml中定义随后的 servlet为你的 web-application。
<servlet>
<servlet-name>Log4j-init</servlet-name>
<servlet-class>xx.xx.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>
写一个初始化的 servlet是最有弹性的初始化 Log4j的方法。代码中没有任何限制,你可以在 servlet的 init方法中定义它。
log4j可以使用 3中配置器来初始化: BasicConfigurator,DOMConfigurator,PropertyConfigurator
其语法为:
BasicConfigurator.configure (): 自动快速地使用缺省 Log4j环境。
PropertyConfigurator.configure ( String configFilename) :读取使用 Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) :读取 XML形式的配置文件。
这里用的是 PropertyConfigurator。使用 PropertyConfigurator适用于所有的系统。如下的语句:
PropertyConfigurator.configure("log4j.properties");
就以 log4j.properties为配置文件初始化好了 log4j环境。
注意一点:这个语句只需要在系统启动的时候执行一次。例如,在 ActionServlet的 init()方法中调用一次。
public class ActionServlet extends HttpServlet{
...
/**
* Initialize global variables
*/
public void init() throws ServletException {
// 初始化 Action资源
try{
initLog4j();
...
}catch(IOException e){
throw new ServletException("Load ActionRes is Error");
}
}
...
protected void initLog4j(){
PropertyConfigurator.configure("log4j.properties");
}
...
}//end class ActionServlet
使用 Log4j,首先就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:
public static Logger getLogger( String name),
通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。 Name一般取本类的名字,比如:
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ;
Log4j使得通过软件组件命名 logger很容易。我们可以通过 Logger的静态的初始化方法在每一个类里定义一个 logger,令 logger的名字等于类名的全局名,而实现 logger的命名。这是一个实效的简单的定义一个 logger的方法。因为日志输出带有产生日志的类的名字,这个命名策略使得我们更容易定位到一个日志信息的来源。虽然普通,但却是命名 logger的常用策略之一。
Log4j没有限制定义 logger的可能。开发员可以自由的按照它们的意愿定义 logger的名称。
然而,以类的所在位置来命名 Logger好象是目前已知的最好方法。
log.debug("it is the debug info");
3.1. 初始化
3.1.1. Tomcat下的初始化
默认的 Log4j initialization典型的应用是在 web-server 环境下。在 tomcat3.x和 tomcat4.x下,你应该将配置文件 Log4j.properties放在你的 web应用程序的 WEB-INF/classes 目录下。
Log4j将发现属性文件,并且以此初始化。这是使它工作的最容易的方法。
你也可以选择在运行 tomcat前设置系统属性 Log4j.configuration 。对于 tomcat 3.x, TOMCAT_OPTS 系统变量是用来设置命令行的选项。对于 tomcat4.0,用系统环境变量 CATALINA_OPTS 代替了 TOMCAT_OPTS。
UNIX 命令行
export TOMCAT_OPTS="-DLog4j.configuration=foobar.txt"
告诉 Log4j用文件 foobar.txt作为默认的配置文件。这个文件应该放在 WEB-INF/classes 目录下。这个文件将被 PropertyConfigurator所读。每个 web-application将用不同的默认配置文件,因为每个文件是和它的 web-application 相关的。
1. export TOMCAT_OPTS="-DLog4j.debug -DLog4j.configuration=foobar.xml" export TOMCAT_OPTS="-DLog4j.debug -DLog4j.configuration=foobar.xml"
告诉 Log4j输出 Log4j-internal的调试信息,并且用 foobar.xml作为默认的配置文件。这个文件应该放在你的 web-application的 WEB-INF/classes 目录下。因为有 .xml的扩展名,它将被 DOMConfigurator所读。每个 web-application将用不同的默认配置文件。因为每个文件都和它所在的 web-application 相关的。
2. set TOMCAT_OPTS=-DLog4j.configuration=foobar.lcf
-DLog4j.configuratorClass=com.foo.BarConfigurator
告诉 Log4j用文件 foobar.lcf作为默认的配置文件。这个文件应该放在你的 web-application的 WEB-INF/classes 目录下。因为定义了 Log4j.configuratorClass 系统属性,文件将用自定义的 com.foo.barconfigurator类来解析。每个 web-application将用不同的默认配置文件。因为每个文件都和它所在的 web-application 相关的。
3. set TOMCAT_OPTS=-DLog4j.configuration=file:/c:/foobar.lcf set TOMCAT_OPTS=-DLog4j.configuration=file:/c:/foobar.lcf
告诉 Log4j用文件 foobar.lcf作为默认的配置文件。这个配置文件用 URL file:/c:/foobar.lcf定义了全路径名。这样同样的配置文件将被所有的 web-application所用。
不同的 web-application将通过它们自己的类装载器来装载 Log4j。这样,每个 Log4j的环境将独立的运作,而没有任何的相互同步。例如:在多个 web-application中定义了完全相同的输出源的 FileAppenders将尝试写同样的文件。结果好象是缺乏安全性的。你必须确保每个不同的 web-application的 Log4j配置没有用到同样的系统资源。
3.1.2. Servlet 的初始化
用一个特别的 servlet来做 Log4j的初始化也是可以的。如下是一个例子:
public class Log4jInit extends HttpServlet {
public void init() {
String prefix = getServletContext().getRealPath("/");
String file = getInitParameter("Log4j-init-file");
if(file != null) {
PropertyConfigurator.configure(prefix+file);
}
}
public void doGet(HttpServletRequest req, HttpServletResponse res) {
}
}
在 web.xml中定义随后的 servlet为你的 web-application。
<servlet>
<servlet-name>Log4j-init</servlet-name>
<servlet-class>xx.xx.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>
写一个初始化的 servlet是最有弹性的初始化 Log4j的方法。代码中没有任何限制,你可以在 servlet的 init方法中定义它。
3.2. 根据配置文件初始化log4j
log4j可以使用 3中配置器来初始化: BasicConfigurator,DOMConfigurator,PropertyConfigurator
其语法为:
BasicConfigurator.configure (): 自动快速地使用缺省 Log4j环境。
PropertyConfigurator.configure ( String configFilename) :读取使用 Java的特性文件编写的配置文件。
DOMConfigurator.configure ( String filename ) :读取 XML形式的配置文件。
这里用的是 PropertyConfigurator。使用 PropertyConfigurator适用于所有的系统。如下的语句:
PropertyConfigurator.configure("log4j.properties");
就以 log4j.properties为配置文件初始化好了 log4j环境。
注意一点:这个语句只需要在系统启动的时候执行一次。例如,在 ActionServlet的 init()方法中调用一次。
public class ActionServlet extends HttpServlet{
...
/**
* Initialize global variables
*/
public void init() throws ServletException {
// 初始化 Action资源
try{
initLog4j();
...
}catch(IOException e){
throw new ServletException("Load ActionRes is Error");
}
}
...
protected void initLog4j(){
PropertyConfigurator.configure("log4j.properties");
}
...
}//end class ActionServlet
3.3. 在需要使用log4j的地方获取Logger实例
使用 Log4j,首先就是获取日志记录器,这个记录器将负责控制日志信息。其语法为:
public static Logger getLogger( String name),
通过指定的名字获得记录器,如果必要的话,则为这个名字创建一个新的记录器。 Name一般取本类的名字,比如:
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ;
Log4j使得通过软件组件命名 logger很容易。我们可以通过 Logger的静态的初始化方法在每一个类里定义一个 logger,令 logger的名字等于类名的全局名,而实现 logger的命名。这是一个实效的简单的定义一个 logger的方法。因为日志输出带有产生日志的类的名字,这个命名策略使得我们更容易定位到一个日志信息的来源。虽然普通,但却是命名 logger的常用策略之一。
Log4j没有限制定义 logger的可能。开发员可以自由的按照它们的意愿定义 logger的名称。
然而,以类的所在位置来命名 Logger好象是目前已知的最好方法。
3.4. 使用Logger对象的debug,info,fatal...方法
log.debug("it is the debug info");