《手把手教你》系列基礎篇（八十六）-java+ selenium自動化測試-框架設計基礎-Log4j實現日誌輸出（詳解教程）

2022 年 4 月 12 日
筆記
java+selenium自動化測試

1.簡介

　　自動化測試中如何輸出日誌文件。任何軟體，都會涉及到日誌輸出。所以，在測試人員報bug，特別是崩潰的bug，一般都要提供軟體產品的日誌文件。開發通過看日誌文件，知道這個崩潰產生的原因，至少知道觸發崩潰的條件是什麼。同樣在自動化測試框架設計，日誌文件輸出是不可或缺的。我們習慣通過日誌輸出來記錄我們用例執行的情況。當然測試報告更直觀，但是如果出現問題，往往是日誌文件更有效。這裡我們介紹如何通過Log4j.jar來幫助我們輸出一個日誌。

發現 Apache Log4j2 近日被公開的遠程程式碼執行漏洞在全球引起了重大影響。

//www.oschina.net/news/172999

2.Log4j簡介

Log4j有三個主要的組件：Loggers(記錄器)，Appenders (輸出源)和Layouts(布局)。這裡可簡單理解為日誌類別，日誌要輸出的地方和日誌以何種形式輸出。綜合使用這三個組件可以輕鬆地記錄資訊的類型和級別，並可以在運行時控制日誌輸出的樣式和位置。

2.1Loggers

Loggers組件在此系統中被分為五個級別：DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序的，DEBUG < INFO < WARN < ERROR < FATAL，分別用來指定這條日誌資訊的重要程度，明白這一點很重要，Log4j有一個規則：只輸出級別不低於設定級別的日誌資訊，假設Loggers級別設定為INFO，則INFO、WARN、ERROR和FATAL級別的日誌資訊都會輸出，而級別比INFO低的DEBUG則不會輸出。

2.2Appenders

禁用和使用日誌請求只是Log4j的基本功能，Log4j日誌系統還提供許多強大的功能，比如允許把日誌輸出到不同的地方，如控制台（Console）、文件（Files）等，可以根據天數或者文件大小產生新的文件，可以以流的形式發送到其它地方等等。

常使用的類如下：

org.apache.log4j.ConsoleAppender（控制台）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌文件）
org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）
org.apache.log4j.WriterAppender（將日誌資訊以流格式發送到任意指定的地方）

配置模式：

log4j.appender.appenderName = className
log4j.appender.appenderName.Option1 = value1
…
log4j.appender.appenderName.OptionN = valueN

2.3Layouts

有時用戶希望根據自己的喜好格式化自己的日誌輸出，Log4j可以在Appenders的後面附加Layouts來完成這個功能。Layouts提供四種日誌輸出樣式，如根據HTML樣式、自由指定樣式、包含日誌級別與資訊的樣式和包含日誌時間、執行緒、類別等資訊的樣式。

常使用的類如下：

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

配置模式：

log4j.appender.appenderName.layout =className
log4j.appender.appenderName.layout.Option1 = value1
…
log4j.appender.appenderName.layout.OptionN = valueN

3.配置詳解

在實際應用中，要使Log4j在系統中運行須事先設定配置文件。配置文件事實上也就是對Logger、Appender及Layout進行相應設定。Log4j支援兩種配置文件格式，一種是XML格式的文件，一種是properties屬性文件。下面以properties屬性文件為例介紹log4j.properties的配置。

3.1配置根Logger

log4j.rootLogger = [ level ] , appenderName1, appenderName2, …（默認輸出目的地，當前端傳入類名）

log4j.additivity.org.apache=false：表示Logger不會在父Logger的appender里輸出，默認為true。

level ：設定日誌記錄的最低級別，可設的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級別，Log4j建議只使用中間四個級別。通過在這裡設定級別，您可以控制應用程式中相應級別的日誌資訊的開關，比如在這裡設定了INFO級別，則應用程式中所有DEBUG級別的日誌資訊將不會被列印出來。

appenderName：就是指定日誌資訊要輸出到哪裡。可以同時指定多個輸出目的地，用逗號隔開。

例如：log4j.rootLogger＝INFO,A1,B2,C3

3.2配置日誌資訊輸出目的地（appender）

log4j.appender.appenderName = className

appenderName：自定義appderName，在log4j.rootLogger設置中使用；

className：可設值如下：

(1)org.apache.log4j.ConsoleAppender（控制台）

(2)org.apache.log4j.FileAppender（文件）

(3)org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌文件）

(4)org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）

(5)org.apache.log4j.WriterAppender（將日誌資訊以流格式發送到任意指定的地方）

(1)ConsoleAppender選項：

Threshold=WARN：指定日誌資訊的最低輸出級別，默認為DEBUG。

ImmediateFlush=true：表示所有消息都會被立即輸出，設為false則不輸出，默認值是true。

Target=System.err：默認值是System.out。

(2)FileAppender選項：

Threshold=WARN：指定日誌資訊的最低輸出級別，默認為DEBUG。

ImmediateFlush=true：表示所有消息都會被立即輸出，設為false則不輸出，默認值是true。

Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內容，默認值是true。

File=D:/logs/logging.log4j：指定消息輸出到logging.log4j文件中。

(3)DailyRollingFileAppender選項：

Threshold=WARN：指定日誌資訊的最低輸出級別，默認為DEBUG。

ImmediateFlush=true：表示所有消息都會被立即輸出，設為false則不輸出，默認值是true。

Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內容，默認值是true。

File=D:/logs/logging.log4j：指定當前消息輸出到logging.log4j文件中。

DatePattern=’.’yyyy-MM：每月滾動一次日誌文件，即每月產生一個新的日誌文件。當前月的日誌文件名為logging.log4j，前一個月的日誌文件名為logging.log4j.yyyy-MM。

另外，也可以指定按周、天、時、分等來滾動日誌文件，對應的格式如下：

1)’.’yyyy-MM：每月

2)’.’yyyy-ww：每周

3)’.’yyyy-MM-dd：每天

4)’.’yyyy-MM-dd-a：每天兩次

5)’.’yyyy-MM-dd-HH：每小時

6)’.’yyyy-MM-dd-HH-mm：每分鐘

(4)RollingFileAppender選項：

Threshold=WARN：指定日誌資訊的最低輸出級別，默認為DEBUG。

ImmediateFlush=true：表示所有消息都會被立即輸出，設為false則不輸出，默認值是true。

Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內容，默認值是true。

File=D:/logs/logging.log4j：指定消息輸出到logging.log4j文件中。

MaxFileSize=100KB：後綴可以是KB, MB 或者GB。在日誌文件到達該大小時，將會自動滾動，即將原來的內容移到logging.log4j.1文件中。

MaxBackupIndex=2：指定可以產生的滾動文件的最大數，例如，設為2則可以產生logging.log4j.1，logging.log4j.2兩個滾動文件和一個logging.log4j文件。

3.3配置日誌資訊的輸出格式（Layout）

log4j.appender.appenderName.layout=className

className：可設值如下：

(1)org.apache.log4j.HTMLLayout（以HTML表格形式布局）

(2)org.apache.log4j.PatternLayout（可以靈活地指定布局模式）

(3)org.apache.log4j.SimpleLayout（包含日誌資訊的級別和資訊字元串）

(4)org.apache.log4j.TTCCLayout（包含日誌產生的時間、執行緒、類別等等資訊）

(1)HTMLLayout選項：

LocationInfo=true：輸出java文件名稱和行號，默認值是false。

Title=My Logging：默認值是Log4J Log Messages。

(2)PatternLayout選項：

ConversionPattern=%m%n：設定以怎樣的格式顯示消息。

格式化符號說明：

%p：輸出日誌資訊的優先順序，即DEBUG，INFO，WARN，ERROR，FATAL。
%d：輸出日誌時間點的日期或時間，默認格式為ISO8601，也可以在其後指定格式，如：%d{yyyy/MM/dd HH:mm:ss,SSS}。
%r：輸出自應用程式啟動到輸出該log資訊耗費的毫秒數。
%t：輸出產生該日誌事件的執行緒名。
%l：輸出日誌事件的發生位置，相當於%c.%M(%F:%L)的組合，包括類全名、方法、文件名以及在程式碼中的行數。例如：test.TestLog4j.main(TestLog4j.java:10)。
%c：輸出日誌資訊所屬的類目，通常就是所在類的全名。
%M：輸出產生日誌資訊的方法名。
%F：輸出日誌消息產生時所在的文件名稱。
%L:：輸出程式碼中的行號。
%m:：輸出程式碼中指定的具體日誌資訊。
%n：輸出一個回車換行符，Windows平台為"rn"，Unix平台為"n"。
%x：輸出和當前執行緒相關聯的NDC(嵌套診斷環境)，尤其用到像java servlets這樣的多客戶多執行緒的應用中。
%%：輸出一個"%"字元。

另外，還可以在%與格式字元之間加上修飾符來控制其最小長度、最大長度、和文本的對齊方式。如：

1) c：指定輸出category的名稱，最小的長度是20，如果category的名稱長度小於20的話，默認的情況下右對齊。

2)%-20c：”-“號表示左對齊。

3)%.30c：指定輸出category的名稱，最大的長度是30，如果category的名稱長度大於30的話，就會將左邊多出的字元截掉，但小於30的話也不會補空格。

附：Log4j比較全面的配置

Log4j配置文件實現了輸出到控制台、文件、回滾文件、發送日誌郵件、輸出到資料庫日誌表、自定義標籤等全套功能。

log4j.rootLogger=DEBUG,console,dailyFile,im

log4j.additivity.org.apache=true

# 控制台(console)

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.err
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 日誌文件(logFile)

log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
log4j.appender.logFile.ImmediateFlush=true
log4j.appender.logFile.Append=true
log4j.appender.logFile.File=D:/logs/log.log4j
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 回滾文件(rollingFile)

log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.Threshold=DEBUG
log4j.appender.rollingFile.ImmediateFlush=true
log4j.appender.rollingFile.Append=true
log4j.appender.rollingFile.File=D:/logs/log.log4j
log4j.appender.rollingFile.MaxFileSize=200KB
log4j.appender.rollingFile.MaxBackupIndex=50
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 定期回滾日誌文件(dailyFile)

log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=DEBUG
log4j.appender.dailyFile.ImmediateFlush=true
log4j.appender.dailyFile.Append=true
log4j.appender.dailyFile.File=D:/logs/log.log4j
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 應用於socket

log4j.appender.socket=org.apache.log4j.RollingFileAppender
log4j.appender.socket.RemoteHost=localhost
log4j.appender.socket.Port=5001
log4j.appender.socket.LocationInfo=true

# Set up for Log Factor 5

log4j.appender.socket.layout=org.apache.log4j.PatternLayout
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# Log Factor 5 Appender

log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000

# 發送日誌到指定郵件

log4j.appender.mail=org.apache.log4j.net.SMTPAppender
log4j.appender.mail.Threshold=FATAL
log4j.appender.mail.BufferSize=10
log4j.appender.mail.From = [email protected]
log4j.appender.mail.SMTPHost=mail.com
log4j.appender.mail.Subject=Log4J Message
log4j.appender.mail.To= [email protected]
log4j.appender.mail.layout=org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 應用於資料庫

log4j.appender.database=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.database.URL=jdbc:mysql://localhost:3306/test
log4j.appender.database.driver=com.mysql.jdbc.Driver
log4j.appender.database.user=root
log4j.appender.database.password=
log4j.appender.database.sql=INSERT INTO LOG4J (Message) VALUES('=[%-5p] %d(%r) --> [%t] %l: %m %x %n')
log4j.appender.database.layout=org.apache.log4j.PatternLayout
log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 自定義Appender

log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
log4j.appender.im.host = mail.cybercorlin.net
log4j.appender.im.username = username
log4j.appender.im.password = password
log4j.appender.im.recipient = [email protected]
log4j.appender.im.layout=org.apache.log4j.PatternLayout
log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

log4j的強大功能無可置疑，但實際應用中免不了遇到某個功能需要輸出獨立的日誌文件的情況，怎樣才能把所需的內容從原有日誌中分離，形成單獨的日誌文件呢？其實只要在現有的log4j基礎上稍加配置即可輕鬆實現這一功能。

4.項目實戰

4.1準備工作

1.下載地址：//logging.apache.org/log4j/1.2/download.html 宏哥可以通過下載地址下載最新版本是1.2.17。如下圖所示：

2.下載好了之後，將jar包添加到Eclipse項目的lib中去。如下圖所示：

3.在當前項目新建一個Log4j.properties的文件，內容如下圖所示：

4.參考Log4j.properties程式碼

log4j.rootLogger=INFO,CONSOLE,R,HTML,TTCC
 
// \u5B9A\u4E49\u4E00\u4E2Aappender
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.TTCC=org.apache.log4j.RollingFileAppender
log4j.appender.HTML=org.apache.log4j.FileAppender
 
// \u5B9A\u4E49log\u6587\u4EF6\u4FDD\u5B58\u8DEF\u5F84\uFF0C\u4E09\u79CD\u65E5\u5FD7\u6587\u4EF6\u683C\u5F0F
log4j.appender.R.File=./Log/testlog.log
log4j.appender.TTCC.File=./Log/testlog1.log
log4j.appender.HTML.File=./Log/application.html

// \u5B9A\u4E49layout\u548Cpattern
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern= %5p [%t] (%F:%L)- %m%n
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d - %c -%p - %m%n
log4j.appender.TTCC.layout=org.apache.log4j.TTCCLayout
log4j.appender.TTCC.layout.DateFormat=ISO8601
log4j.appender.HTML.layout=org.apache.log4j.HTMLLayout
log4j.appender.HTML.layout.Title=Application log
log4j.appender.HTML.layout.LocationInfo=true

4.2測試日誌輸出

1.新建一個測試類，測試日誌輸出。

4.3程式碼設計

4.4參考程式碼

package testSuites;

import java.util.concurrent.TimeUnit;

import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
import org.openqa.selenium.By;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.chrome.ChromeDriver;

/**
 * @author 北京-宏哥
 * 
 * @公眾號:北京宏哥
 * 
 * 《手把手教你》系列基礎篇（八十六）-java+ selenium自動化測試-框架設計基礎-Log4j實現日誌輸出（詳解教程）
 *
 * 2022年3月23日
 */

public class TestBaidu {

    public static void main(String[] args) {

        Logger logger = Logger.getLogger("baidu");

        PropertyConfigurator.configure(".\\Log4j.properties");

        // 打開瀏覽器
        System.setProperty("webdriver.chrome.driver",".\\Tools\\chromedriver.exe");
        WebDriver driver = new ChromeDriver();
        logger.info("啟動瀏覽器");
        
        driver.manage().window().maximize();
        logger.info("最大化瀏覽器");

        driver.manage().timeouts().implicitlyWait(10, TimeUnit.SECONDS);
        logger.info("隱式等待10秒");

        driver.get("//www.baidu.com");
        logger.info("打開百度首頁");

        driver.findElement(By.id("kw")).sendKeys("Selenium");
        logger.info("在搜索輸入框輸入selenium");
        
        driver.close();
        logger.info("退出瀏覽器");

    }

}

4.5運行程式碼

1.運行程式碼，右鍵Run AS->Java Appliance，控制台輸出，如下圖所示：

2.運行程式碼後電腦端的瀏覽器的動作，如下小影片所示：

3.運行完後，右鍵刷新Log文件夾，可以看到三個日誌文件。如下圖所示：

4.分別打開三種文件，如下圖所示：

（1）application.html

（2） testlog.log

（3）testlog1.log

5.小結

你的application.html在Eclipse中打開出現中文亂碼，但是你看到宏哥沒有，那是因為宏哥自己加上了編碼格式。這個還是前邊測試報告說的那個問題，要想正常需要修改源碼打jar包。

好了，時間也不早了，今天就分享和講解到這裡，希望對您有所幫助，感謝您耐心地閱讀！

Tags: java+selenium自動化測試