一、 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)。 2)、 3)、 5、
三、 主要Log4j实现
1、AppenderAttachableImpl类提供了AppenderAttachable接口的默认实现。他使用Vector实现了Appender聚集的管理方法。
四、 五、 扩展
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)。 2)、 3)、 5、
三、 主要Log4j实现
1、AppenderAttachableImpl类提供了AppenderAttachable接口的默认实现。他使用Vector实现了Appender聚集的管理方法。
四、 五、 扩展