Log4j基础教程

墨蓝 2022-05-18 03:52 212阅读 0赞

### 前言 ###

Log4j基础篇，本文所用的Demo皆可在我的git项目  
[https://github.com/SeanYanxml/log4j-demos][https_github.com_SeanYanxml_log4j-demos] 内找到。(如果觉得项目写的不错，不妨给我一个star)

--------------------

### Log4j内容解析 ###

Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。日志信息的优先级从高到低有ERROR、WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；日志信息的输出目的地指定了日志将打印到控制台还是文件中；而输出格式则控制了日志信息的显 示内容。

*  定义配置文件

其实您也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使您的应用程序更加灵活。Log4j支持两种配置文件格式，一种是XML格式的文件，一种是Java特性文件（键=值）。下面我们介绍使用Java特性文件做为配置文件的方法：
    
    1.配置根Logger，其语法为：
    
    
    log4j.rootLogger = [ level ] , appenderName, appenderName, …
    
    
    其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优 先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。 appenderName就是指B日志信息输出到哪个地方。您可以同时指定多个输出目的地。

2.配置日志信息输出目的地Appender，其语法为：

log4j.appender.appenderName = fully.qualified.name.of.appender.class  
    log4j.appender.appenderName.option1 = value1  
    …  
    log4j.appender.appenderName.option = valueN
    
    其中，Log4j提供的appender有以下几种：
    
    org.apache.log4j.ConsoleAppender（控制台），  
    org.apache.log4j.FileAppender（文件），  
    org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），  
    org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），  
    org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

3.配置日志信息的格式（布局），其语法为：

log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class  
    log4j.appender.appenderName.layout.option1 = value1  
    …  
    log4j.appender.appenderName.layout.option = valueN
    
    
    其中，Log4j提供的layout有以e几种：
    
    org.apache.log4j.HTMLLayout（以HTML表格形式布局），  
    org.apache.log4j.PatternLayout（可以灵活地指定布局模式），  
    org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），  
    org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
    
    Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下： %m 输出代码中指定的消息
    
    %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL  
    %r 输出自应用启动到输出该log信息耗费的毫秒数  
    %c 输出所属的类目，通常就是所在类的全名  
    %t 输出产生该日志事件的线程名  
    %n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”  
    %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921  
    %l 输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)

*  在代码中使用Log4j

1.得到记录器

使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为：
    
    public static Logger getLogger( String name)
    
    通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如：
    
    static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )
    注意: 使用Java原生的Logger与此处Logger有些许不同，需要注意。

2.读取配置文件

当获得了日志记录器之后，第二步将配置Log4j环境，其语法为：
    
    BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。  
    PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。  
    DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

3.插入记录信息（格式化日志信息）

当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下：
    
    Logger.debug ( Object message ) ;  
    Logger.info ( Object message ) ;  
    Logger.warn ( Object message ) ;  
    Logger.error ( Object message ) ;

2.3、日志级别

每个Logger都被了一个日志级别（log level），用来控制日志信息的输出。日志级别从高到低分为：
    A：off 最高等级，用于关闭所有日志记录。
    B：fatal 指出每个严重的错误事件将会导致应用程序的退出。
    C：error 指出虽然发生错误事件，但仍然不影响系统的继续运行。
    D：warm 表明会出现潜在的错误情形。
    E：info 一般和在粗粒度级别上，强调应用程序的运行全程。
    F：debug 一般用于细粒度级别上，对调试应用程序非常有帮助。
    G：all 最低等级，用于打开所有日志记录。
    
    上面这些级别是定义在org.apache.log4j.Level类中。Log4j只建议使用4个级别，优先级从高到低分别是error,warn,info和debug。通过使用日志级别，可以控制应用程序中相应级别日志信息的输出。例如，如果使用b了info级别，则应用程序中所有低于info级别的日志信息(如debug)将不会被打印出来。

--------------------

### 基础例子 ###

*  导入Jar包（Maven&手动导入皆可）

*  log4j.properties

### root logger
    log4j.rootLogger=DEBUG, Console, R
    
    ### console appender
    log4j.appender.Console=org.apache.log4j.ConsoleAppender
    log4j.appender.Console.layout=org.apache.log4j.PatternLayout
    log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] [%L] - %m %n
    
    ### file appender
    log4j.appender.R=org.apache.log4j.RollingFileAppender
    ### file path
    log4j.appender.R.File=hello.log
    log4j.appender.R.MaxFileSize=50MB
    log4j.appender.R.MaxBackupIndex=30
    log4j.appender.R.layout=org.apache.log4j.PatternLayout
    log4j.appender.R.layout.ConversionPattern=%d [%t] %-5p [%c] [%L] - %m %n
    
    
    ### Details
    
    log4j.logger.org.springframework=WARN
    log4j.logger.org.springframework.jdbc=WARN
    log4j.logger.org.springframework.security=WARN
    log4j.logger.org.apache=WARN
    log4j.logger.com.mchange.v2=WARN
    log4j.logger.freemarker.cache=INFO

*  HelloworldLog4jDemo.java

package com.yanxml.log4j.demos.helloworld;
    
    import org.apache.log4j.Logger;
    
    import org.apache.log4j.BasicConfigurator;
    import org.apache.log4j.PropertyConfigurator;
    import org.apache.log4j.xml.DOMConfigurator;
    
    public class HelloworldLog4jDemo { 
        private static Logger logger = Logger.getLogger(HelloworldLog4jDemo.class);  
    
        /** * @param args */  
        public static void main(String[] args) {  
    
    // BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。 
    // PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。 
    // DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。
    
    // BasicConfigurator.configure();// default & realpath
    // PropertyConfigurator.configure("");//property file path
    // DOMConfigurator.configure("");// xml file path
    
            // System.out.println("This is println message."); 
    
            // 记录debug级别的信息 
            logger.debug("This is debug message.");  
            // 记录info级别的信息 
            logger.info("This is info message.");  
            // 记录error级别的信息 
            logger.error("This is error message.");  
        }  
    
    }

--------------------

### Log4j-Servlet-Demo ###

上面代码描述了Log4j的简单应用，其实使用Log4j也就是这样简单方便。当然除了上面的配置方法，还有其它，比如做一个J2EE应用，在J2EE应用使用Log4j，必须先在启动服务时加载Log4j的配置文件进行初始化，可以在web.xml中进行。

1、web应用的log4j使用基本上都采用：新建一个servlet，这个servlet在init函数中为log4j执行配置。一般就是读入配置文件。所以需要在web.xml中为这个servlet配置，同时设定load-on-startup为1。

2、这个servlet配置log4j就是读出配置文件，然后调用configure函数。这里有两个问题：一、需要知道文件在哪里；二、需要正确的文件类型

3、配置文件位置在web.xml中配置一个param即可，路径一般是相对于web的root目录

4、文件类型一般有两种，一个是Java的property文件，另一种是xml文件

配置文件的大致内容：log4j可以指定输出的log级别的最低等级，以及log的输出配置格式，每个log可以指定多个输出方式

（1）创建Maven项目，转换为Web项目。并添加Jar包如下:

<dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
    
            
            <dependency>
                <groupId>javax.servlet</groupId>
                <artifactId>javax.servlet-api</artifactId>
                <version>4.0.0</version>
                <scope>provided</scope>
            </dependency>

（2）web.xml配置如下：

（3）配置文件log4j.properties

（4）web容器一来就初始化的servlet

//Log4JInitServlet.java
    package com.yanxml.log4j.demos.servlet;
    
    import java.io.File;
    import java.io.IOException;
    
    import javax.servlet.ServletConfig;
    import javax.servlet.ServletContext;
    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.BasicConfigurator;
    import org.apache.log4j.PropertyConfigurator;
    
    /** * Servlet implementation class Log4JInitServlet */
    @WebServlet("/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();
    
            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
        }
    
    }

//调用日志Log4JTestServlet.java
    package com.yanxml.log4j.demos.servlet;
    
    import java.io.IOException;
    
    import javax.servlet.ServletConfig;
    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;
    
    /** * Servlet implementation class Log4JTestServlet */
    @WebServlet("/Log4JTestServlet")
    public class Log4JTestServlet extends HttpServlet { 
        private static final long serialVersionUID = 1L;
        private static Logger logger = Logger.getLogger(Log4JTestServlet.class);
    
        /** * @see HttpServlet#HttpServlet() */
        public Log4JTestServlet() {
            super();
            // TODO Auto-generated constructor stub
        }
    
        /** * @see Servlet#init(ServletConfig) */
        public void init(ServletConfig config) throws ServletException {
            // TODO Auto-generated method stub
        }
    
        /** * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse * response) */
        protected void doGet(HttpServletRequest request,
                HttpServletResponse response) throws ServletException, IOException {
            // 记录debug级别的信息
            logger.debug("This is debug message.");
            // 记录info级别的信息
            logger.info("This is info message.");
            // 记录error级别的信息
            logger.error("This is error message.");
        }
    
        /** * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse * response) */
        protected void doPost(HttpServletRequest request,
                HttpServletResponse response) throws ServletException, IOException {
            doGet(request, response);
        }
    
    }

注意: 此项目需要放置Tomcat容器上运行。

//http://localhost:8080/log4j-servlet/Log4JTestServlet
    //2018-07-27 17:40:34,976 [http-nio-8080-exec-3] DEBUG [com.yanxml.log4j.demos.servlet.Log4JTestServlet] [44] - This is debug message. 
    //2018-07-27 17:40:34,979 [http-nio-8080-exec-3] INFO  [com.yanxml.log4j.demos.servlet.Log4JTestServlet] [46] - This is info message. 
    //2018-07-27 17:40:34,979 [http-nio-8080-exec-3] ERROR [com.yanxml.log4j.demos.servlet.Log4JTestServlet] [48] - This is error message.

--------------------

### Log4j-Spring-Demo ###

（1）接上面的工程，然后再导入Spring的包

<dependencies>
    
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
    
            
            <dependency>
                <groupId>javax.servlet</groupId>
                <artifactId>javax.servlet-api</artifactId>
                <version>4.0.0</version>
                <scope>provided</scope>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>3.2.9.RELEASE</version>
            </dependency>
    
            
            
    
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-web</artifactId>
                <version>3.2.9.RELEASE</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>3.2.9.RELEASE</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-webmvc</artifactId>
                <version>3.2.9.RELEASE</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-beans</artifactId>
                <version>3.2.9.RELEASE</version>
            </dependency>
    
        </dependencies>

（2）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_3_0.xsd" id="WebApp_ID" version="3.0">
        <display-name>LogLearning</display-name>
    
        <servlet>
            <servlet-name>Log4JTestServlet</servlet-name>
            
            <servlet-class>com.yanxml.log4j.demos.spring.Log4JTestServlet</servlet-class>
        </servlet>
    
        
        
    
        <servlet-mapping>
            <servlet-name>Log4JTestServlet</servlet-name>
            <url-pattern>/test</url-pattern>
        </servlet-mapping>
    
          
        <listener>  
            <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
        </listener>  
        <context-param>  
            <param-name>contextConfigLocation</param-name>  
            <param-value>classpath:applicationContext.xml</param-value>  
        </context-param>   
    
        
        <context-param>
            <param-name>webAppRootKey</param-name>
            <param-value>webapp.root</param-value>
        </context-param>
    
        <context-param>
            <param-name>log4jConfigLocation</param-name>
            <param-value>/WEB-INF/classes/log4j.properties</param-value>
        </context-param>
        
        <context-param>
            <param-name>log4jRefreshInterval</param-name>
            <param-value>3000</param-value>
        </context-param>
        <listener>
            <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
        </listener>
    
    </web-app>

（2）applicationContext.xml

# 基本内容 设置均为空
    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:aop="http://www.springframework.org/schema/aop" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.2.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd">
    </beans>

url: http://localhost:8080/LogLearning2/test
    This is debug message. 
    This is info message. 
    This is error message.

--------------------

### Reference ###

\[1\]. [最详细的Log4j使用教程][Log4j]

[https_github.com_SeanYanxml_log4j-demos]: https://github.com/SeanYanxml/log4j-demos
[Log4j]: http://www.codeceo.com/article/log4j-usage.html