Java日誌系統框架的設計與實現
在Java 領域,存在大量的日誌組件,open-open收錄了21個日誌組件。日誌系統作爲一種應用程序服務,對於跟蹤調試、程序狀態記錄、崩潰數據恢復都有着重要的作用,我們可以把Java日誌系統看作是必不可少的跟蹤調試工具。
1.簡介
日誌系統是一種不可或缺的跟蹤調試工具,特別是在任何無人職守的後臺程序以及那些沒有跟蹤調試環境的系統中有着廣泛的應用。長期以來,日誌系統作爲一種應用程序服務,對於跟蹤調試、程序狀態記錄、崩潰數據恢復都有非常現實的意義。這種服務通常以兩種方式存在:
1.日誌系統作爲服務進程存在。Windows中的的事件日誌服務就屬於這種類型,該類型的日誌系統通常通過消息隊列機制將所需要記錄的日誌由日誌發送端發送給日誌服務。日誌發送端和日誌保存端通常不在同一進程當中,日誌的發送是異步過程。這種日誌服務通常用於管理員監控各種系統服務的狀態。
2.日誌系統作爲系統調用存在。Java世界中的日誌系統和Unix環境下諸多守護進程所使用的日誌系統都屬於這種類型。日誌系統的代碼作爲系統調用被編譯進日誌發送端,日誌系統的運行和業務代碼的運行在同一進程空間。日誌的發送多數屬於同步過程。這種日誌服務由於能夠同步反映處系統運行狀態,通常用於調試跟蹤和崩潰恢復。
本文建立的日誌系統基本屬於第二種類型,但又有所不同。該日誌系統將利用Java線程技術實現一個既能夠反映統一線程空間中程序運行狀態的同步日誌發送過程,又能夠提供快速的日誌記錄服務,還能夠提供靈活的日誌格式配置和過濾機制。
1.1系統調試的誤區
在控制檯環境上調試Java程序時,此時往控制檯或者文本文件輸出一段文字是查看程序運行狀態最簡單的做法,但這種方式並不能解決全部的問題。有時候,對於一個我們無法實時查看系統輸出的系統或者一個確實需要保留我們輸出信息的系統,良好的日誌系統顯得相當必要。因此,不能隨意的輸出各種不規範的調試信息,這些隨意輸出的信息是不可控的,難以清除,可能爲後臺監控、錯誤排除和錯誤恢復帶來相當大的阻力。
1.2日誌系統框架的基本功能
一個完備的日誌系統框架通常應當包括如下基本特性:
所輸出的日誌擁有自己的分類:這樣在調試時便於針對不同系統的不同模塊進行查詢,從而快速定位到發生日誌事件的代碼。
日誌按照某種標準分成不同級別:分級以後的日誌,可以用於同一分類下的日誌篩選。
支持多線程:日誌系統通常會在多線程環境中使用,特別是在Java系統當中,因此作爲一種系統資源,日誌系統應當保證是線程安全的。
支持不同的記錄媒介:不同的工程項目往往對日誌系統的記錄媒介要求不同,因此日誌系統必須提供必要的開發接口,以保證能夠比較容易的更換記錄介質。
高性能:日誌系統通常要提供高速的日誌記錄功能以應對大系統下大請求流量下系統的正常運轉。
穩定性:日誌系統必須是保持高度的穩定性,不能因爲日誌系統內部錯誤導致主要業務代碼的崩潰。
1.3常用日誌系統簡介
在Java世界中,以下三種日誌框架比較優秀:
1)Log4J
最早的Java日誌框架之一,由Apache基金會發起,提供靈活而強大的日誌記錄機制。但是其複雜的配置過程和內部概念往往令使用者望而卻步。
2)JDK1.4LoggingFramework
繼Log4J之後,JDK標準委員會將Log4J的基本思想吸收到JDK當中,在JDK1.4中發佈了第一個日誌框架接口,並提供了一個簡單實現。
3)CommonsLoggingFramwork
該框架同樣是Apache基金會項目,其出現主要是爲了使得Java項目能夠在Log4J和JDK1.4lLoggingFramework的使用上隨意進行切換,因此該框架提供了統一的調用接口和配置方法。
2.系統設計
由於Log4J得到廣泛應用,從使用者的角度考慮,本文所設計的框架,採用了部分Log4J的接口和概念,但內部實現則完全不同。使用Java實現日誌框架,關鍵的.技術在於前面提及的日誌框架特性的內部實現,特別是:日誌的分類和級別、日誌分發框架的設計、日誌記錄器的設計以及在設計中的高性能和高穩定性的考慮。
2.1系統架構
日誌系統框架可以分爲日誌記錄模塊和日誌輸出模塊兩大部分。日誌記錄模塊負責創建和管理日誌記錄器(Logger),每一個Logger對象負責按照不同的級別(LoggerLevel)接收各種記錄了日誌信息的日誌對象(LogItem),Logger對象首先獲取所有需要記錄的日誌,並且同步地將日誌分派給日誌輸出模塊。日誌輸出模塊則負責日誌輸出器(Appender)的創建和管理,以及日誌的輸出。系統中允許有多個不同的日誌輸出器,日誌輸出器負責將日誌記錄到存儲介質當中。
日誌記錄器Logger是整個日誌系統框架的用戶使用接口,程序員可以通過該接口記錄日誌,爲了實現對日誌進行分類,系統設計允許存在多個Logger對象,每一個Logger負責一類日誌的記錄,Logger類同時實現了對其對象本身的管理。LoggerLevel類定義了整個日誌系統的級別,在客戶端創建和發送日誌時,這些級別會被使用到。Logger對象在接收到客戶端創建和發送的日誌消息時,同時將該日誌消息包裝成日誌系統內部所使用的日誌對象LogItem,日誌對象除了發送端所發送的消息以外,還會包裝諸如發送端類名、發送事件、發送方法名、發送行號等等。這些額外的消息對於系統的跟蹤和調試都非常有價值。包裝好的LogItem最終被髮送給輸出器,由這些輸出器負責將日誌信息寫入最終媒介,輸出器的類型和個數均不固定,所有的輸出器通過AppenderManager進行管理,通常通過配置文件即可方便擴展出多個輸出器。
2.2日誌記錄部分的設計
如前文所述,日誌記錄部分負責接收日誌系統客戶端發送來的日誌消息、日誌對象的管理等工作。下面詳細描述了日誌記錄部分的設計要點:
1.日誌記錄器的管理
系統通過保持多個Logger對象的方式來進行日誌記錄的分類。每一個Logger對象代表一類日誌分類。因此,Logger對象的名稱屬性是其唯一標識,通過名稱屬性獲取一個Logger對象:
erLoggerlogger=ogger(“LoggerName”);
一般的,使用類名來作爲日誌記錄器的名稱,這樣做的好處在於能夠儘量減少日誌記錄器命名之間的衝突(因爲Java類使用包名),同時能夠將日誌記錄分類得儘可能的精細。因此,假定有一UserManager類需要使用日誌服務,則更一般的使用方式爲:
erLoggerlogger=ogger(s);
2.日誌分級的實現
按照日誌目的不同,將日誌的級別由低到高分成五個級別:
◆DEBUG-表示輸出的日誌爲一個調試信息;
◆INFO-表示輸出的日誌是一個系統提示;
◆WARN-表示輸出的日誌是一個警告信息;
◆ERROR-表示輸出的日誌是一個系統錯誤;
◆FATAL-表示輸出的日誌是一個導致系統崩潰嚴重錯誤。
這些日誌級別定義在LoggerLevel接口中,被日誌記錄器Logger在內部使用。而對於日誌系統客戶端則可使用Logger類接口對直接調用並輸出這些級別的日誌,Logger的這些接口描述如下:
icvoiddebug(Stringmsg);//輸出調試信息
icvoidinfo(Stringmsg);//輸出系統提示
icvoidwarn(Stringmsg);//輸出警告信息
icvoidfatal(Stringmsg);//輸出系統錯誤
icvoiderror(Stringmsg);//輸出嚴重錯誤
通過對Logger對象上這些接口的調用,直接爲日誌信息賦予了級別屬性,這樣爲後繼的按照不同級別進行輸出的工作奠定了基礎。
3.日誌對象信息的獲取
日誌對象上包含了一條日誌所具備的所有信息。通常這些信息包括:輸出日誌的時間、Java類、類成員方法、所在行號、日誌體、日誌級別等等。在JDK1.4中可以通過在方法中拋出並且捕獲住一個異常,則在捕捉到的異常對象中已經由JVM自動填充好了系統調用的堆棧,在JDK1.4中則可以使用kTraceElement獲取到每一個堆棧項的基本信息,通過對日誌客戶端輸出日誌方法調用層數的推算,則可以比較容易的獲取到StackTraceElement對象,從而獲取到輸出日誌時的Java類、類成員方法、所在行號等信息。在JDK1.3或者更早的版本中,相應的工作則必須通過將異常的堆棧信息輸出到字符串中,並分析該字符串格式得到。
2.3日誌輸出部分的設計
日誌輸出部分的設計具有一定的難度,在本文設計的日誌系統中,日誌的輸出、多線程的支持、日誌系統的擴展性、日誌系統的效率等問題都交由日誌輸出部分進行管理。
1.日誌輸出器的繼承結構
在日誌的輸出部分採用了二層結構,即定義了一個抽象的日誌輸出器(AbstractLoggerAppender),然後從該抽象類繼承出實際的日誌輸出器。AbstractLoggerAppender定義了一系列的對日誌進行過濾的方法,而具體輸出到存儲媒介的方法則是一個抽象方法,由子類實現。在系統中默認實現了控制檯輸出器和文件輸出器兩種,其中控制檯輸出器的實現頗爲簡單。
2.文件輸出器的內部實現
在日誌記錄部分的實現中,並沒有考慮多線程、高效率等問題,因此文件輸出器必須考慮這些問題的處理。在文件輸出器內部使用or定義了一個線程安全的高速緩衝,所有通過日誌記錄部分分派到文件輸出器的日誌被直接放置到該高速緩衝當中。同時在文件輸出器內部定義一個工作線程,負責定期將高速緩衝中的內容保存到文件,在保存的過程中同時可以進行日誌文件的備份等工作。由於採用了高速緩衝的結構,很顯然日誌客戶端的調用已經不再是一個同步調用,從而不再會需要等到文件操作後才返回,提高的系統調用的速度。該原理如圖3所示:
2.4設計難點
通過上述設計,一個具有良好擴展能力的高性能日誌系統框架就已經具有了一定的雛形。在設計過程中幾個難點問題需要進一步反思。
一、是否整個系統應當採用完全異步的結構,通過類似於消息機制的方式來進行由日誌客戶端發送日誌給日誌系統。這種方式可以作爲日誌系統框架另一種運行方式,在後繼設計中加以考慮。
二、在文件輸出器中可以看到,目前雖然可以擴展多個日誌輸出器,但是目前提供的抽象類中僅僅提供了對日誌的過濾機制,而沒有提供的緩存機制,目前的緩存機制被放在文件輸出器中實現,因此在未來的進一步設計中,可以將文件輸出器中的緩存機制上移到抽象類當中。
2.5設計模式
在設計過程中我們特別注意使用了數個經典的設計模式。如:Logger對象的創建使用了工廠方法模式(FactoryMethod)、由AbstractLoggerAppender和ConsoleAppender以及FileAppender構成了策略模式(Strategy),除此以外,還大量使用了單例模式(Singleton)。在設計中適當運用設計模式能夠加快設計進度、提高設計質量。
3.總結
本文探討了日誌系統的基本特性、實現日誌系統的意義、方法和內部結構,並且給出了一種基於Java平臺的日誌系統的詳細設計。同時也指出日誌系統會向服務化、異步化的方向發展。作爲一種方便的跟蹤調試、數據恢復工具,應當提倡在適當的環境下對日誌系統的使用。
相關文章
-
sun認證java程序員須知Java日誌框架
作爲一名Java程序員,明確的知道日誌系統是一個成熟Java應用所必不可少的,在開發和調試階段,日誌可以幫助我們更好更快地定位bug;在運行維護階段,日誌系統又可以幫我們記錄大部分的異常信息,從而幫助我們更好的完善系統。下 -
Java網上考試系統的設計和實現
腦筋急轉彎的題目不能用通常的思路來回答問題,需要改變思維方式,需要完全開動腦筋,這樣可以幫助我們通過不同的方式開發或鍛鍊大腦思維的能力。下面是本站小編整理的腦筋急轉彎,希望大家喜歡。腦筋急轉彎:山上有三隻狼,獵人 -
講解Java的Spring框架中的AOP實現
簡介面向切面編程(AOP)提供另外一種角度來思考程序結構,通過這種方式彌補了面向對象編程(OOP)的不足。 除了類(classes)以外,AOP提供了 切面。切面對關注點進行模塊化,例如橫切多個類型和對象的事務管理。 (這些關注點術語通常 -
JAVA實現電子商務系統
網絡經濟的來臨,引致了電子商務的迅速發展,而安全問題己成爲電子商務的核心問題。Java電子商務充分利用到了Java技術面向對象、獨立於平臺、可移植性、分佈式、多線程性、安全可靠等特點,能夠更好的 保證電子商務的安全 -
JAVA認證基礎知識:Java獲取當前的系統時間
在不斷注重大學聯考能力提高的同時,尤其是JAVA認證備考的後階段,我們選擇的是求準求穩求規範。此複習輔導不等於題海戰術,而是要積累實戰經驗,解決掉一些考場失誤等問題。 一、獲取當前系統時間和日期並格式化輸出:import ;im -
Java認證輔導:Java實現二叉樹遍歷算法
據國家發改委消息,近日經國務院同意,國家發改委會同國家衛計委、人社部、財政部發出《關於印發推進醫療服務價格改革意見的通知》,全面推進醫療服務價格改革,提出到xxxx年基本理順醫療服務比價關係。《通知》規定,要推進醫 -
JAVA的動態考試系統的設計
在一個陽光明媚的清晨,我和好朋友們相約來到寬闊的廣場上踢足球。今天天氣真好呀!碧藍的天空,嫩綠的小草,豔麗的花朵,清新的空氣……啊!我們先說好哪裏是門,哪條是界,哪裏算是出界……先做好準備,開始 -
java的三大主流框架
Struts、Hibeate和Spring是我們Java開發中的常用關鍵,他們分別針對不同的應用場景給出最合適的解決方案。但你是否知道,這些知名框架最初是怎樣產生的? 一、SpringSpring是一個解決了許多在J2EE開發中常見的問題的強 -
Java開發的異常框架
今天,我的心情倍感興奮。因爲,我可以和小姨一起去看電影了!呵呵,因爲這是第一次去看電影,所以心情也隨之而感到十分開心。今天,我和小姨他們一起去了廣場旁邊的金字塔電影院看我們一直所期待的《冰雪奇緣》。我們坐着電梯來 -
Java重定向輸出流實現程序日誌
System中的out,error都是final類型的,不能做改動。但通過setOut()可以設置新的輸出流,從而實現寫日誌的功能。import tStream; import NotFoundException; public class RedirectOutputStream { public static void ma