log4j对xml配置解析

最新推荐文章于 2021-03-14 02:56:25 发布

xinwendewen

最新推荐文章于 2021-03-14 02:56:25 发布

阅读量746

点赞数

CC 4.0 BY-SA版权

分类专栏： log4j

本文链接：https://blog.youkuaiyun.com/zwt0909/article/details/51368038

log4j 专栏收录该内容

3 篇文章

订阅专栏

本文探讨了log4j如何解析xml配置，特别是当layout元素的name="ConversionPattern"与PatternLayout的pattern属性不匹配时，log4j通过DOMConfigurator和PropertySetter API来设置属性，利用PropertyDescriptor找到对应的setter方法进行反射调用，实现配置注入。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

log4j对xml配置解析

以下是log4j.xml对appender的定义例子

<appender name=""
    class="org.apache.log4j.RollingFileAppender">
    <param name="File" value="" />
    <param name="MaxFileSize" value="" />
    <param name="MaxBackupIndex" value="" />
    <layout class="org.apache.log4j.PatternLayout"> //父类AppenderSkeleton定义
        <param name="ConversionPattern"
            value="%d{yyyy-MM-dd HH:mm:ss.SSS} | %p | [%t] %m %n" />
    </layout>
</appender>

问题来了layout元素的配置name=”ConversionPattern”，但是PatternLayout中并没有属性ConversionPattern而是pattern，那么现在解析这个xml时候是如何set到pattern中的呢？

大致上看了看源码，log4j通过DOMConfigurator类进行xml配置解析，方法Appender parseAppender (Element appenderElement)进行appender的解析

protected Appender parseAppender (Element appenderElement) 
{
    ......
    //解析layout
    // Set appender layout
    else if (currentElement.getTagName().equals(LAYOUT_TAG)) {
        appender.setLayout(parseLayout(currentElement));
    }   
    ......
}

parseLayout(currentElement)构造Layout实例

Layout parseLayout (Element layout_element)
{
    ....new 相应类型Layout实例
    //Layout的PropertySetter
    PropertySetter propSetter = new PropertySetter(layout);
    ....获取param元素：currentElement
    setParameter(currentElement, propSetter);
}

最终是调用PropertySetter(API)的setProperty方法。

protected void setParameter(Element elem, PropertySetter propSetter) 
{
    String name = subst(elem.getAttribute(NAME_ATTR));// ConversionPattern
    String value = (elem.getAttribute(VALUE_ATTR));// %d{yyyy-MM-dd HH:mm:ss.SSS} | %p | [%t] %m %n
    value = subst(OptionConverter.convertSpecialChars(value));
    propSetter.setProperty(name, value);
}

public void setProperty(String name, String value) 
{
    ....
    PropertyDescriptor prop = getPropertyDescriptor(name);
    ....
    setProperty(prop, name, value);
    ....
}

该方法在propSetter的PropertyDescriptor[] props中找到baseName与ConversionPattern一致的元素,props[i]包含了对应的setter与getter方法名，用于反射调用。