摘要:一日志概述領域存在多種日志框架,目前常用的日志框架包括,,,,,。開銷更高三與其他日志組件調用關系包名說明版本的橋接器,你需要將加入。的橋接器,原生日志框架。
一、Java日志概述
java領域存在多種日志框架,目前常用的日志框架包括Log4j 1,Log4j 2,Commons Logging,Slf4j,Logback,Jul。
Commons Logging和Slf4j是日志門面(門面模式是軟件工程中常用的一種軟件設計模式,也被稱為正面模式、外觀模式。它為子系統中的一組接口提供一個統一的高層接口,使得子系統更容易使用)。Log4j和Logback則是具體的日志實現方案。可以簡單的理解為接口與接口的實現,調用者只需要關注接口而無需關注具體的實現,做到解耦。
Commons Logging Apache基金會所屬的項目,是一套Java日志接口,之前叫Jakarta Commons Logging,后更名為Commons Logging。
Slf4j 類似于Commons Logging,是一套簡易Java日志門面,本身并無日志的實現。(Simple Logging Facade for Java,縮寫Slf4j)。
Logback 一套日志組件的實現(Slf4j陣營)。
Logback必須配合Slf4j使用。由于Logback和Slf4j是同一個作者,其兼容性不言而喻。
比較常用的組合使用方式是Slf4j與Logback組合使用,Commons Logging與Log4j組合使用。
Log4j Apache Log4j是一個基于Java的日志記錄工具。它是由Ceki Gülcü首創的,現在則是Apache軟件基金會的一個項目。 Log4j是幾種Java日志框架之一。
Log4j 2 Apache Log4j 2是apache開發的一款Log4j的升級產品。
Log4j 2與Log4j 1發生了很大的變化,Log4j 2不兼容Log4j 1。
Jul (Java Util Logging),自Java1.4以來的官方日志實現。
二、Commons Logging與Slf4j實現機制對比Commons Logging是通過動態查找機制,在程序運行時,使用自己的ClassLoader尋找和載入本地具體的實現。詳細策略可以查看commons-logging-*.jar包中的org.apache.commons.logging.impl.LogFactoryImpl.java文件。由于Osgi不同的插件使用獨立的ClassLoader,Osgi的這種機制保證了插件互相獨立, 其機制限制了Commons Logging在Osgi中的正常使用。Slf4j在編譯期間,靜態綁定本地的Log庫,因此可以在Osgi中正常使用。它是通過查找類路徑下org.slf4j.impl.StaticLoggerBinder,然后在StaticLoggerBinder中進行綁定。
如果是在一個新的項目中建議使用Slf4j與Logback組合,這樣有如下的幾個優點:
Slf4j實現機制決定Slf4j限制較少,使用范圍更廣。由于Slf4j在編譯期間,靜態綁定本地的LOG庫使得通用性要比Commons Logging要好。
Logback擁有更好的性能。
Commons Logging開銷更高
三、Slf4j與其他日志組件調用關系jar包名 | 說明 |
---|---|
slf4j-log4j12-1.7.13.jar | Log4j1.2版本的橋接器,你需要將Log4j.jar加入Classpath。 |
slf4j-jdk14-1.7.13.jar | java.util.logging的橋接器,Jdk原生日志框架。 |
slf4j-nop-1.7.13.jar | NOP橋接器,默默丟棄一切日志。 |
slf4j-simple-1.7.13.jar | 一個簡單實現的橋接器,該實現輸出所有事件到System.err. 只有Info以及高于該級別的消息被打印,在小型應用中它也許是有用的。 |
slf4j-jcl-1.7.13.jar | Jakarta Commons Logging 的橋接器. 這個橋接器將Slf4j所有日志委派給Jcl。 |
logback-classic-1.0.13.jar(requires logback-core-1.0.13.jar) | Slf4j的原生實現,Logback直接實現了Slf4j的接口,因此使用Slf4j與Logback的結合使用也意味更小的內存與計算開銷。 |
當我們在同一項目中使用不同的組件時應該如果解決不同組件依賴的日志組件不一致的情況呢?現在我們需要統一日志方案,統一使用Slf4j,把他們的日志輸出重定向到Slf4j,然后Slf4j又會根據綁定器把日志交給具體的日志實現工具。Slf4j帶有幾個橋接模塊,可以重定向Log4j,JCL和java.util.logging中的Api到Slf4j。
jar包名 | 作用 |
---|---|
log4j-over-slf4j-version.jar | 將Log4j重定向到Slf4j |
jcl-over-slf4j-version.jar | 將Commons Logging里的Simple Logger重定向到slf4j |
jul-to-slf4j-version.jar | 將Java Util Logging重定向到Slf4j |
在使用Slf4j橋接時要注意避免形成死循環,在項目依賴的jar包中不要存在以下情況:
多個日志jar包形成死循環的條件 | 產生原因 |
---|---|
log4j-over-slf4j.jar和slf4j-log4j12.jar同時存在 | 由于slf4j-log4j12.jar的存在會將所有日志調用委托給log4j。但由于同時由于log4j-over-slf4j.jar的存在,會將所有對log4j api的調用委托給相應等值的slf4j,所以log4j-over-slf4j.jar和slf4j-log4j12.jar同時存在會形成死循環 |
jul-to-slf4j.jar和slf4j-jdk14.jar同時存在 | 由于slf4j-jdk14.jar的存在會將所有日志調用委托給jdk的log。但由于同時jul-to-slf4j.jar的存在,會將所有對jul api的調用委托給相應等值的slf4j,所以jul-to-slf4j.jar和slf4j-jdk14.jar同時存在會形成死循環 |
logback主要包含三個組成部分:Loggers(日志記錄器)、Appenders(輸出目的在)、Layouts(日志輸出格式)
logback 主要分為三個模塊,分別是:
logback-core:提供基礎功能,是其他兩個模塊的基礎
logback-classic : log4j的升級,實現了self4j api
logback-access:用于與sevlet容器進行集成、提供網絡訪問日志的功能
logback初始化時,默認會去classpath下依次加載如下配置文件(logback.groovy、logback-test.xml、logback.xml),當找不到配置文件時logback將為rootLogger 添加一個 ConsoleAppender ,用于將日志輸出到控制臺。
編程時可是要如下代碼查看logback內部運行情況:
LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory(); StatusPrinter.print(lc);
對于web項目,可配置sevlet,然后通過網頁查看logback內部運行狀態,如下:
1.集成步驟ViewStatusMessages ch.qos.logback.classic.ViewStatusMessagesServlet ViewStatusMessages /lbClassicStatus
首先,在pom文件引入相關依賴,如下:
org.slf4j slf4j-api 1.7.7 ch.qos.logback logback-core 1.1.7 ch.qos.logback logback-access 1.1.7 ch.qos.logback logback-classic 1.1.7
接著,編寫logback.xml(位于classpath目錄下,此處為src/main/resources目錄)
myAppName %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n ./my_log.log ./my_log%d{yyyyMMdd}.log.zip 30 %d{HH:mm:ss.SSS}[%-5level][%thread]%logger{36} - %msg%n
最后,就可以在程序中使用logback了,例如:
package com.yinz.aaa; import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class Test { public static void main(String[] args) { Logger logger = LoggerFactory.getLogger(Test.class); logger.debug("test........"); } }
有幾點需要注意:
logger 的日志級別若沒顯示定義,則繼承最近的祖先logger(該logger需顯示定義level,直到rootLogger)的日志級別。
logger的父子關系,由logger的名稱決定,例如有三個logger,分別為:java.lang.util 、 java.lang 、java
則,java是java.lang的父logger, 是java.lang.util的祖先logger. 而同時java.lang是java.lang.util的父logger
參考:Logger日志定義、級別、記錄、繼承
logger的appender默認具有累加性(默認日志輸出到當前logger的appender和所有祖先logger的appender中),可通過配置 “additivity”屬性修改默認行為
2.logback的配置介紹Logger、appender及layout
1. Logger作為日志的記錄器,把它關聯到應用的對應的context上后,主要用于存放日志對象,也可以定義日志類型、級別。
2. Appender主要用于指定日志輸出的目的地,目的地可以是控制臺、文件、遠程套接字服務器、 MySQL、PostreSQL、 Oracle和其他數據庫、 JMS和遠程UNIX Syslog守護進程等。
3. Layout 負責把事件轉換成字符串,格式化的日志信息的輸出。
logger context
各個logger 都被關聯到一個 LoggerContext,LoggerContext負責制造logger,也負責以樹結構排列各logger。其他所有logger也通過org.slf4j.LoggerFactory 類的靜態方法getLogger取得。 getLogger方法以 logger名稱為參數。用同一名字調用LoggerFactory.getLogger 方法所得到的永遠都是同一個logger對象的引用。
有效級別及級別的繼承
Logger 可以被分配級別。級別包括:TRACE、DEBUG、INFO、WARN 和 ERROR,定義于ch.qos.logback.classic.Level類。如果 logger沒有被分配級別,那么它將從有被分配級別的最近的祖先那里繼承級別。root logger 默認級別是 DEBUG。
打印方法與基本的選擇規則
打印方法決定記錄請求的級別。例如,如果 L 是一個 logger 實例,那么,語句 L.info("..")是一條級別為 INFO的記錄語句。記錄請求的級別在高于或等于其 logger 的有效級別時被稱為被啟用,否則,稱為被禁用。記錄請求級別為 p,其 logger的有效級別為 q,只有則當 p>=q時,該請求才會被執行。
該規則是 logback 的核心。級別排序為: TRACE < DEBUG < INFO < WARN < ERROR
logback的默認配置
如果配置文件 logback-test.xml 和 logback.xml 都不存在,那么 logback 默認地會調用BasicConfigurator ,創建一個最小化配置。最小化配置由一個關聯到根 logger 的ConsoleAppender 組成。輸出用模式為%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 進行格式化。root logger 默認級別是 DEBUG。
Logback的配置文件
Logback 配置文件的語法非常靈活。正因為靈活,所以無法用 DTD 或 XML schema 進行定義。盡管如此,可以這樣描述配置文件的基本結構:以
Logback默認配置的步驟
嘗試在 classpath下查找文件logback-test.xml;
如果文件不存在,則查找文件logback.xml;
如果兩個文件都不存在,logback用BasicConfigurator自動對自己進行配置,這會導致記錄輸出到控制臺。
logback.xml常用配置詳解
(1) 根節點
scan: 當此屬性設置為true時,配置文件如果發生改變,將會被重新加載,默認值為true。
scanPeriod: 設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當scan為true時,此屬性生效。默認的時間間隔為1分鐘。
debug: 當此屬性設置為true時,將打印出logback內部日志信息,實時查看logback運行狀態。默認值為false。
例如:
(2) 子節點
例如:
myAppName
(3) 子節點
name: 變量的名稱
value: 的值時變量定義的值
例如:
${APP_Name}
(4) 子節點
key: 標識此
datePattern: 設置將當前時間(解析配置文件的時間)轉換為字符串的模式,遵循java.txt.SimpleDateFormat的格式。
例如:
${bySecond}
(5) 子節點
5.1、ConsoleAppender 把日志輸出到控制臺,有以下子節點:
例如:
%-4relative [%thread] %-5level %logger{35} - %msg %n
上述配置表示把>=DEBUG級別的日志都輸出到控制臺
5.2、FileAppender:把日志添加到文件,有以下子節點:
例如:
testFile.log true %-4relative [%thread] %-5level %logger{35} - %msg%n
上述配置表示把>=DEBUG級別的日志都輸出到testFile.log
5.3、RollingFileAppender:滾動記錄文件,先將日志記錄到指定文件,當符合某個條件時,將日志記錄到其他文件。有以下子節點:
class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy": 最常用的滾動策略,它根據時間來制定滾動策略,既負責滾動也負責出發滾動。有以下子節點:
如果沒設置file,活動文件的名字會根據fileNamePattern 的值,每隔一段時間改變一次。“/”或者“”會被當做目錄分隔符。
class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy": 查看當前活動文件的大小,如果超過指定大小會告知RollingFileAppender 觸發當前活動文件滾動。只有一個節點:
class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" 根據固定窗口算法重命名文件的滾動策略。有以下子節點:
例如:
logFile.%d{yyyy-MM-dd}.log 30 %-4relative [%thread] %-5level %logger{35} - %msg%n
備注:上述配置表示每天生成一個日志文件,保存30天的日志文件。
test.log tests.%i.log.zip 1 3 5MB %-4relative [%thread] %-5level %logger{35} - %msg%n
備注:上述配置表示按照固定窗口模式生成日志文件,當文件大于20MB時,生成新的日志文件。窗口大小是1到3,當保存了3個歸檔文件后,將覆蓋最早的日志。(分別為tests.1.log.zip、tests.2.log.zip、tests.3.log.zip)
PatternLayoutEncoder 是唯一有用的且默認的encoder ,有一個
:
負責兩件事,一是把日志信息轉換成字節數組,二是把字節數組寫入到輸出流。
目前PatternLayoutEncoder 是唯一有用的且默認的encoder ,有一個節點,用來設置日志的輸入格式。使用“%”加“轉換符”方式,>如果要輸出“%”,則必須用“”對“%”進行轉義。
例如:%-4relative [%thread] %-5level %logger{35} - %msg%n
里面的轉換符說明:
5.4、還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,這里就不詳解了。
大家可以參考官方文檔(http://logback.qos.ch/documen...),還可以編寫自己的Appender。
(6)子節點
可以包含零個或多個
name: 用來指定受此loger約束的某一個包或者具體的某一個類。
level: 用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,還有一個特俗值INHERITED或者同義詞NULL,代表強制執行上級的級別。 如果未設置此屬性,那么當前loger將會繼承上級的級別。
addtivity: 是否向上級loger傳遞打印信息。默認是true。同
additivity的作用在于 children-logger是否使用 rootLogger配置的appender進行輸出。
false:表示只用當前logger的appender-ref。
true:表示當前logger的appender-ref和rootLogger的appender-ref都有效。
(7)子節點
level: 用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF,不能設置為INHERITED或者同義詞NULL。 默認是DEBUG。
六、常用loger配置
參考
https://www.cnblogs.com/chenh...
https://www.cnblogs.com/warki...
http://www.cnblogs.com/yinz/p...
https://www.cnblogs.com/bigbe... Spring Boot 日志配置方法(超詳細)
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/73039.html
摘要:本文要來分享給大家程序員最常用的日志框架組件。沒有基礎的同學也不要著急,這套教程覆蓋了目前所有的日志框架,只要你學,就一定用得到,先收藏,以備不時之需。 作為一名Java程序員,我們開發了很多Java應用程序,包括桌面應用、WEB應用以及移動應用。然而日志系統是一個成熟Java應用所必不可少的。在開發和調試階段,日志可以幫...
摘要:深入學習系列三那些年我們用過的日志框架目前常見的日志框架和中文似乎不太好翻譯有一下幾種即其中,為同一個作者所寫。如前面所述,在才被引入,在這之前,并沒有官方的日志庫供開發者使用。 title: 【Java深入學習系列】三. 那些年我們用過的日志框架date: 2016-10-16 15:32:50 category: java 目前常見的Java日志框架和facades(中文似乎不太好...
摘要:的橋接器這個橋接器將所有日志委派給的原生實現,直接實現了的接口,因此使用與的搭配也暗示了嚴格的零內存計算溢出未完待補充 起手式 忘了什么時候聽老師說過,牛逼的公司只管定義接口,屌絲廠商實現接口,類似 JDBC 的實現便是如此,用在 slf4j, 總覺得有些類似,本來 SUN 有機會在需求產生之前設計一套漂亮的日志框架來一統天下,可惜偏偏要拖到 JDK1.4, 而這套原生的日志框架也沒有...
摘要:定制日志文件簡單的日志配置不能滿足實際項目需求,那可以通過引用定制日志文件的形式達到目的。能根據類路徑下的類庫和配置文件自動配置對應的日志框架。看到這里,相信你對的日志應該有了一個全面的了解。 本節內容基于 Spring Boot 2.0. 你所需具備的基礎 什么是 Spring Boot? Spring Boot 核心配置文件詳解 Spring Boot 開啟的 2 種方式 Spr...
摘要:輕松輸出應用日志到七牛云平臺背景云計算發展至今,企業應用的方方面面都已經在云上或者準備上云了。方案本篇主要介紹下如何利用七牛云大數據日志平臺來無縫收集應用日志,方便后續的日志分析等工作。 輕松輸出Java應用日志到七牛云平臺 背景 云計算發展至今,企業應用的方方面面都已經在云上或者準備上云了。無論是Iaas還是Paas,應用開發的首選即是上云,因為云平臺不僅可以節約開發和部署流程中的時...
閱讀 2164·2021-11-11 16:55
閱讀 1684·2019-08-30 15:54
閱讀 2817·2019-08-30 15:53
閱讀 2211·2019-08-30 15:44
閱讀 1152·2019-08-30 15:43
閱讀 964·2019-08-30 11:22
閱讀 1942·2019-08-29 17:20
閱讀 1566·2019-08-29 16:56