Log4j日誌在java專案中的使用（附工程原始碼）

阿新 • • 發佈：2019-01-23

一、關於Log4j日誌

Log4j是Apache的一個開源專案，通過使用Log4j，我們可以控制日誌資訊輸送的目的地是控制檯、檔案、GUI元件，甚至是套介面伺服器、NT的事件記錄器、UNIX Syslog守護程序等；我們也可以控制每一條日誌的輸出格式；通過定義每一條日誌資訊的級別，我們能夠更加細緻地控制日誌的生成過程。最令人感興趣的就是，這些可以通過一個配置檔案來靈活地進行配置，而不需要修改應用的程式碼。

在強調可重用元件開發的今天，除了自己從頭到尾開發一個可重用的日誌操作類外，Apache為我們提供了一個強有力的日誌操作包-Log4j。

此外，通過Log4j其他語言介面，您可以在C、C++、.Net、PL/SQL程式中使用Log4j，其語法和用法與在Java程式中一樣，使得多語言分散式系統得到一個統一一致的日誌元件模組。而且，通過使用各種第三方擴充套件，您可以很方便地將Log4j整合到J2EE、JINI甚至是SNMP應用中。

二、Log4j使用前必須要了解的一些概念

2.1、日誌資訊的優先順序

日誌記錄的優先順序，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別，優先級從高到低分別是ERROR、WARN、INFO、DEBUG。而且在企業中一般也只使用著四種。下面是各個級別的極介紹：

OFF 最高等級，用於關閉所有日誌記錄。
FATAL 指出每個嚴重的錯誤事件將會導致應用程式的退出。
ERROR 指出雖然發生錯誤事件，但仍然不影響系統的繼續執行。
WARN 表明會出現潛在的錯誤情形。
INFO 一般和在粗粒度級別上，強調應用程式的執行全程。
DEBUG 一般用於細粒度級別上，對除錯應用程式非常有幫助。
ALL 最低等級，用於開啟所有日誌記錄。

2.2、日誌資訊的輸出目的地

日誌資訊的輸出目的地指定了日誌將列印到控制檯還是檔案中。參考如下配置檔案log4j.properties，其既配置了輸出到控制檯，也配置了輸出到日誌檔案中：

### 設定###
log4j.rootLogger = debug,stdout,D,E

### 輸出資訊到控制擡 ###
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

### 輸出DEBUG 級別以上的日誌到=D://logs/debug.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = D://logs/debug.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 ]  %m%n

### 輸出ERROR 級別以上的日誌到=D://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =D://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 ]  %m%n

其中log4j.appender.D.Threshold是一個過濾器，配置了表示輸出該級別及其以上的日誌，
另外log4j.appender.D.Append = true一般輸出到檔案的都會配置，而且配置成true，true：表示新增，false：表示覆蓋。

2.3、配置日誌資訊的格式

2.2中的log4j.properties配置檔案中，應該會看log4j.appender.*.layout，這表示輸出的日誌格式配置。

log4j.appender.*.layout值的選擇有以下幾種：

org.apache.log4j.HTMLLayout（以HTML表格形式佈局），
org.apache.log4j.PatternLayout（可以靈活地指定佈局模式），
org.apache.log4j.SimpleLayout（包含日誌資訊的級別和資訊字串），
org.apache.log4j.TTCCLayout（包含日誌產生的時間、執行緒、類別等等資訊）

一般我們都採用第二種org.apache.log4j.PatternLayout，自定義格式，如2.2中的log4j.properties配置檔案中，這種格式需要我們自定義，這裡小寶鴿如下定義：

log4j.appender.*.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

其中含義介紹：

%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在java中的使用

本專案使用的環境：eclipse + maven 。

3.1、新建maven專案

3.2、在pom.xml新增Log4j的jar包依賴：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.luo</groupId>
  <artifactId>log4j</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>war</packaging>

  <properties>
    <!-- log4j日誌檔案管理包版本 -->
    <slf4j.version>1.6.6</slf4j.version>
    <log4j.version>1.2.12</log4j.version>
  </properties>
  <dependencies>
    <!-- 日誌檔案管理包 -->
    <!-- log start -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>${log4j.version}</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>${slf4j.version}</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>${slf4j.version}</version>
    </dependency>
    <!-- log end -->
  </dependencies>
</project>

3.3、新增配置檔案和測試類

這裡寫圖片描述

log4j.properties內容如下：

### 設定###
log4j.rootLogger = debug,stdout,D,E

### 輸出資訊到控制擡 ###
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

### 輸出DEBUG 級別以上的日誌到=D://logs/debug.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = D://logs/debug.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 ]  %m%n

### 輸出ERROR 級別以上的日誌到=D://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =D://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 ]  %m%n

LogTest.java內容如下：

package com.luo.log;

import org.apache.log4j.Logger;

public class LogTest {

    private static Logger logger = Logger.getLogger(LogTest.class);    

    public static void main(String[] args) {      
        // 記錄debug級別的資訊    
        logger.debug("This is debug message.");    
        // 記錄info級別的資訊    
        logger.info("This is info message.");    
        // 記錄error級別的資訊    
        logger.error("This is error message.");   
    }    
}

3.4、執行結果

執行LogTest.java，會看到控制檯如下結果：

這裡寫圖片描述

另外，D:\logs下也會多了兩個log檔案，且內容如下圖：

這裡寫圖片描述

四、Log4j在web專案中的使用

繼續是剛剛的那個工程，這裡博主增加了spring + springmvc的配置，雖然spring配置這裡是必須的，一般一個springmvc專案裡面都會有spring。

4.1、將它轉成web專案

這裡寫圖片描述

4.2、新增spring和springmvc以及javaee-api的依賴

修改pom.xml如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.luo</groupId>
  <artifactId>log4j</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>war</packaging>

  <properties>
    <!-- log4j日誌檔案管理包版本 -->
    <slf4j.version>1.6.6</slf4j.version>
    <log4j.version>1.2.12</log4j.version>
    <!-- spring版本號 -->
    <spring.version>3.2.8.RELEASE</spring.version>
  </properties>
  <dependencies>
    <!-- 日誌檔案管理包 -->
    <!-- log start -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>${log4j.version}</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>${slf4j.version}</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>${slf4j.version}</version>
    </dependency>
    <!-- log end -->
    <!-- 新增Spring依賴 -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context-support</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aspects</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-web</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <!-- javaee-web-api包 注意和專案使用的JDK版本對應 -->
    <dependency>
        <groupId>javax</groupId>
        <artifactId>javaee-web-api</artifactId>
        <version>6.0</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.activiti</groupId>
        <artifactId>activiti-engine</artifactId>
        <version>5.17.0</version>
    </dependency>
    <dependency>
        <groupId>com.googlecode.xmemcached</groupId>
        <artifactId>xmemcached</artifactId>
        <version>1.3.2</version>
    </dependency>
  </dependencies>
</project>

4.3、配置web.xml

其實web專案中Log4j的使用與上面的區別就在於，web專案進行了log4j.properties的載入，web專案加上了如下配置：

<!-- 日誌記錄 -->
    <context-param>
        <!-- 日誌配置檔案路徑 -->
        <param-name>log4jConfigLocation</param-name>
        <param-value>classpath:log4j.properties</param-value>
    </context-param>
    <context-param>
        <!-- 日誌頁面的重新整理間隔 -->
        <param-name>log4jRefreshInterval</param-name>
        <param-value>6000</param-value>
    </context-param>

    <listener>
        <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
    </listener>

配置檔案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" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    id="WebApp_ID" version="2.5">

    <!-- 讀取spring配置檔案 -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:application.xml</param-value>
    </context-param>
    <!-- 設計路徑變數值 -->
    <context-param>
        <param-name>webAppRootKey</param-name>
        <param-value>springmvc.root</param-value>
    </context-param>

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <!-- 日誌記錄 -->
    <context-param>
        <!-- 日誌配置檔案路徑 -->
        <param-name>log4jConfigLocation</param-name>
        <param-value>classpath:log4j.properties</param-value>
    </context-param>
    <context-param>
        <!-- 日誌頁面的重新整理間隔 -->
        <param-name>log4jRefreshInterval</param-name>
        <param-value>6000</param-value>
    </context-param>

    <listener>
        <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
    </listener>

    <!-- springMVC核心配置 -->
    <servlet>
        <servlet-name>dispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <!--spingMVC的配置路徑  -->
            <param-value>classpath:springmvc/spring-mvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!-- 攔截設定 -->
    <servlet-mapping>
        <servlet-name>dispatcherSe
        rvlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

4.4、配置其他檔案如下目錄

這裡寫圖片描述

UserController.java內容如下：

package com.luo.controller;

import org.apache.log4j.Logger;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller  
public class UserController {  

    private static Logger logger = Logger.getLogger(UserController.class); 

    @RequestMapping("/")    
    public ModelAndView getIndex(){     
        // 記錄debug級別的資訊    
        logger.debug("This is debug message.");    
        // 記錄info級別的資訊    
        logger.info("This is info message.");    
        // 記錄error級別的資訊    
        logger.error("This is error message.");   

        ModelAndView mav = new ModelAndView("index");   
        return mav;    
    }    

}

spring-mvc.xml內容如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:p="http://www.springframework.org/schema/p"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:context="http://www.springframework.org/schema/context"
  xmlns:mvc="http://www.springframework.org/schema/mvc"
  xsi:schemaLocation="
    http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-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/mvc
    http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd">

     <mvc:annotation-driven /> 
     <!-- 掃描controller（controller層注入） -->
     <context:component-scan base-package="com.luo.controller">  </context:component-scan>

     <!-- 對模型檢視新增前後綴 -->
     <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"
      p:prefix="/WEB-INF/view/" p:suffix=".jsp"/>

</beans>

application.xml內容如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:p="http://www.springframework.org/schema/p"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:context="http://www.springframework.org/schema/context"
  xmlns:mvc="http://www.springframework.org/schema/mvc"
  xsi:schemaLocation="
    http://www.springframework.org/schema/beans
    http://www.springframework.org/schema/beans/spring-beans-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/mvc
    http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd">

     <mvc:annotation-driven /> 
     <!-- 掃描controller（controller層注入） -->
     <context:component-scan base-package="com.luo.controller">  </context:component-scan>

     <!-- 對模型檢視新增前後綴 -->
     <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"
      p:prefix="/WEB-INF/view/" p:suffix=".jsp"/>

</beans>

log4j.properties內容如下：

### 設定###
log4j.rootLogger = debug,stdout,D,E

### 輸出資訊到控制擡 ###
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

### 輸出DEBUG 級別以上的日誌到=D://logs/debug.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = D://logs/debug.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 ]  %m%n

### 輸出ERROR 級別以上的日誌到=D://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =D://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 ]  %m%n

index.jsp內容乳如下：

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<html>
<body>
<h2>Hello World!</h2>
</body>
</html>

4.5、執行結果

用執行web專案log4j，訪問：http://localhost:8080/log4j/，會看到eclipse的控制檯和log檔案的日誌：

這裡寫圖片描述

Log4j日誌在java專案中的使用（附工程原始碼）

一、關於Log4j日誌

二、Log4j使用前必須要了解的一些概念

三、Log4j在java中的使用

四、Log4j在web專案中的使用

五、原始碼下載

Log4j日誌在java專案中的使用（附工程原始碼）

在MFC中繪製地圖以及地理座標與螢幕座標轉換詳解（附工程原始碼）

一個基於百度地圖的桌面軟體（附工程原始碼）

java專案實戰——Java打飛機小遊戲（附完整原始碼）

微信開發獲取地理位置例項（java，非常詳細，附工程原始碼）

Java實現貪吃蛇小遊戲（附完整原始碼）

分享我如何在7年時間裡成長為阿里Java架構師（附學習路線圖）

SpringBoot 多模組專案實踐（附打包方法）

大數相乘問題--演算法思想及Java實現解析（附詳細註釋）

分享我如何在7年時間裏成長為阿裏Java架構師（附學習路線圖）

微信小程式之下拉列表實現（附完整原始碼）

微信小程式之側邊欄滑動實現（附完整原始碼）

神經網路常用啟用函式對比 sigmoid VS sofmax（附python原始碼）

Android 二維碼生成和識別（附Demo原始碼）

【資料結構與演算法】Huffman樹&&Huffman編碼（附完整原始碼）

【資料結構與演算法】字典樹（附完整原始碼）

android從入門到精通-專案實戰（心得及原始碼）

【資料結構與演算法】自己動手實現圖的BFS和DFS（附完整原始碼）

Servlet實現對SQLServer資料庫的增刪改查（含工程原始碼）

android 融雲 + 科大訊飛實現仿微信語音訊息轉換為文字（附DEMO原始碼）

Log4j日誌在java專案中的使用（附工程原始碼）

一、關於Log4j日誌

二、Log4j使用前必須要了解的一些概念

三、Log4j在java中的使用

四、Log4j在web專案中的使用

五、原始碼下載

相關推薦