log4j2 與 spring mvc整合


log4j2不僅僅是log4j的簡單升級,而是整個項目的重構,官網地址:http://logging.apache.org/log4j/2.x/,大家可以從官網的介紹看出它相比log4j第1代的種種優點。

一、基本使用

1.1 maven依賴項

 1         <dependency>
 2             <groupId>org.apache.logging.log4j</groupId>
 3             <artifactId>log4j-api</artifactId>
 4             <version>2.0.2</version>
 5         </dependency>
 6         <dependency>
 7             <groupId>org.apache.logging.log4j</groupId>
 8             <artifactId>log4j-core</artifactId>
 9             <version>2.0.2</version>
10         </dependency>
View Code

1.2 Hello world示例

 1 package com.cnblogs.yjmyzz;
 2 
 3 import org.apache.logging.log4j.LogManager;
 4 import org.apache.logging.log4j.Logger;
 5 
 6 /**
 7  * Hello world!
 8  * 
 9  */
10 public class App {
11     static Logger logger = LogManager.getLogger(LogManager.ROOT_LOGGER_NAME);
12 
13     public static void main(String[] args) {
14         logger.trace("trace message");
15         logger.debug("debug message");
16         logger.info("info message");
17         logger.warn("warn message");
18         logger.error("error message");
19         logger.fatal("fatal message");
20         System.out.println("Hello World!");
21     }
22 }
View Code

在沒有任何配置的情況下,log4j2會使用默認配置:

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <Configuration status="WARN">
 3     <Appenders>
 4         <Console name="Console" target="SYSTEM_OUT">
 5             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
 6         </Console>
 7     </Appenders>
 8     <Loggers>
 9         <Root level="error">
10             <AppenderRef ref="Console" />
11         </Root>
12     </Loggers>
13 </Configuration>
View Code

該配置只有一個Appender:Console,目標是SYSTEM_OUT,即日志內容,都會打印在eclipse控制台上。Root Logger的級別是error,即:所有error及以上級別的日志才會記錄。(注:日志級別順序為 TRACE < DEBUG < INFO < WARN < ERROR < FATAL ),所以最終只有2日志會輸出(error,fatal)

1 13:07:56.099 [main] ERROR  - error message
2 13:07:56.100 [main] FATAL  - fatal message
3 Hello World!

配置第1行中的status="WARN",可以去掉,它的含義為是否記錄log4j2本身的event信息,默認是OFF,設置成“WARN”指:所有log4j2的event信息中,只有WARN及以上級別的信息才記錄,大家可以把它改成TRACE試試(最低級別),看下輸出內容有何變化。

另:配置文件通常命名為log4j2.xml,運行時只要在classpath下能找到即可。

1.3 文件方式記錄日志

真正應用中,更多的是以純文本文件的方式來記錄系統的運行日志,來看一段稍微復雜點的配置

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <Configuration status="off" monitorInterval="1800">
 3 
 4     <properties>
 5         <property name="LOG_HOME">logs/sample</property>
 6         <property name="FILE_NAME">mylog</property>
 7     </properties>
 8 
 9     <Appenders>
10         <Console name="Console" target="SYSTEM_OUT">
11             <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
12         </Console>
13 
14         <RollingRandomAccessFile name="running-log"
15             fileName="${LOG_HOME}/${FILE_NAME}.log" filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd}-%i.log.gz">
16             <PatternLayout
17                 pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n" />
18             <Policies>
19                 <TimeBasedTriggeringPolicy />
20                 <SizeBasedTriggeringPolicy size="10 MB" />
21             </Policies>
22             <DefaultRolloverStrategy max="20" />
23         </RollingRandomAccessFile>
24     </Appenders>
25     
26     <Loggers>
27         <Logger name="com.cnblogs.yjmyzz.App2" level="trace"
28             additivity="true">
29             <AppenderRef ref="running-log" />
30         </Logger>
31         <Root level="error">
32             <AppenderRef ref="Console" />
33         </Root>
34     </Loggers>
35 </Configuration>
View Code

 解釋一下:

第1行中的 monitorInterval="1800" 指log4j2每隔1800秒(半小時),自動監控該配置文件是否有變化,如果變化,則自動根據文件內容重新配置(很不錯的功能!)

4-7行定義了一些屬性(可以根據需要自己隨便添加),主要是為了后面引用起來方便

14行 RollingRandomAccessFile  即表示以文件方式記錄,注意一下filePattern 的設置,它與20行的SizeBasedTriggeringPolicy (表示單個文件最大多少容量)結合在一起,非常有用,以這段配置為例,當單個文件達到10M后,會自動將以前的內容,先創建類似 2014-09(年-月)的目錄,然后按 "xxx-年-月-日-序號"命名,打成壓縮包(很體貼的設計,即省了空間,又不丟失以前的日志信息)

22行的DefaultRolloverStrategy max="20"表示壓縮包,最多保留20個

27-30行,定義了一個新logger,它的級別是trace ,使用文件方式來記錄日志,additivity="true" 這里注意一下,因為下面還有一個root logger,任何其它的logger最終都相當於繼承自root logger,所以“com.cnblogs.yjmyzz.App2”這個logger中,如果記錄了error及以上級別的日志,除了文件里會記錄外,root logger也會生效,即:控制台也會輸出一次。如果把additivity="true" 中的true,改成false,root logger就不會再起作用,即只會記錄在文件里,控制台無輸出。

另外關於logger的命名,很有講究的,這里我們命名為com.cnblogs.yjmyzz.App2,如果正好有這樣一個類:

 1 package com.cnblogs.yjmyzz;
 2 
 3 import org.apache.logging.log4j.LogManager;
 4 import org.apache.logging.log4j.Logger;
 5 
 6 public class App2 {
 7 
 8     static Logger logger = LogManager.getLogger();
 9 
10     public static void main(String[] args) {
11         for (int i = 0; i < 10; i++) {
12             logger.trace("trace message " + i);
13             logger.debug("debug message " + i);
14             logger.info("info message " + i);
15             logger.warn("warn message " + i);
16             logger.error("error message " + i);
17             logger.fatal("fatal message " + i);
18         }        
19         System.out.println("Hello World! 2");
20     }
21 }
View Code

log4j2是根據名稱來用哪個logger的,第8行沒有傳任何參數,默認這個logger的name就是當前類的全稱,即 com.cnblogs.yjmyzz.App2,這樣就跟配置對應上了,所以剛才配置中的 nam="com.cnblogs.yjmyzz.App2"的logger,相當於只對App2這一個類起作用。

更多關於logger name繼承的規則,請參考log4j2的官方pdf文檔

 

二、與Spring MVC 的整合

2.1 maven依賴項

 1 <properties>
 2         <java.version>1.6</java.version>
 3         <springframework.version>3.2.8.RELEASE</springframework.version>
 4         <log4j2.version>2.0.2</log4j2.version>
 5     </properties>
 6     <dependencies>
 7         <!-- Spring -->
 8         <dependency>
 9             <groupId>org.springframework</groupId>
10             <artifactId>spring-core</artifactId>
11             <version>${springframework.version}</version>
12         </dependency>
13         <dependency>
14             <groupId>org.springframework</groupId>
15             <artifactId>spring-beans</artifactId>
16             <version>${springframework.version}</version>
17         </dependency>
18         <dependency>
19             <groupId>org.springframework</groupId>
20             <artifactId>spring-context</artifactId>
21             <version>${springframework.version}</version>
22         </dependency>
23         <dependency>
24             <groupId>org.springframework</groupId>
25             <artifactId>spring-web</artifactId>
26             <version>${springframework.version}</version>
27         </dependency>
28         <dependency>
29             <groupId>org.springframework</groupId>
30             <artifactId>spring-webmvc</artifactId>
31             <version>${springframework.version}</version>
32         </dependency>
33         <dependency>
34             <groupId>org.springframework</groupId>
35             <artifactId>spring-expression</artifactId>
36             <version>${springframework.version}</version>
37         </dependency>
38 
39         <!-- log4j2 -->
40         <dependency>
41             <groupId>org.apache.logging.log4j</groupId>
42             <artifactId>log4j-api</artifactId>
43             <version>${log4j2.version}</version>
44         </dependency>
45         <dependency>
46             <groupId>org.apache.logging.log4j</groupId>
47             <artifactId>log4j-core</artifactId>
48             <version>${log4j2.version}</version>
49         </dependency>
50         <dependency>
51             <groupId>org.apache.logging.log4j</groupId>
52             <artifactId>log4j-web</artifactId>
53             <version>2.0.2</version>
54         </dependency>
55     </dependencies>
View Code

2.2 web.xml配置

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
 3     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
 5 
 6     <context-param>
 7         <param-name>contextConfigLocation</param-name>
 8         <param-value>/WEB-INF/spring/root-context.xml</param-value>
 9     </context-param>
10     <listener>
11         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
12     </listener>
13 
14     <!-- log4j2-begin -->
15     <listener>
16         <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>
17     </listener>
18     <filter>
19         <filter-name>log4jServletFilter</filter-name>
20         <filter-class>org.apache.logging.log4j.web.Log4jServletFilter</filter-class>
21     </filter>
22     <filter-mapping>
23         <filter-name>log4jServletFilter</filter-name>
24         <url-pattern>/*</url-pattern>
25         <dispatcher>REQUEST</dispatcher>
26         <dispatcher>FORWARD</dispatcher>
27         <dispatcher>INCLUDE</dispatcher>
28         <dispatcher>ERROR</dispatcher>
29     </filter-mapping>
30     <!-- log4j2-end -->
31     
32     <filter>
33         <filter-name>CharacterEncodingFilter</filter-name>
34         <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
35         <init-param>
36             <param-name>encoding</param-name>
37             <param-value>utf-8</param-value>
38         </init-param>
39     </filter>
40     <filter-mapping>
41         <filter-name>CharacterEncodingFilter</filter-name>
42         <url-pattern>/*</url-pattern>
43     </filter-mapping>
44     <servlet>
45         <servlet-name>appServlet</servlet-name>
46         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
47         <init-param>
48             <param-name>contextConfigLocation</param-name>
49             <param-value>/WEB-INF/spring/appServlet/servlet-context.xml</param-value>
50         </init-param>
51         <load-on-startup>1</load-on-startup>
52     </servlet>
53     <servlet-mapping>
54         <servlet-name>appServlet</servlet-name>
55         <url-pattern>/</url-pattern>
56     </servlet-mapping>
57 </web-app>
View Code

注:這是web app 2.5的整合方法,web app3.0不需要這么復雜的配置,3.0的整合請參考官方pdf文檔
2.3 log4j2.xml

內容前面那段“復雜的”配置差不多,就不重復貼出來了

放置在resources目錄即可,打包后,會自動復制到classpath下.


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM