[Log4j使用教程] JavaSE/JavaEE/SpringMVC中使用Log4j

要想使用Log4j, 首先需要下载到Log4j的jar, Download: http://www.apache.org/dyn/closer.cgi/logging/log4j/1.2.17/log4j-1.2.17.zip

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

1.定义配置文件
　　其实您也可以完全不使用配置文件，而是在代码中配置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就是指日志信息输出到哪个地方。您可以同时指定多个输出目的地。

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有以下几种：
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一般取本类的名字，比如：
private static Logger logger = Logger.getLogger(Log4jTest.class.getName())

或者
private static Logger logger = Logger.getLogger(Log4jTest.class)

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 ) ;

三、日志级别
    每个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)将不会被打印出来。

四、Log4j在 JavaSE 项目中的使用 (Download: https://github.com/DreamLi1314/Log4jTest01.git)
1.在 JavaSE工程的根目录下建一个 lib 文件夹，将log4j的jar包放在该文件夹下-->Build Path
2.在src 下新建一个 log4j.properties 文件

### setting ###
log4j.rootLogger=debug,stdout,D,E
 
### output to console ###
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
 
### output debug model log to E://DreamLi/.../Log4jTest01/logs/log.log ### 
log4j.appender.D=org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File=logs/log.log
log4j.appender.D.Append=true
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 ] %l%n%m%n
 
### output log above error level to E://DreamLi/.../logs/error.log ### 
log4j.appender.E=org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File=logs/error.log
log4j.appender.E.Append=true
log4j.appender.E.Threshold=ERROR
log4j.appender.E.layout=org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %l%n%m%n

　　

目录结构:

3.在Class中获取Logger
private static final Logger LOGGER = Logger.getLogger(Log4jTest01.class);

4.记录 log 日志
import org.apache.log4j.Logger;
public class Log4jTest01 {

private static final Logger LOGGER = Logger.getLogger(Log4jTest01.class);

public static void main(String[] args) {
       //debug 级别的日志
       LOGGER.debug("This is debug level message...");

//info 级别的日志
       LOGGER.info("This is info level message...");

//error 级别的日志
       LOGGER.error("This is error level message...");
    }
}

5.效果
1) console 输出
[DEBUG] 2017-12-12 22:44:13,248 method:com.inetsoft.log4j.Log4jTest01.main(Log4jTest01.java:13)
This is debug level message...
[INFO ] 2017-12-12 22:44:13,250 method:com.inetsoft.log4j.Log4jTest01.main(Log4jTest01.java:16)
This is info level message...
[ERROR] 2017-12-12 22:44:13,251 method:com.inetsoft.log4j.Log4jTest01.main(Log4jTest01.java:19)
This is error level message...

2) 日志输出
log.log
2017-12-12 22:44:13  [ main:0 ] - [ DEBUG ]  com.inetsoft.log4j.Log4jTest01.main(Log4jTest01.java:13)
This is debug level message...
2017-12-12 22:44:13  [ main:2 ] - [ INFO  ]  com.inetsoft.log4j.Log4jTest01.main(Log4jTest01.java:16)
This is info level message...
2017-12-12 22:44:13  [ main:3 ] - [ ERROR ]  com.inetsoft.log4j.Log4jTest01.main(Log4jTest01.java:19)
This is error level message...

error.log
2017-12-12 22:44:13  [ main:3 ] - [ ERROR ]  com.inetsoft.log4j.Log4jTest01.main(Log4jTest01.java:19)
This is error level message...

五、Log4j在 JavaEE 项目中的使用 (Download: https://github.com/DreamLi1314/Log4jTest02.git)
    在J2EE应用使用Log4j，必须先在启动服务时加载Log4j的配置文件进行初始化，可以在web.xml中进行。

1、web应用的log4j使用基本上都采用：新建一个servlet，这个servlet在init函数中为log4j执行配置。一般就是读入配置文件。所以需要在web.xml中为这个servlet配置，同时设定load-on-startup为1。
2、这个servlet配置log4j就是读出配置文件，然后调用configure函数。这里有两个问题：
    1) 需要知道文件在哪里;
    2) 需要正确的文件类型
3、配置文件位置在web.xml中配置一个param即可，路径一般是相对于web的root目录
4、文件类型一般有两种，一个是Java的property文件，另一种是xml文件
配置文件的大致内容：log4j可以指定输出的log级别的最低等级，以及log的输出配置格式，每个log可以指定多个输出方式

e.g.
1) 创建工程

2) web.xml
<servlet>
    <servlet-name>InitLog4jServlet</servlet-name>
    <servlet-class>com.inetsoft.log4j.InitLog4jServlet</servlet-class>
    <init-param>
      <param-name>log4j-location</param-name>
      <param-value>/WEB-INF/classes/log4j.properties</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

3) log4j.properties
### setting ###
log4j.rootLogger = debug,stdout,D,E 
 
### output to console ###
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
 
### output debug model log to webapps/projectName/WEB-INF/logs/log.log ### 
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = ${log4jdir}/logs/log.log 
log4j.appender.D.Append = true
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 ] - [ %-5p ]  %l%n%m%n
 
### output log above error level to webapps/projectName/WEB-INF/logs/error.log ### 
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = ${log4jdir}/logs/error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %-5p ]  %l%n%m%n

4) Log4jConfigListener 用来将 log 文件放在工程目录中(tomcat/webapps..) 如果 log 文件放在自定义的绝对路径下,可以没有该文件
    Note: 配置在tomcat的工程目录下可能会在服务启动的过程中被移除
@WebListener
public class Log4jConfigListener implements ServletContextListener {
    private static final String LOG4JDIRKEY = "log4jdir";
    @Override
    public void contextDestroyed(ServletContextEvent servletContextEvent) {
        System.getProperties().remove(LOG4JDIRKEY);
    }
    @Override
    public void contextInitialized(ServletContextEvent servletContextEvent) {
       String log4jdir = servletContextEvent.getServletContext().getRealPath("/") + "WEB-INF/";
       System.out.println("============log4jdir=============" + log4jdir);
       System.setProperty(LOG4JDIRKEY, log4jdir);
    }
}

log4j.appender.D.File = ${log4jdir}/logs/log.log

5) InitLog4jServlet 初始化 log4j
public class InitLog4jServlet extends HttpServlet {
    private static final long serialVersionUID = 9203392013908166899L;
    @Override
    public void init() throws ServletException {       
       String path = this.getInitParameter("log4j-location");// config on web.xml <init-param>
       System.out.println("========== path =========" + path);
       if(path == null) {
           System.out.println("=== path is null ===使用默认的配置======");
           BasicConfigurator.configure();
       } else {
           path = this.getServletContext().getRealPath(path);
           System.out.println();
           File config = new File(path);
           if(config.exists()) {
               System.out.println("==========使用配置文件配置=========" + path);
               PropertyConfigurator.configure(path);
           } else {
               System.out.println("====config is not exists==使用默认的配置======");
               BasicConfigurator.configure();
           }
       }

super.init();
    }
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
       response.getWriter().append("Served at: ").append(request.getContextPath());
    }
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
       doGet(request, response);
    }
}

6) 测试 Log4j
@WebServlet("/Log4jTestServlet")
public class Log4jTestServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
    private static final Logger LOGGER = Logger.getLogger(Log4jTestServlet.class);
    
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
       response.getWriter().append("Served at: ").append(request.getContextPath());
       
       LOGGER.debug("This is debug message...");
       
       LOGGER.info("This is info message...");
       
       LOGGER.error("This is error message...");
       
    }
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
       doGet(request, response);
    }
}

7) 结果

五、在 SpringMVC 中使用 Log4j (Download: https://github.com/DreamLi1314/Log4jTest03.git)
1.首先导入SpringMVC的到工程中,目录结构如下:

2.配置 web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
    xmlns="http://xmlns.jcp.org/xml/ns/javaee";
    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaeehttp://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd";
    id="WebApp_ID" version="3.1">
    <display-name>Log4jTest02</display-name>
    <!-- 配置springmvc的前端控制器 -->
    <servlet>
         <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
         <!-- 如果不配置contextConfigLocation,则默认值为 /WEB-INF/servlectName-servlet.xml -->
         <init-param>
             <param-name>contextConfigLocation</param-name>
             <param-value>classpath:springmvc.xml</param-value>
         </init-param>
    </servlet>
    <servlet-mapping>
         <servlet-name>springmvc</servlet-name>
         <!-- 三种配置方式： 1. *.action 2. / 3. /* 但是这样配置是不对的，springmvc会把jsp等静态web资源也进行解析，因此导致报错 -->
         <url-pattern>/</url-pattern>
    </servlet-mapping>
    <!-- 用来在 log4j.properties 文件中引用，将log文件存放在项目目录下 -->
    <context-param>
         <param-name>webAppRootKey</param-name>
         <param-value>webapp.root</param-value>
    </context-param>
    
      <!-- 配置log4j 配置文件的位置 -->
    <context-param>
        <param-name>log4jConfigLocation</param-name>
        <param-value>/WEB-INF/classes/log4j.properties</param-value>
    </context-param>
    <!-- 60000ms 表示开一条watch dog线程每60秒扫描一下配置文件的变化;这样便于日志存放位置的改变 -->
    <context-param>
        <param-name>log4jRefreshInterval</param-name>
         <param-value>60000</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
    </listener>
    <welcome-file-list>
         <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

3.springmvc.xml
<beans xmlns="http://www.springframework.org/schema/beans";
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xmlns:mvc="http://www.springframework.org/schema/mvc";
    xmlns:context="http://www.springframework.org/schema/context";
    xmlns:aop="http://www.springframework.org/schema/aop"; xmlns:tx="http://www.springframework.org/schema/tx";
    xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-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/tx
http://www.springframework.org/schema/tx/spring-tx-3.2.xsd";>
    
    <!-- 使用注解驱动器代替上边的两行配置 -->
    <mvc:annotation-driven></mvc:annotation-driven>
    
    <!-- 使用组件扫描器扫描Handler（就不用一个一个配置Handler了） -->
    <context:component-scan base-package="com.inetsoft.controller"></context:component-scan>
    <!-- 配置视图解析器 解析jsp,默认使用jstl标签 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
         <property name="prefix" value="/WEB-INF/" />
         <property name="suffix" value=".jsp" />
    </bean>
</beans>

4.log4j.properties
### setting ###
log4j.rootLogger = debug,stdout,D,E
 
### output to console ###
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
 
### output debug model log to webapps/projectName/WEB-INF/logs/log.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = ${webapp.root}/WEB-INF/logs/log.log
log4j.appender.D.Append = true
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 ] - [ %-5p ]  %l%n%m%n
 
### output log above error level to webapps/projectName/WEB-INF/logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = ${webapp.root}/WEB-INF/logs/error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %-5p ]  %l%n%m%n

5.Test Log4j
1)Controller
@Controller
public class TestController {
    
    private static final Logger LOGGER = Logger.getLogger(TestController.class);
    
    @RequestMapping("/test")
    public ModelAndView testLog4j() {
         LOGGER.debug("This is debug message...");
         
         LOGGER.info("This is info message...");
         
         LOGGER.error("This is error message...");
         ModelAndView mv = new ModelAndView();
         mv.addObject("key", "value");
         mv.setViewName("test");
         return mv;
    }
}

2)index.jsp
<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
</head>
<body>
    
    <a href="${pageContext.request.contextPath }/test">Test Log4j...</a>
    
</body>
</html>

3)test.jsp
<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
</head>
<body>
 This is test.jsp...${key }
</body>
</html>

6.result

---------------------
作者：Dream-Li
来源：CSDN
原文：https://blog.csdn.net/dreamli1314/article/details/78825039
版权声明：本文为博主原创文章，转载请附上博文链接！