詳解slf4j+logback在java工程中的配置
本文主要介紹一下slf4j+logback在java工程中的配置,面向的讀者主要是已經(jīng)對(duì)slf4j+logback有一定了解的同學(xué),但是在文章開(kāi)頭也做了一些知識(shí)鋪墊,下面咱們進(jìn)入正題。
在介紹slf4j+logback配置之前,首先對(duì)日志組件logback進(jìn)行介紹。
(一)日志組件logback的介紹及配置使用方法
一、logback的介紹
Logback是由log4j創(chuàng)始人設(shè)計(jì)的又一個(gè)開(kāi)源日志組件。logback當(dāng)前分成三個(gè)模塊:logback-core,logback- classic和logback-access。logback-core是其它兩個(gè)模塊的基礎(chǔ)模塊。logback-classic是log4j的一個(gè) 改良版本。此外logback-classic完整實(shí)現(xiàn)SLF4J API使你可以很方便地更換成其它日志系統(tǒng)如log4j或JDK14 Logging。logback-access訪問(wèn)模塊與Servlet容器集成提供通過(guò)Http來(lái)訪問(wèn)日志的功能。 Logback是要與SLF4J結(jié)合起來(lái)用兩個(gè)組件的官方網(wǎng)站如下:
logback的官方網(wǎng)站: http://logback.qos.ch
SLF4J的官方網(wǎng)站:http://www.slf4j.org
本文章用到的組件如下:請(qǐng)自行到官方網(wǎng)站下載!
logback-access-1.0.0.jar
logback-classic-1.0.0.jar
logback-core-1.0.0.jar
slf4j-api-1.6.0.jar
二、logback取代log4j的理由:
Logback和log4j是非常相似的,如果你對(duì)log4j很熟悉,那對(duì)logback很快就會(huì)得心應(yīng)手。下面列了logback相對(duì)于log4j的一些優(yōu)點(diǎn):
1、更快的實(shí)現(xiàn) Logback的內(nèi)核重寫(xiě)了,在一些關(guān)鍵執(zhí)行路徑上性能提升10倍以上。而且logback不僅性能提升了,初始化內(nèi)存加載也更小了。
2、非常充分的測(cè)試 Logback經(jīng)過(guò)了幾年,數(shù)不清小時(shí)的測(cè)試。Logback的測(cè)試完全不同級(jí)別的。在作者的觀點(diǎn),這是簡(jiǎn)單重要的原因選擇logback而不是log4j。
3、Logback-classic非常自然實(shí)現(xiàn)了SLF4j Logback-classic實(shí)現(xiàn)了 SLF4j。在使用SLF4j中,你都感覺(jué)不到logback-classic。而且因?yàn)閘ogback-classic非常自然地實(shí)現(xiàn)了SLF4J, 所 以切換到log4j或者其他,非常容易,只需要提供成另一個(gè)jar包就OK,根本不需要去動(dòng)那些通過(guò)SLF4JAPI實(shí)現(xiàn)的代碼。
4、非常充分的文檔 官方網(wǎng)站有兩百多頁(yè)的文檔。
5、自動(dòng)重新加載配置文件 當(dāng)配置文件修改了,Logback-classic能自動(dòng)重新加載配置文件。掃描過(guò)程快且安全,它并不需要另外創(chuàng)建一個(gè)掃描線程。這個(gè)技術(shù)充分保證了應(yīng)用程序能跑得很歡在JEE環(huán)境里面。
6、Lilith Lilith是log事件的觀察者,和log4j的chainsaw類(lèi)似。而lilith還能處理大數(shù)量的log數(shù)據(jù) 。
7、謹(jǐn)慎的模式和非常友好的恢復(fù) 在謹(jǐn)慎模式下,多個(gè)FileAppender實(shí)例跑在多個(gè)JVM下,能 夠安全地寫(xiě)道同一個(gè)日志文件。RollingFileAppender會(huì)有些限制。Logback的FileAppender和它的子類(lèi)包括 RollingFileAppender能夠非常友好地從I/O異常中恢復(fù)。
8、配置文件可以處理不同的情況 開(kāi)發(fā)人員經(jīng)常需要判斷不同的Logback配置文件在不同的環(huán)境下(開(kāi)發(fā),測(cè)試,生產(chǎn))。而這些配置文件僅僅只有一些很小的不同,可以通過(guò),和來(lái)實(shí)現(xiàn),這樣一個(gè)配置文件就可以適應(yīng)多個(gè)環(huán)境。
9、Filters(過(guò)濾器) 有些時(shí)候,需要診斷一個(gè)問(wèn)題,需要打出日志。在log4j,只有降低日志級(jí)別,不過(guò)這樣會(huì)打出大量的日志,會(huì)影響應(yīng)用性能。在Logback,你可以繼續(xù) 保持那個(gè)日志級(jí)別而除掉某種特殊情況,如alice這個(gè)用戶登錄,她的日志將打在DEBUG級(jí)別而其他用戶可以繼續(xù)打在WARN級(jí)別。要實(shí)現(xiàn)這個(gè)功能只需 加4行XML配置。可以參考MDCFIlter 。
10、SiftingAppender(一個(gè)非常多功能的Appender) 它可以用來(lái)分割日志文件根據(jù)任何一個(gè)給定的運(yùn)行參數(shù)。如,SiftingAppender能夠區(qū)別日志事件跟進(jìn)用戶的Session,然后每個(gè)用戶會(huì)有一個(gè)日志文件。
11、自動(dòng)壓縮已經(jīng)打出來(lái)的log RollingFileAppender在產(chǎn)生新文件的時(shí)候,會(huì)自動(dòng)壓縮已經(jīng)打出來(lái)的日志文件。壓縮是個(gè)異步過(guò)程,所以甚至對(duì)于大的日志文件,在壓縮過(guò)程中應(yīng)用不會(huì)受任何影響。
12、堆棧樹(shù)帶有包版本 Logback在打出堆棧樹(shù)日志時(shí),會(huì)帶上包的數(shù)據(jù)。
13、自動(dòng)去除舊的日志文件 通過(guò)設(shè)置TimeBasedRollingPolicy或者SizeAndTimeBasedFNATP的maxHistory屬性,你可以控制已經(jīng)產(chǎn)生日志文件的最大數(shù)量。如果設(shè)置maxHistory 12,那那些log文件超過(guò)12個(gè)月的都會(huì)被自動(dòng)移除。
總之,logback比log4j太優(yōu)秀了,讓我們的應(yīng)用全部建立logback上吧 !
三、Logback的配置介紹
1、Logger、appender及l(fā)ayout
Logger作為日志的記錄器,把它關(guān)聯(lián)到應(yīng)用的對(duì)應(yīng)的context上后,主要用于存放日志對(duì)象,也可以定義日志類(lèi)型、級(jí)別。
Appender主要用于指定日志輸出的目的地,目的地可以是控制臺(tái)、文件、遠(yuǎn)程套接字服務(wù)器、 MySQL、PostreSQL、 Oracle和其他數(shù)據(jù)庫(kù)、 JMS和遠(yuǎn)程UNIX Syslog守護(hù)進(jìn)程等。
Layout 負(fù)責(zé)把事件轉(zhuǎn)換成字符串,格式化的日志信息的輸出。
2、logger context
各個(gè)logger 都被關(guān)聯(lián)到一個(gè) LoggerContext,LoggerContext負(fù)責(zé)制造logger,也負(fù)責(zé)以樹(shù)結(jié)構(gòu)排列各logger。其他所有l(wèi)ogger也通過(guò)org.slf4j.LoggerFactory 類(lèi)的靜態(tài)方法getLogger取得。 getLogger方法以 logger名稱(chēng)為參數(shù)。用同一名字調(diào)用LoggerFactory.getLogger 方法所得到的永遠(yuǎn)都是同一個(gè)logger對(duì)象的引用。
3、有效級(jí)別及級(jí)別的繼承
Logger 可以被分配級(jí)別。級(jí)別包括:TRACE、DEBUG、INFO、WARN 和 ERROR,定義于ch.qos.logback.classic.Level類(lèi)。如果 logger沒(méi)有被分配級(jí)別,那么它將從有被分配級(jí)別的最近的祖先那里繼承級(jí)別。root logger 默認(rèn)級(jí)別是 DEBUG。
4、打印方法與基本的選擇規(guī)則
打印方法決定記錄請(qǐng)求的級(jí)別。例如,如果 L 是一個(gè) logger 實(shí)例,那么,語(yǔ)句 L.info("..")是一條級(jí)別為 INFO的記錄語(yǔ)句。記錄請(qǐng)求的級(jí)別在高于或等于其 logger 的有效級(jí)別時(shí)被稱(chēng)為被啟用,否則,稱(chēng)為被禁用。記錄請(qǐng)求級(jí)別為 p,其 logger的有效級(jí)別為 q,只有則當(dāng) p>=q時(shí),該請(qǐng)求才會(huì)被執(zhí)行。
該規(guī)則是 logback 的核心。級(jí)別排序?yàn)椋?TRACE < DEBUG < INFO < WARN < ERROR
四、Logback的默認(rèn)配置
如果配置文件 logback-test.xml 和 logback.xml 都不存在,那么 logback 默認(rèn)地會(huì)調(diào)用BasicConfigurator ,創(chuàng)建一個(gè)最小化配置。最小化配置由一個(gè)關(guān)聯(lián)到根 logger 的ConsoleAppender 組成。輸出用模式為%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 進(jìn)行格式化。root logger 默認(rèn)級(jí)別是 DEBUG。
1、Logback的配置文件
Logback 配置文件的語(yǔ)法非常靈活。正因?yàn)殪`活,所以無(wú)法用 DTD 或 XML schema 進(jìn)行定義。盡管如此,可以這樣描述配置文件的基本結(jié)構(gòu):以<configuration>開(kāi)頭,后面有零個(gè)或多個(gè)<appender>元素,有零個(gè)或多個(gè)<logger>元素,有最多一個(gè)<root>元素。
2、Logback默認(rèn)配置的步驟
(1). 嘗試在 classpath 下查找文件 logback-test.xml;
(2). 如果文件不存在,則查找文件 logback.xml;
(3). 如果兩個(gè)文件都不存在,logback 用 Bas icConfigurator 自動(dòng)對(duì)自己進(jìn)行配置,這會(huì)導(dǎo)致記錄輸出到控制臺(tái)。
3、Logback.xml 文件
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--定義日志文件的存儲(chǔ)地址 勿在 LogBack 的配置中使用相對(duì)路徑-->
<property name="LOG_HOME" value="c:/log" />
<!-- 控制臺(tái)輸出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- 日志輸出編碼 -->
<Encoding>UTF-8</Encoding>
<layout class="ch.qos.logback.classic.PatternLayout">
<!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級(jí)別從左顯示5個(gè)字符寬度%msg:日志消息,%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
</pattern>
</layout>
</appender>
<!-- 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<Encoding>UTF-8</Encoding>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件輸出的文件名-->
<FileNamePattern>${LOG_HOME}/myApp.log.%d{yyyy-MM-dd}.log</FileNamePattern>
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<!--格式化輸出:%d表示日期,%thread表示線程名,%-5level:級(jí)別從左顯示5個(gè)字符寬度%msg:日志消息,%n是換行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
</pattern>
</layout>
<!--日志文件最大的大小-->
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>10MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- show parameters for hibernate sql 專(zhuān)為 Hibernate 定制 -->
<logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
<logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
<logger name="org.hibernate.SQL" level="DEBUG" />
<logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
<logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />
<!-- 日志輸出級(jí)別 -->
<root level="INFO">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE" />
</root>
<!--日志異步到數(shù)據(jù)庫(kù) -->
<appender name="DB" class="ch.qos.logback.classic.db.DBAppender">
<!--日志異步到數(shù)據(jù)庫(kù) -->
<connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">
<!--連接池 -->
<dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">
<driverClass>com.mysql.jdbc.Driver</driverClass>
<url>jdbc:mysql://127.0.0.1:3306/databaseName</url>
<user>root</user>
<password>root</password>
</dataSource>
</connectionSource>
</appender> -->
</configuration>
五、在程序用引用Logback
package com.stu.system.action;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class BlogAction{
//定義一個(gè)全局的記錄器,通過(guò)LoggerFactory獲取
private final static Logger logger = LoggerFactory.getLogger(BlogAction.class);
/**
* @param args
*/
public static void main(String[] args) {
logger.info("logback 成功了");
logger.error("logback 成功了");
}
}
接下來(lái)我們介紹一下slf4j+logback在java工程中的配置。
一、基于maven的slf4j+logback pom.xml配置
<dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.10</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.1.2</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.1.2</version> </dependency>
二、在classpath目錄下新建logback.xml配置文件
<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:當(dāng)此屬性設(shè)置為true時(shí),配置文件如果發(fā)生改變,將會(huì)被重新加載,默認(rèn)值為true。
scanPeriod:設(shè)置監(jiān)測(cè)配置文件是否有修改的時(shí)間間隔,如果沒(méi)有給出時(shí)間單位,默認(rèn)單位是毫秒當(dāng)scan為true時(shí),此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘。
debug:當(dāng)此屬性設(shè)置為true時(shí),將打印出logback內(nèi)部日志信息,實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
<!-- 定義日志的根目錄 -->
<property name="LOG_HOME" value="/app/log" />
<!-- 定義日志文件名稱(chēng) -->
<property name="appName" value="netty"></property>
<!-- ch.qos.logback.core.ConsoleAppender 表示控制臺(tái)輸出 -->
<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
<Encoding>UTF-8</Encoding>
<!--
日志輸出格式:%d表示日期時(shí)間,%thread表示線程名,%-5level:級(jí)別從左顯示5個(gè)字符寬度
%logger{50} 表示logger名字最長(zhǎng)50個(gè)字符,否則按照句點(diǎn)分割。 %msg:日志消息,%n是換行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
</layout>
</appender>
<!-- 滾動(dòng)記錄文件,先將日志記錄到指定文件,當(dāng)符合某個(gè)條件時(shí),將日志記錄到其他文件 -->
<appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
<Encoding>UTF-8</Encoding>
<!-- 指定日志文件的名稱(chēng) -->
<file>${LOG_HOME}/${appName}.log</file>
<!--
當(dāng)發(fā)生滾動(dòng)時(shí),決定 RollingFileAppender 的行為,涉及文件移動(dòng)和重命名
TimeBasedRollingPolicy: 最常用的滾動(dòng)策略,它根據(jù)時(shí)間來(lái)制定滾動(dòng)策略,既負(fù)責(zé)滾動(dòng)也負(fù)責(zé)出發(fā)滾動(dòng)。
-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--
滾動(dòng)時(shí)產(chǎn)生的文件的存放位置及文件名稱(chēng) %d{yyyy-MM-dd}:按天進(jìn)行日志滾動(dòng)
%i:當(dāng)文件大小超過(guò)maxFileSize時(shí),按照i進(jìn)行文件滾動(dòng)
-->
<fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!--
可選節(jié)點(diǎn),控制保留的歸檔文件的最大數(shù)量,超出數(shù)量就刪除舊文件。假設(shè)設(shè)置每天滾動(dòng),
且maxHistory是365,則只保存最近365天的文件,刪除之前的舊文件。注意,刪除舊文件是,
那些為了歸檔而創(chuàng)建的目錄也會(huì)被刪除。
-->
<MaxHistory>365</MaxHistory>
<!--
當(dāng)日志文件超過(guò)maxFileSize指定的大小是,根據(jù)上面提到的%i進(jìn)行日志文件滾動(dòng) 注意此處配置SizeBasedTriggeringPolicy是無(wú)法實(shí)現(xiàn)按文件大小進(jìn)行滾動(dòng)的,必須配置timeBasedFileNamingAndTriggeringPolicy
-->
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>100MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<!--
日志輸出格式:%d表示日期時(shí)間,%thread表示線程名,%-5level:級(jí)別從左顯示5個(gè)字符寬度 %logger{50} 表示logger名字最長(zhǎng)50個(gè)字符,否則按照句點(diǎn)分割。 %msg:日志消息,%n是換行符
-->
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
</layout>
</appender>
<!--
logger主要用于存放日志對(duì)象,也可以定義日志類(lèi)型、級(jí)別
name:表示匹配的logger類(lèi)型前綴,也就是包的前半部分
level:要記錄的日志級(jí)別,包括 TRACE < DEBUG < INFO < WARN < ERROR
additivity:作用在于children-logger是否使用 rootLogger配置的appender進(jìn)行輸出,false:表示只用當(dāng)前l(fā)ogger的appender-ref,true:表示當(dāng)前l(fā)ogger的appender-ref和rootLogger的appender-ref都有效
-->
<!-- hibernate logger -->
<logger name="org.hibernate" level="error" />
<!-- Spring framework logger -->
<logger name="org.springframework" level="error" additivity="false"></logger>
<logger name="com.creditease" level="info" additivity="true">
<appender-ref ref="appLogAppender" />
</logger>
<!--
root與logger是父子關(guān)系,沒(méi)有特別定義則默認(rèn)為root,任何一個(gè)類(lèi)只會(huì)和一個(gè)logger對(duì)應(yīng),
要么是定義的logger,要么是root,判斷的關(guān)鍵在于找到這個(gè)logger,然后判斷這個(gè)logger的appender和level。
-->
<root level="info">
<appender-ref ref="stdout" />
<appender-ref ref="appLogAppender" />
</root>
</configuration>
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
JAVA中HTTP基本認(rèn)證(Basic Authentication)實(shí)現(xiàn)
HTTP 基本認(rèn)證是一種簡(jiǎn)單的認(rèn)證方法,本文主要介紹了JAVA中HTTP基本認(rèn)證(Basic Authentication),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-07-07
springboot如何去獲取前端傳遞的參數(shù)的實(shí)現(xiàn)
這篇文章主要介紹了springboot如何去獲取前端傳遞的參數(shù)的實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-05-05
SpringBoot CommandLineRunner的異步任務(wù)機(jī)制使用
這篇文章主要介紹了SpringBoot CommandLineRunner的異步任務(wù)機(jī)制使用,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-08-08
淺談圖片上傳利用request.getInputStream()獲取文件流時(shí)遇到的問(wèn)題
下面小編就為大家?guī)?lái)一篇淺談圖片上傳利用request.getInputStream()獲取文件流時(shí)遇到的問(wèn)題。小編覺(jué)得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-11-11
Java二維數(shù)組與動(dòng)態(tài)數(shù)組ArrayList類(lèi)詳解
這篇文章主要給大家介紹了關(guān)于Java二維數(shù)組與動(dòng)態(tài)數(shù)組ArrayList類(lèi)的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09
java編程創(chuàng)建型設(shè)計(jì)模式工廠方法模式示例詳解
這篇文章主要為大家介紹了java編程創(chuàng)建型設(shè)計(jì)模式之工廠方法模式的創(chuàng)建及案例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助2022-02-02
Spring中的@ConditionalOnProperty注解使用詳解
這篇文章主要介紹了Spring中的@ConditionalOnProperty注解使用詳解,在 spring boot 中有時(shí)候需要控制配置類(lèi)是否生效,可以使用 @ConditionalOnProperty 注解來(lái)控制 @Configuration 是否生效,需要的朋友可以參考下2024-01-01
Java新特性中Preview功能如何運(yùn)行調(diào)試詳解
這篇文章主要為大家介紹了Java新特性中Preview功能如何運(yùn)行調(diào)試詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-10-10
JFinal實(shí)現(xiàn)偽靜態(tài)的方法
JFinal 是基于 Java 語(yǔ)言的極速 WEB + ORM 框架,其核心設(shè)計(jì)目標(biāo)是開(kāi)發(fā)迅速、代碼量少、學(xué)習(xí)簡(jiǎn)單、功能強(qiáng)大、輕量級(jí)、易擴(kuò)展、Restful。這篇文章主要介紹了JFinal實(shí)現(xiàn)偽靜態(tài),需要的朋友可以參考下2018-04-04

