Java接口測(cè)試中日志框架Logback該怎樣使用

這篇文章主要為大家分析了Java接口測(cè)試中日志框架Logback該怎樣使用的相關(guān)知識(shí)點(diǎn)，內(nèi)容詳細(xì)易懂，操作細(xì)節(jié)合理，具有一定參考價(jià)值。如果感興趣的話，不妨跟著跟隨小編一起來(lái)看看，下面跟著小編一起深入學(xué)習(xí)“Java接口測(cè)試中日志框架Logback該怎樣使用”的知識(shí)吧。

一、引言

對(duì)于一個(gè)成熟的接口測(cè)試框架，日志管理這個(gè)是必不可少的。在開(kāi)發(fā)和調(diào)試階段，日志可以幫助我們更快的定位問(wèn)題；而在測(cè)試的運(yùn)維過(guò)程中，日志系統(tǒng)又可以幫助我們記錄大部分的異常信息，通

二、前言

Spring Boot 在所有內(nèi)部日志中使用Commons Logging，但是默認(rèn)配置也提供了對(duì)常用日志的支持，如：Java Util Logging，Log4J, Log4J2和Logback。每種 Logger 都可以通過(guò)配置使用控制臺(tái)或者文件輸出日志內(nèi)容。

三、LogBack、Slf4j和Log4j之間的關(guān)系

Slf4j是The Simple Logging Facade for Java的簡(jiǎn)稱，是一個(gè)簡(jiǎn)單日志門面抽象框架，它本身只提供了日志Facade API和一個(gè)簡(jiǎn)單的日志類實(shí)現(xiàn)，一般常配合Log4j，LogBack，java.util.logging使用。Slf4j作為應(yīng)用層的Log接入時(shí)，程序可以根據(jù)實(shí)際應(yīng)用場(chǎng)景動(dòng)態(tài)調(diào)整底層的日志實(shí)現(xiàn)框架(Log4j/LogBack/JdkLog…)。

LogBack和Log4j都是開(kāi)源日記工具庫(kù)，LogBack 是 Log4j 的改良版本，比 Log4j 擁有更多的特性，同時(shí)也帶來(lái)很大性能提升，同時(shí)天然支持SLF4J。

LogBack 官方建議配合 Slf4j 使用，這樣可以靈活地替換底層日志框架。

TIPS：為了優(yōu)化log4j，以及更大性能的提升，Apache基金會(huì)已經(jīng)著手開(kāi)發(fā)了log4j 2.0, 其中也借鑒和吸收了logback的一些先進(jìn)特性。

四、默認(rèn)日志Logback

默認(rèn)情況下，Spring Boot 會(huì)用 Logback 來(lái)記錄日志，并用 INFO 級(jí)別輸出到控制臺(tái)。在運(yùn)行應(yīng)用程序和其他例子時(shí)，你應(yīng)該已經(jīng)看到很多INFO級(jí)別的日志了。

從上圖可以看到，日志輸出內(nèi)容元素具體如下：

• 時(shí)間日期：精確到毫秒

• 日志級(jí)別：ERROR, WARN, INFO, DEBUG or TRACE

• Logger名：通常使用源代碼的類名

• 分隔符：--- 標(biāo)識(shí)實(shí)際日志的開(kāi)始

• 進(jìn)程 ID

• 線程名：方括號(hào)括起來(lái)（可能會(huì)截?cái)嗫刂婆_(tái)輸出）

• 日志內(nèi)容

五、配置詳解

1、添加日志依賴

假如maven依賴中添加了spring-boot-starter-logging：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

那么，我們的Spring Boot應(yīng)用將自動(dòng)使用 logback 作為應(yīng)用日志框架，Spring Boot 啟動(dòng)的時(shí)候，由 org.springframework.boot.logging.Logging-Application-Listener根據(jù)情況初始化并使用。

但是呢，實(shí)際開(kāi)發(fā)中我們不需要直接添加該依賴，你會(huì)發(fā)現(xiàn)spring-boot-starter其中包含了 spring-boot-starter-logging，該依賴內(nèi)容就是 Spring Boot 默認(rèn)的日志框架 logback

2、配置文件

Spring Boot 官方推薦優(yōu)先使用帶有-spring的文件名作為你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名為logback-spring.xml的日志配置文件，spring boot可以為它添加一些 spring boot特有的配置項(xiàng)（下面會(huì)提到）。并且放在src/main/resources下面即可。

配置文件 logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!-- 日志根目錄-->
    <springProperty scope="context" name="LOG_HOME" source="logging.path" defaultValue="./logs/spring-boot-logback"/>

    <!-- 日志級(jí)別 -->
    <springProperty scope="context" name="LOG_ROOT_LEVEL" source="logging.level.root" defaultValue="DEBUG"/>

    <!--  標(biāo)識(shí)這個(gè)"STDOUT" 將會(huì)添加到這個(gè)logger -->
    <springProperty scope="context" name="STDOUT" source="log.stdout" defaultValue="STDOUT"/>

    <!-- 日志文件名稱-->
    <property name="LOG_PREFIX" value="spring-boot-logback" />

    <!-- 日志文件編碼-->
    <property name="LOG_CHARSET" value="UTF-8" />

    <!-- 日志文件路徑+日期-->
    <property name="LOG_DIR" value="${LOG_HOME}/%d{yyyyMMdd}" />

    <!--對(duì)日志進(jìn)行格式化-->
    <property name="LOG_MSG" value="- | [%X{requestUUID}] | [%d{yyyyMMdd HH:mm:ss.SSS}] | [%level] | [${HOSTNAME}] | [%thread] | [%logger{36}] | --> %msg|%n "/>

    <!--文件大小，默認(rèn)10MB-->
    <property name="MAX_FILE_SIZE" value="50MB" />

    <!-- 配置日志的滾動(dòng)時(shí)間 ，表示只保留最近 10 天的日志-->
    <property name="MAX_HISTORY" value="10"/>

    <!--輸出到控制臺(tái)-->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 輸出的日志內(nèi)容格式化-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>${LOG_MSG}</pattern>
        </layout>
    </appender>

    <!--輸出到文件-->
    <appender name="0" class="ch.qos.logback.core.rolling.RollingFileAppender">
    </appender>

    <!-- 定義 ALL 日志的輸出方式:-->
    <appender name="FILE_ALL" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件路徑，日志文件名稱-->
        <File>${LOG_HOME}/all_${LOG_PREFIX}.log</File>

        <!-- 設(shè)置滾動(dòng)策略，當(dāng)天的日志大小超過(guò) ${MAX_FILE_SIZE} 文件大小時(shí)候，新的內(nèi)容寫(xiě)入新的文件， 默認(rèn)10MB -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

            <!--日志文件路徑，新的 ALL 日志文件名稱，“ i ” 是個(gè)變量 -->
            <FileNamePattern>${LOG_DIR}/all_${LOG_PREFIX}%i.log</FileNamePattern>

            <!-- 配置日志的滾動(dòng)時(shí)間 ，表示只保留最近 10 天的日志-->
            <MaxHistory>${MAX_HISTORY}</MaxHistory>

            <!--當(dāng)天的日志大小超過(guò) ${MAX_FILE_SIZE} 文件大小時(shí)候，新的內(nèi)容寫(xiě)入新的文件， 默認(rèn)10MB-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>

        </rollingPolicy>

        <!-- 輸出的日志內(nèi)容格式化-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>${LOG_MSG}</pattern>
        </layout>
    </appender>

    <!-- 定義 ERROR 日志的輸出方式:-->
    <appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 下面為配置只輸出error級(jí)別的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <OnMismatch>DENY</OnMismatch>
            <OnMatch>ACCEPT</OnMatch>
        </filter>
        <!--日志文件路徑，日志文件名稱-->
        <File>${LOG_HOME}/err_${LOG_PREFIX}.log</File>

        <!-- 設(shè)置滾動(dòng)策略，當(dāng)天的日志大小超過(guò) ${MAX_FILE_SIZE} 文件大小時(shí)候，新的內(nèi)容寫(xiě)入新的文件， 默認(rèn)10MB -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

            <!--日志文件路徑，新的 ERR 日志文件名稱，“ i ” 是個(gè)變量 -->
            <FileNamePattern>${LOG_DIR}/err_${LOG_PREFIX}%i.log</FileNamePattern>

            <!-- 配置日志的滾動(dòng)時(shí)間 ，表示只保留最近 10 天的日志-->
            <MaxHistory>${MAX_HISTORY}</MaxHistory>

            <!--當(dāng)天的日志大小超過(guò) ${MAX_FILE_SIZE} 文件大小時(shí)候，新的內(nèi)容寫(xiě)入新的文件， 默認(rèn)10MB-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${MAX_FILE_SIZE}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

        <!-- 輸出的日志內(nèi)容格式化-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>${LOG_MSG}</Pattern>
        </layout>
    </appender>

    <!-- additivity 設(shè)為false,則logger內(nèi)容不附加至root ，配置以配置包下的所有類的日志的打印，級(jí)別是 ERROR-->

    <logger name="org.springframework"     level="ERROR" />
    <logger name="org.apache.commons"      level="ERROR" />
    <logger name="org.apache.zookeeper"    level="ERROR"  />
    <logger name="com.alibaba.dubbo.monitor" level="ERROR"/>
    <logger name="com.alibaba.dubbo.remoting" level="ERROR" />

    <!-- ${LOG_ROOT_LEVEL} 日志級(jí)別 -->
    <root level="${LOG_ROOT_LEVEL}">

        <!-- 標(biāo)識(shí)這個(gè)"${STDOUT}"將會(huì)添加到這個(gè)logger -->
        <appender-ref ref="${STDOUT}"/>

        <!-- FILE_ALL 日志輸出添加到 logger -->
        <appender-ref ref="FILE_ALL"/>

        <!-- FILE_ERROR 日志輸出添加到 logger -->
        <appender-ref ref="FILE_ERROR"/>
    </root>

</configuration>

配置文件 application.yml

server:
  port: 8888  # 端口號(hào)

logging:
  path: ./logs/zuozewei
  level:
    root: info #日志級(jí)別從低到高分為TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果設(shè)置為WARN，則低于WARN的信息都不會(huì)輸出

日志會(huì)每天新建一個(gè)文件夾，日文文件配置的每50兆，一個(gè)文本文件，超過(guò)新寫(xiě)入一個(gè)

文件夾：20181228
文件夾內(nèi)容：all_spring-boot-logback0.log 
文件夾內(nèi)容：all_spring-boot-logback1.log
文件夾內(nèi)容：all_spring-boot-logback2.log

文件夾內(nèi)容：err_spring-boot-logback0.log

六、多環(huán)境日志輸出

根據(jù)不同環(huán)境（prod:生產(chǎn)環(huán)境，test:測(cè)試環(huán)境，dev:開(kāi)發(fā)環(huán)境）來(lái)定義不同的日志輸出，在 logback-spring.xml中使用 springProfile 節(jié)點(diǎn)來(lái)定義，方法如下：

文件名稱不是 logback.xml，想使用spring擴(kuò)展profile支持，要以logback-spring.xml 命名

<!-- 生產(chǎn)環(huán)境生效 -->
    <springProfile name="prod">
        <root level="error">
            <appender-ref ref="STDOUT" />
            <appender-ref ref="FILE" />
        </root>
    </springProfile>


    <!-- 測(cè)試和開(kāi)發(fā)環(huán)境日志級(jí)別為INFO/并且記錄日志文件 -->
    <springProfile name="dev,test">
        <!-- 日志輸出級(jí)別 -->
        <root level="INFO">
            <appender-ref ref="STDOUT" />
            <appender-ref ref="FILE" />
        </root>
    </springProfile>

可以啟動(dòng)服務(wù)的時(shí)候指定 profile （如不指定使用默認(rèn)），如指定prod 的方式為：

java -jar xxx.jar –spring.profiles.active=prod

七、單元測(cè)試

此處我選擇使用lombok效率插件，所以只需要@Slf4j注解即可簡(jiǎn)化private Logger logger = LoggerFactory.getLogger(this.getClass())的寫(xiě)法
RunWith(SpringRunner.class)

@SpringBootTest
@Slf4j
public class LogbackdemoApplicationTests {

    @Test
    public void contextLoads() {
        log.info("輸出info");
        log.debug("輸出debug");
        log.error("輸出error");
    }

}

生成的日志：

- | [] | [20181228 22:53:20.756] | [INFO] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> Starting LogbackdemoApplicationTests on 192.168.1.18 with PID 82507 (started by apple in /Users/apple/Downloads/Springboot-logback-demo)|
- | [] | [20181228 22:53:20.762] | [INFO] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> No active profile set, falling back to default profiles: default|
- | [] | [20181228 22:53:21.590] | [INFO] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> Started LogbackdemoApplicationTests in 1.69 seconds (JVM running for 3.525)|
- | [] | [20181228 22:53:21.955] | [INFO] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> 輸出info|
- | [] | [20181228 22:53:21.955] | [ERROR] | [192.168.1.18] | [main] | [c.z.l.LogbackdemoApplicationTests] | --> 輸出error|

八、工程目錄

九、總結(jié)

到此為止終于介紹完 Logback日志框架了，平時(shí)使用的時(shí)候推薦用自定義logback-spring.xml來(lái)配置，代碼中使用日志也很簡(jiǎn)單，類里面添加private Logger logger = LoggerFactory.getLogger(this.getClass()); 即可，如果使用lombok效率插件需要@Slf4j注解。

Java的特點(diǎn)有哪些

Java的特點(diǎn)有哪些 1.Java語(yǔ)言作為靜態(tài)面向?qū)ο缶幊陶Z(yǔ)言的代表，實(shí)現(xiàn)了面向?qū)ο罄碚?，允許程序員以優(yōu)雅的思維方式進(jìn)行復(fù)雜的編程。 2.Java具有簡(jiǎn)單性、面向?qū)ο?、分布式、安全性、平臺(tái)獨(dú)立與可移植性、動(dòng)態(tài)性等特點(diǎn)。 3.使用Java可以編寫(xiě)桌面應(yīng)用程序、Web應(yīng)用程序、分布式系統(tǒng)和嵌入式系統(tǒng)應(yīng)用程序等。

關(guān)于“Java接口測(cè)試中日志框架Logback該怎樣使用”就介紹到這了,更多相關(guān)內(nèi)容可以搜索億速云以前的文章，希望能夠幫助大家答疑解惑，請(qǐng)多多支持億速云網(wǎng)站！