作為一個(gè)有追求的程序猿驳概,你了解你見到的各種日志嗎杆麸?JDK的日志、Tomcat的日志沥阱、還有Logback的日志整胃,他們之間只什么關(guān)系?
一喳钟、JavaWeb中的各種log
-
JDK原生日志API
- JDK中內(nèi)置了原生的日志打印的API:java.util.logging.Logger,這個(gè)API不依賴于任何的第三方框架在岂,是JDK內(nèi)置的
- 這個(gè)Logger的級別: SEVERE → WARNING → INFO → CONFIG → FINE → FINER → FINESET
- 用法如下:
private Logger logger = Logger.getLogger("<class-name>"); logger.severe("<severe-msg>"); logger.warning("<warning-msg>"); logger.info("<info-msg>"); logger.config("<config-msg>"); logger.fine("<fine-msg>"); logger.finer("<finer-msg>"); logger.finest("<finest-msg>");
- JDK日志配置
- 默認(rèn)情況下奔则,日志的輸出都是在控制臺(tái)直接輸出的,并沒有輸出到文件中蔽午,這是因?yàn)樵贘RE默認(rèn)配置中易茬,只配置了一個(gè)ConsoleHandler,這個(gè)配置文件位于
<jre-home>/lib/logging.properties
及老,注意一般情況下我在安裝JDK的時(shí)候是不會(huì)安裝公共JRE的抽莱,因?yàn)镴DK中就已經(jīng)安裝過了,不過最新的JDK貌似已經(jīng)把二者分開了骄恶,總之食铐,根據(jù)自己的情況找到JRE的家目錄,即可找到該文件僧鲁; - 在
logging.properties
這個(gè)文件中有個(gè)handlers
虐呻,其值只有一個(gè)handlers= java.util.logging.ConsoleHandler
,如果想要同時(shí)輸出到文件中寞秃, 只需要在后面追加java.util.logging.FileHandler
斟叼,多個(gè)handler之間使用英文都好隔開即可; - 在增加了
FileHanlder
之后春寿,那么FileHanlder
的各種配置就生效了朗涩,就可以根據(jù)需要進(jìn)行配置了,如:java.util.logging.FileHandler.pattern = %h/java%u.log java.util.logging.FileHandler.limit = 50000 java.util.logging.FileHandler.count = 1 java.util.logging.FileHandler.formatter = java.util.logging.XMLFormatter
- FileHandler.pattern:用來指定生成的日志文件的路徑名稱绑改;
/
:本地路徑名分隔符谢床;%t
:系統(tǒng)臨時(shí)目錄兄一;%h
:"user.home" 系統(tǒng)屬性的值;%g
:區(qū)分循環(huán)日志的生成號(hào)萤悴;%u
:解決沖突的惟一號(hào)碼瘾腰;%%
:轉(zhuǎn)換為單個(gè)百分?jǐn)?shù)符號(hào)"%" ; - FileHandler.limit:用來限制文件的大小覆履,以字節(jié)為單位蹋盆,0表示沒有限制;
- FileHandler.count:指定有多少輸出文件參與循環(huán)(默認(rèn)為1)硝全;
- FileHandler.formatter:指定要使用的 Formatter 類的名稱(默認(rèn)為java.util.logging.XMLFormatter)栖雾。 另外一個(gè)是:java.util.logging.SimpleFormatter。XMLFormatter是以xml樣式輸出伟众,SimpleFormatter是以普通樣式輸出析藕。
- FileHandler.append:指定是否應(yīng)該將 FileHandler 追加到任何現(xiàn)有文件上(默認(rèn)為false);
- SimpleFormatter.format:用來自定義SimpleFormatter的輸出樣式凳厢;如:
%4$s: %5$s [%1$tc]%n
账胧,即輸出樣式為:<level>: <log message> [<date/time>]
- FileHandler.pattern:用來指定生成的日志文件的路徑名稱绑改;
- 日志打印級別的配置:
- 全局輸出級別設(shè)置
[java.util.logging.ConsoleHandler/FileHandler].level=<level-name>
- 具體包名的輸出級別設(shè)置
<package-name>.level=<level-name>
- 全局輸出級別設(shè)置
- 默認(rèn)情況下奔则,日志的輸出都是在控制臺(tái)直接輸出的,并沒有輸出到文件中蔽午,這是因?yàn)樵贘RE默認(rèn)配置中易茬,只配置了一個(gè)ConsoleHandler,這個(gè)配置文件位于
-
Tomcat的API
- Tomcat是Apache的一個(gè)開源項(xiàng)目,Apache旗下還有一個(gè)開源項(xiàng)目先紫,名為Apache common logging治泥,而Tomcat中的日志框架juli正是這個(gè)開源框架的一個(gè)易名項(xiàng)目,究其根源來說遮精,Apache common logging是對JDK打印API的修改封裝居夹;
- 為了不影響JDK中的Logger的正常使用,Tomcat中增加了自定義的Log配置本冲,這個(gè)配置存在于Tomcat的腳本catalina.bat和catalina.sh中准脂,如下:
LOGGING_CONFIG="-Djava.util.logging.config.file=$CATALINA_BASE/conf/logging.properties" LOGGING_MANAGER="-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager"
- 這兩個(gè)參數(shù)配置給java虛擬機(jī)配置了兩個(gè)東東, 一個(gè)是日志的配置文件還有一個(gè)日志管理器;
- 在這個(gè)配置文件中檬洞,我們發(fā)現(xiàn)默認(rèn)情況下狸膏,Tomcat支持文件和控制臺(tái)兩種輸出方式;還有就是Tomcat的handler都帶有一個(gè)數(shù)字前綴添怔,自然就想到如果使用系統(tǒng)默認(rèn)的類加載器的話环戈,肯定會(huì)出錯(cuò),Tomcat使用的是自定義的ClassLoader來解析這個(gè)數(shù)字前綴澎灸;而增加數(shù)字前綴的目的就是為了使得一個(gè)類模板生成多個(gè)實(shí)例院塞,每個(gè)實(shí)例都管理一種類型的日志,如:
- 前綴1對應(yīng)的日志:文件名以
catalina.
開頭 - 前綴2對應(yīng)的日志:文件名以
localhost.
開頭 - 前綴3對應(yīng)的日志:文件名以
manager.
開頭 - 前綴4對應(yīng)的日志:文件名以
host-manager.
開頭
- 前綴1對應(yīng)的日志:文件名以
- Tomcat與JDK日志的配置
- 有一點(diǎn)不同性昭,JRE的logging.properties文件中使用
handlers
配置輸出途徑拦止,而在Tomcat中使用.handlers
配置,使用handlers
配置上面4中不同的文件日志 - Tomcat的詳細(xì)配置可查看:http://tomcat.apache.org/tomcat-8.0-doc/config [/valve.html]
- 有一點(diǎn)不同性昭,JRE的logging.properties文件中使用
-
Logback的API(Log4j)
-
提起這個(gè)日志框架,就不得不提起另外另個(gè)東東:slf4j和log4j汹族,這三個(gè)框架(?)什么關(guān)系呢萧求?網(wǎng)上找到一張圖:
slf4j & log4j & logging - slf4j的全稱是:The Simple Logging Facade for(4) Java,即slf4j是一個(gè)門面顶瞒,而log4j和logback則是這些接口的實(shí)現(xiàn)夸政;log4j和logback是由同一個(gè)人完成的,前者是apache實(shí)現(xiàn)的榴徐,logback是為了替代log4j守问,logback可以說是slf4j的原生實(shí)現(xiàn),目前除了老的項(xiàng)目坑资,新項(xiàng)目的日志基本上都是使用logback耗帕;
- logback是直接實(shí)現(xiàn)了slf4j的接口,不消耗內(nèi)存和計(jì)算開銷的袱贮。slf4j的api在調(diào)用log4j時(shí)需要一個(gè)適配層仿便;
- log4j和logback可以單獨(dú)的使用,也可以綁定slf4j一起使用:單獨(dú)使用的時(shí)候攒巍,分別調(diào)用框架自己的方法來輸出日志信息嗽仪;綁定slf4j一起使用,調(diào)用slf4j的api來輸入日志信息柒莉,具體使用與底層日志框架無關(guān)闻坚,但是需要底層框架的配置文件;
- 其實(shí)說到這里就能發(fā)現(xiàn)這個(gè)
門面
扮演什么角色常柄,其實(shí)就是為了解決眾口難調(diào)的問題,因?yàn)轫?xiàng)目中我們用到很多的框架搀擂,如果每個(gè)框架都有自己的日志輸出框架西潘,難么項(xiàng)目中的日志維護(hù)便成了一個(gè)大問題,為了解決這個(gè)大問題哨颂,log4j和logback框架橫空出世:我們項(xiàng)目中的所有框架的日志輸出都交給slf4j喷市,然后統(tǒng)一對消息進(jìn)行處理;
-
文章中還有很多可以深入的地方,如果需要,后面繼續(xù)更新
文章參考:Tomcat的Logging威恼、slf4j log4j logback關(guān)系詳解和相關(guān)用法品姓、為什么要使用SLF4J而不是Log4J、從Log4j遷移到LogBack的理由