Logj使用完全手册

1、Log4J使用完全手册Log4J是Apache的一个开放源代码项目()，它是一个日志操作包。通过使用Log4J,可以指定日志信息输出的目的地，控制每一条日志的输出格式，定义日志信息的级别。所有这些功能通过一个配置文件灵活进行配置。一、LOG4J组成    LOG4J主要由三大组件组成：    . Logger: 决定什么日志信息应该被输出、什么日志信息应该被忽略；    . Appender: 指定日志信息应该输出到什么地方, 这些地方可以是控制台、文件、网络设备；    .

2、 Layout: 指定日志信息的输出格式；    一个Logger可以有多个Appender，也就是说日志信息可以同时输出到多个设备上，每个Appender对应    一种Layout(示例见下图)。                Appender1    Layout          

3、    Logger                      Appender2    Layout二、Logger组件    1. Logger组件提供的方法： java 代码1. package2.   3. public class Logger   

4、 4.   5.            / Creation & retrieval methods:   6.            public static Logger getRootLogger();   7.

5、           public static Logger getLogger(String name);   8.   9.            / printing methods:   10.    

6、0;       public void debug(Object message);   11.            public void info(Object message);   12.           

7、; public void warn(Object message);   13.            public void error(Object message);   14.            public void fatal(Ob

8、ject message);   15.       16.            / generic printing method:   17.            public void log(Priority

9、 p, Object message);   18.       2. 在配置文件中配置Logger组件       可在Log4J配置文件中配置自己的Logger组件，示例：       以上代码定义了一个Logger组件，名称为myLogger，日志级别为WARN。      3. 日志级别种类：  &#

10、160;    一共有五种，级别由高到低依次是：fatal、error、warn、info、debug。获得Logger实例后，我们可调用以下方法之一输出日志信息：       public void debug(Object message);          /输出debug级别的日志信息；       public void info(Object

11、message);           /输出info级别的日志信息；       public void warn(Object message);           /输出warn级别的日志信息；       public void error(Object message

12、);          /输出error级别的日志信息；       public void fatal(Object message);          /输出fatal级别的日志信息；       public void log(Priority p, Object message);/输出参

13、数Priority指定级别的日志信息；       以上方法只有当它的级别大于或等于Logger组件配置的日志级别时才调用。以前面我们配置的myLogger为例，它的日志级别为WARN, 那么在程序中，它的warn()、error()、fatal()方法会被执行。对于log()方法，只有当它的参数Priority指定的日志级别大于或等于WARN时，它才会被执行。    4. 为什么需要对日志进行分级？         

14、;  在写程序的时候，为了调试程序，我们会在很多出错的地方输出大量的日志信息。当程序调试完，不需要这些信息时，将程序中这些输出日志信息代码删除吗？这样费时费力，对于大型程序几乎不可行。通过对日志分级，假如不想输出WARN级别的日志信息，则Logger组件的级别调高即可，省时省心。    5. Logger组件的继承性       Log4J提供了一个root Logger，它是所有Logger组件的“祖先”,它永远存在，且不能通过名字检索或引用，通过Logger.getRootLogger()方

15、法取得它。配置root Logger代码：       log4j.rootLogger=INFO,console       可在配置文件中方便地配置存在继承关系的Logger组件，凡是在符号“.”后面的组件都会成为在符号“.”前面的Logger组件的子类。例如：       以上代码中, mySonLogger是myLogger的子类Logger组件。Logger组件的继承关系：   

16、;    . 如果子类Logger组件没有定义日志级别，则将继承父类的日志级别;       . 如果子类Logger组件定义了日志级别，就不会继承父类的日志级别;       . 黙认情况下，子类Logger组件会继承父类所有的Appender，把它们加入到自己的Appener;       . 如果把子类Logger组件的additivity标志设为false，那么它就不会继承父类A

17、ppender。additivity标志 默认值为false；       以上配置的三个Logger继承关系示例如图：            root Logger: 日志级别=INFO  appender清单=console               &

18、#160;                   myLogger: 日志级别=WARN appender清单=null                          

19、         mySonLogger: 日志级别=null appender清单=file       这三个Logger组件实际日志级别和Appender如下表：       Logger组件          日志级别        

20、;  Appender清单       root Logger         INFO              console       myLogger        &#

21、160;   WARN              console(继承)       mySonLogger         WARN(继承)        file，console(继承)    &

22、#160;  三、Appender组件    Appender组件决定将日志信息输出到什么地方。支持以下目的地：    . 控制台(Console);    . 文件(File);    . GUI组件(GUI component);    . 套接口服务器(Remote socket server);    . NT的事件记录器(NT Event Logger);  

23、0; . UNIX Syslog守护进程(Remote UNIX Syslog daemon);    一个Logger可同时对应多个Appender，示例：myLogger配置二个Appender: 一个file, 一个是console：四、Layout组件     为名称为console的Appender配置SimpleLayout，代码如下：    输出日志格式如下：    WARN - This is a log message from the myLog

24、ger        为名称为file的Appender配置PatternLayout，代码如下：    输出日志格式如下：    THREAD-1 WARN - This is a log message from the myLogger    PatternLayout让开发者依照ConversionPattern定义输出格式。ConversionPattern中一些指定日志内容和格式的预定义符号说明如下：  

25、  符号         描述    %r           自程序开始后消耗的毫秒数    %t           表示日志记录请求生成的线程    %p     

26、      表示日专语句的优先级    %r           与日志请求相关的类别名称    %c           日志信息所在的类名    %m%n         表示

27、日志信息的内容五、Log4J的基本用法    1. 定义配置文件       Log4J支持二种配置文件格式：XML和Java属性文件(采用“键=值”形式)。以下为Java属性文件       格式配置文件：             . 配置Logger组件      

28、            其中：priority为日志级别，可选值包括FATAL、ERROR、WARN、INFO、DEBUG、ALL；               appenderName指定Appender组件，可指定多个;          

29、60;    . 配置Appender组件         Log4J提供的Appender有以下几种：       . 配置Layout组件         下面为一配置文件示例，文件名为perties：         # LOGGERS #

30、60;        # APPENDERS #             2. 程序中使用Log4j       . 获得日志记录器：       . 读取日志记录器，配置Log4J环境;       . 输出日志信息; 

31、;        在程序代码中需要生成日志的地方，调用Logger的各种输出日志方法输出不同级别的日志，例如：                  myLogger.debug("Thie is a log message from the " + myLogger.getName();    

32、60;    下面为一使用Log4J的程序，程序名为Test.java：java 代码1.  import2.  import3.     4.  public class Test    5.   6.    public static void main(String args)    7.    

33、60; /Get an instance of the myLogger   8.      Logger myLogger = Logger.getLogger("myLogger");   9.       10.      /Get an instance

34、0;of the childLogger   11.      Logger mySonLogger = Logger.getLogger("myLogger.mySonLogger");   12.      /Load the proerties using the PropertyConfigurator 

35、60; 13.      PropertyConfigurator.configure("perties");   14.   15.      /Log Messages using the Parent Logger   16.      myLogger.debug(&quo

36、t;Thie is a log message from the " + myLogger.getName();   17.      myL("Thie is a log message from the " + myLogger.getName();   18.  

37、    myLogger.warn("Thie is a log message from the " +  myLogger.getName();   19.      myLogger.error("Thie is a log message from the " 

38、+ myLogger.getName();   20.      myLogger.fatal("Thie is a log message from the " + myLogger.getName();   21.   22.      mySonLogger.debug("Thie is

39、60;a log message from the " + mySonLogger.getName();   23.      mySonL("Thie is a log message from the " + mySonLogger.getName();   24.   &#

40、160;  mySonLogger.warn("Thie is a log message from the " +  mySonLogger.getName();   25.      mySonLogger.error("Thie is a log message from the " 

41、;+ mySonLogger.getName();   26.      mySonLogger.fatal("Thie is a log message from the " + mySonLogger.getName();   27.       28.       

42、0;   程序运行结果为:        WARN - Thie is a log message from the myLogger        ERROR - Thie is a log message from the myLogger        FATAL - Thie is a log message from the myLogger &#

43、160;      WARN - Thie is a log message from the myLogger.mySonLogger        ERROR - Thie is a log message from the myLogger.mySonLogger        FATAL - Thie is a log message from the myLogger.mySonLogger

44、60;       WARN - Thie is a log message from the myLogger.mySonLogger        ERROR - Thie is a log message from the myLogger.mySonLogger        FATAL - Thie is a log message from the myLogger.mySonLogg

45、er        如将配置文件perties中语句 改为 再次运行程序，结果如下：        WARN - Thie is a log message from the myLogger        ERROR - Thie is a log message from the myLogger    &

46、#160;   FATAL - Thie is a log message from the myLogger        WARN - Thie is a log message from the myLogger.mySonLogger        WARN - Thie is a log message from the myLogger.mySonLogger     

47、60;  ERROR - Thie is a log message from the myLogger.mySonLogger        ERROR - Thie is a log message from the myLogger.mySonLogger        FATAL - Thie is a log message from the myLogger.mySonLogger    

48、60;            FATAL - Thie is a log message from the myLogger.mySonLogger        mySonLogger的日志在控制台上输出了二次，这是因为mySonLogger继承了父类console Appender，        本身又定义了一个console Appender, 因而

49、有二个console Appender。六、在web应用中使用Log4J    创建一个Servlet，在它初始化方法中读取Log4J配置文件并配置Log4J环境，这个Servlet在Web应用启    动时候被加载和初始化，然后就可在其它Web组件中获取Logger对象并输出日志。    1. 创建用于配置Log4J环境的Servletjava 代码1. import2. import3. import4. import5.   6. import7.   8.

50、public class Log4JServlet extends HttpServlet    9.       public void init() throws ServletException    10.            String path =

51、60;getServletContext().getRealPath("/");   11.            /getInitParameter("propfile")方法从web.xml文件中读取Log4J配置文件的名字"profile"。   12.           

52、; String propfile = path + getInitParameter("propfile");   13.            PropertyConfigurator.configure(propfile);   14.          15.  

53、0;16.         该Servlet在web.xml中的配置如下：xml 代码1. <servlet>  2.   <servlet-name>log4jServlet</servlet-name>  3.   <servlet-class>Log4JServlet</servlet-class>  4.   <init-param&

54、gt;  5.     <param-name>propfile</param-name>  6.     <param-value>/WEB-INF/perties</param-value>  7.   </init-param>  8.   <load-on-startup>1</load-on-

55、startup>  9. </servlet>  2. 在login.jsp中输出日志       <%page              mySonLogger.debug("Thie is a log message from the " + mySonLogger.getName();   

56、;          mySonL("Thie is a log message from the " + mySonLogger.getName();             mySonLogger.warn("Thie is a log message from the " +  mySonLogger.getNa

57、me();             mySonLogger.error("Thie is a log message from the " + mySonLogger.getName();             mySonLogger.fatal("Thie is a log message from the " +

58、 mySonLogger.getName();           %>           <br>             <form name="loginForm" method="post" action=

59、"dispatcher">             username: <input type="text" name="username">             <br>        

60、;     password: <input type="text" name="password">             <br>             <input type="submit" name="su

61、bmit" value="submit">           </form>         </body>       </html>                   3. 发布运行使用Log4J的web应用       1) 将Log4J的JAR文件拷贝至目录：