log4j源碼閱讀之log4j中主要的類

原文地址:

http://blog.csdn.net/ifeegoo/article/details/3736132

說明:

Log4j中的LoggingEvent、HierarchyEventListener、AppenderAttachableImpl沒有看明白,還有Hierarchy,下次再記錄。

內容:

一、Log4j的主要接口

    1、
Appender:封裝了Appender的操作,所有Appender都應該實現該接口。主要方法有:

        1)、addFiltre()、getFilter()、clearFilters()操作Filter的方法。

        2)、close():關閉Appender的方法。

        3)、doAppend():當Logger想打印消息的時候就會調用Appender的doAppend()方法。

        4)、getName()、setName:設置、獲取Appender的名字。

        5)、getErorHandler()、setErrorHandler():設置、獲取Appender的ErrorHandler。

        6)、getLayout()、setLayout():設置、獲取Layout。

        7)、requiresLayout():判斷Appender是否需要Layout(配置時使用)。

    2、 AppenderAttachable:封裝了對Appender聚集的一些操作,Log4j中使用AppenderAttachableImpl提供了默認的實現,Category的實現是將所有的操作委派給了AppenderAttachableImpl。主要方法有:

        1)、addAppender()、removeAppender、removeAllAppenders、getAppender()、getAllAppenders等聚集的操作方法。

        2)、isAttached():判斷一個Appender是否已經加載到聚集中了。

    3、 OptionHandler:封裝了激活設置的屬性的方法,就一個activateOptions()方法。通過本方法可以將設置的屬性激活,比如根據設置的文件名生成文件句柄。

    4、 LoggerRepository:封裝了對Logger聚集的一些操作,Log4j中使用Hierarchy提供了實現方法。主要方法有:

        1)、addHierarchyEventListener():使用觀察者模式實現了事件機制。在這裏添加觀察者。

        2)、isDisabled():判斷指定等級的Log能否打印。

        3)、setThreshold()、getThreshold():設置、獲取Threshold等級屬性。

        4)、emitNoAppenderWarning():拋出一個沒有Appender異常。

        5)、getLogger()、getRootLogger()、exists()、getCurrentLoggers()、getCurrentCategories():獲取Logger。

        6)、fireAddAppenderEvent():觸發Add_Appender事件,調用所有觀察者的相應方法,在Hierarchy中還實現了fireRemoveAppenderEvent()方法。

        7)、resetConfiguration():將聚集中的所有Logger設置會默認狀態,RootLogger的等級設置爲DEBUG,Threshold設置位ALL。

    5、 HierarchyEventListener:封裝了觀察者的操作。主要方法有:

        1)、addAppenderEvent()、removeAppenderEvent():在兩個事件觸發的入口。

    6、 RepositorySelector:只提供了一個獲取LoggerRepository的方法getLoggerRepository()。

    7、 LogRecodFilter:提供了一個過濾的方法passes(),如果通過過濾返回true,否則返回false。

    8、 LoggerFactory:提供了一個創建Logger的工廠方法。這是一個抽象工廠。Log4j中抽象工廠的應用可以好好學習一下,需要使用工廠方法的地方都提供了一個默認工廠類,如果用戶不提供自己的工廠方法,就是用自己的默認工廠。

    9、 ObjectRenderer:封裝了對象翻譯器的解析方法doRender()。Log4j中的對象翻譯器體現了一種面向對象設計中非常重要的一點:“解耦”,它將對象的解析任務有類中的toString()方法“解耦”出來,成爲對象翻譯器,這樣可以使一個類和其解釋類可以獨立演化。強!!!!

    10、RendererSupport:封裝了支持對象翻譯器的需要的兩個方法。GetRendererMap()獲取一個Renderer的聚集。SetRenderer()添加一個對象翻譯器。

    11、Configurator:封裝了Log4j的配置動作。提供了兩個字符串常量,和實際作配置用的doConfigure()方法。但是本人認爲該接口的設計沒有真正發揮作用。

    12、ErrorHandler:繼承至OptionHandler接口。封裝了對Appender的Error的處理。

    13、ErrorCode:封裝了一些常數,使實現這個接口的所有類都自動取得這些常量。雖然Sun不贊成這種做法,不過我覺得這樣真的很方便。


二、Log4j的主要抽象類

    1、
Layout:實現了OptionHandler接口。是所有Layout的基礎類。它提供了一些LayOut共有的常量和方法。主要有

        1)、抽象方法format():Layout具體的解析方法。

        2)、getContentType():返回內容的類型,默認返回“text/plain”。

        3)、getHeader()、getFooter():不知道具體作用,默認返回null。

        4)、ignoresThrowable():如果本Layout不支持Throwable就返回false。

    2、 AppenderSkeleton:實現了Appender,OptionHadler接口。是所有Appender的基礎類。它提供了一些Appender共有的變量和方法的默認實現,主要有:

        1)、變量:Layout,name,Threshold,ErrorHandler(new OnlyOnceErrorHandler()), headFilter,tailFilter,closed(false)這是每個Appender都應該有的變量。

        2)、setLayout(),getLayout():屬性layout的操作方法。

        3)、setName(),getName():屬性name的操作方法。

        4)、setErrorHandler(),getErrorHandler():屬性ErrorHandler的操作方法。

        5)、setThreshold(),getThreshold(),isAsSevereAsThreshold():屬性Threshold的操作方法,和Appender的Threshold等級的比較方法。

        6)、addFilter(),clearFilters():提供了一個操作Filter鏈表的操作方法。通過addFilter()方法,將頭結點(headFilter)尾結點(tailFilter)組成一個單向不循環鏈表。

        7)、activateOptions():對OptionHandler接口的默認實現,什麼都不做。

        8)、finalize():當被垃圾收集時,如果Appender沒有關閉就關閉它。

        9)、doAppend(),append():doAppend()方法提供了在log打印過程中loglog的打印,Threshold等級的控制和過濾器的調用,並留了一個虛方法(append())給以後的Appender來實現。

    3、 Filter:實現了OptionHandler。所有Filter的基類,他提供了Filter共有的變量和方法,主要有:

        1)、變量:一個構成鏈表結構的next變量,返回值常量DENY(-1),NEUTRAL(0),ACCEPT(1)。

        2)、虛方法decide():提供過濾的接口。

        3)、activateOptions():OptionHandler接口的默認實現。

    4、 PatternConverter:是提供格式化方法的一個基礎抽象類,他提供了所有格式化方法的共同接口,主要方法和變量有:

        1)、變量next:構成鏈表用。min(-1),max(0x7FFFFFFF),leftAlign(false)。  

三、主要Log4j實現

    1、AppenderAttachableImpl類提供了AppenderAttachable接口的默認實現。他使用Vector實現了Appender聚集的管理方法。


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章