ASP.NET Core 3框架揭秘] 配置[8]：多样化的配置源[下篇]

XML也是一种常用的配置定义形式，它对数据的表达能力甚至强于JSON，几乎所有类型的数据结构都可以通过XML表示出来。当我们通过一个XML元素表示一个复杂对象的时候，对象的数据成员定义成当前XML元素的子元素。虽然XML对数据结构的表达能力总体要强于JSON，但是作为配置模型的数据来源却有自己的局限性，比如它们对集合的表现形式有点不尽如人意。

一、XML在针对集合表达上的缺陷

举个简单的例子，对于一个元素类型为Profile的集合，我们可以采用具有如下结构的XML来表现。

<Profiles>
    <Profile Gender="Male" Age="18">
        <ContactInfo EmailAddress ="[email protected]" PhoneNo="123"/>
    Profile>
    <Profile Gender="Male" Age="25">
        <ContactInfo EmailAddress ="[email protected]" PhoneNo="456"/>
    Profile>
    <Profile Gender="Male" Age="36">
        <ContactInfo EmailAddress ="[email protected]" PhoneNo="789"/>
    Profile>
Profiles>

但是这段XML却不能正确地转换成配置字典，原因很简单，因为字典的Key必须是唯一的，这必然要求最终构成配置树的每个节点必须具有不同的路径。上面这段XML很明显不满足这个基本的要求，因为表示一个Profile对象的三个XML元素（...）是“同质”的，对于由它们表示的三个Profile对象来说，分别表示性别、年龄、电子邮箱地址和电话号码的四个叶子节点的路径是完全一样的，所以根本无法作为配置字典的Key。通过前面针对配置绑定的介绍我们知道，如果需要通过配置字典来表示一个Profile对象的集合，我们需要按照如下的方式为每个集合元素加上相应的索引（“foo”、“bar”和“baz”）。

foo:Gender
foo:Age
foo:ContactInfo:EmailAddress
foo:ContactInfo:PhoneNo

bar:Gender
bar:Age
bar:ContactInfo:EmailAddress
bar:ContactInfo:PhoneNo

baz:Gender
baz:Age
baz:ContactInfo:EmailAddress
baz:ContactInfo:PhoneNo

二、通过自定义IConfigurationSource解决问题

之所以XML不能像JSON格式那样可以以一种很自然的形式表示集合或者数组，是因为后者对这两种数据类型提供了明确的定义方式（采用中括号定义），但是XML只有子元素的概念，我们不能确定它的子元素是否是一个集合。如果做这样一个假设：如果同一个XML元素下的所有子元素都具有相同的名称，那么我们可以将其视为集合。根据这么一个假设，我们对XmlConfigurationSource略加改造就可以解决XML难以表示集合数据结构的问题。

我们通过派生XmlConfigurationSource创建一个新的IConfigurationSource实现类型，姑且将其命名为ExtendedXmlConfigurationSource。XmlConfigurationSource提供的ConfigurationProvdier类型为ExtendedXmlConfigurationProvider，它派生于XmlConfigurationProvider。在重写的Load方法中，ExtendedXmlConfigurationProvider通过对原始的XML结构进行相应的改动，从而让原本不合法的XML（XML元素具有相同的名称）可以转换成一个针对集合的配置字典 。下图展示了XML结构转换采用的规则和步骤。

如上图所示，针对集合对原始XML所作的结构转换由两个步骤组成。第一步为表示集合元素的XML元素添加一个名为“append_index”的属性（Attribute），我们采用零基索引作为该属性的值。第二步会根据第一步转换的结果创建一个新的XML，同名的集合元素（比如）将会根据添加的索引值重新命名（比如<profile_index_0>）。毫无疑问，转换后的这个XML可以很好地表示一个集合对象。如下所示的是ExtendedXmlConfigurationProvider对象的定义，上述的这个转换逻辑体现在重写的Load方法中。

public class ExtendedXmlConfigurationProvider : XmlConfigurationProvider
{
    public ExtendedXmlConfigurationProvider(XmlConfigurationSource source) :  base(source)
    {}

    public override void Load(Stream stream)
    {
        //加载源文件并创建一个XmlDocument        
        var sourceDoc = new XmlDocument();
        sourceDoc.Load(stream);

        //添加索引
        AddIndexes(sourceDoc.DocumentElement);

        //根据添加的索引创建一个新的XmlDocument
        var newDoc = new XmlDocument();
        var documentElement =  newDoc.CreateElement(sourceDoc.DocumentElement.Name);
        newDoc.AppendChild(documentElement);

        foreach (XmlElement element in sourceDoc.DocumentElement.ChildNodes)
        {
            Rebuild(element, documentElement, name => newDoc.CreateElement(name));
        }

        //根据新的XmlDocument初始化配置字典
        using (Stream newStream = new MemoryStream())
        {
            using (XmlWriter writer = XmlWriter.Create(newStream))
            {
                newDoc.WriteTo(writer);
            }
            newStream.Position = 0;
            base.Load(newStream);
        }
    }

    private void AddIndexes(XmlElement element)
    {
        if (element.ChildNodes.OfType().Count() > 1)
        {
            if (element.ChildNodes.OfType().GroupBy(it => it.Name).Count() == 1)
            {
                var index = 0;
                foreach (XmlElement subElement in element.ChildNodes)
                {
                    subElement.SetAttribute("append_index", (index++).ToString());
                    AddIndexes(subElement);
                }
            }
        }
    }

    private void Rebuild(XmlElement source, XmlElement destParent, Func<string, XmlElement> creator)
    {
        var index = source.GetAttribute("append_index");
        var elementName = string.IsNullOrEmpty(index)  ? source.Name : $"{source.Name}_index_{index}";
        var element = creator(elementName);
        destParent.AppendChild(element);
        foreach (XmlAttribute attribute in source.Attributes)
        {
            if (attribute.Name != "append_index")
            {
                element.SetAttribute(attribute.Name, attribute.Value);
            }
        }

        foreach (XmlElement subElement in source.ChildNodes)
        {
            Rebuild(subElement, element, creator);
        }
    }
}

为了能够将上面这个XmlConfigurationProvider对象应用到我们的程序中，我们需要为它定义相应的IConfigurationSource对象，为此我们定义了如下这个ExtendedXmlConfigurationSource类型。它直接继承自XmlConfigurationSource对象，并在重写的Build方法中提供上面这个ExtendedXmlConfigurationProvider对象。为了方便将这个ExtendedXmlConfigurationSource对象注册到IConfigurationBuilder对象上，我们也可以进一步定义如下这些扩展方法。

public class ExtendedXmlConfigurationSource : XmlConfigurationSource
{
    public override IConfigurationProvider Build(IConfigurationBuilder builder)
    {
        EnsureDefaults(builder);
        return new ExtendedXmlConfigurationProvider(this);
    }
}

public static class ExtendedXmlConfigurationExtensions
{
    public static IConfigurationBuilder AddExtendedXmlFile( this IConfigurationBuilder builder, string path)=> builder.AddExtendedXmlFile(path, false, false);
    public static IConfigurationBuilder AddExtendedXmlFile( this IConfigurationBuilder builder, string path, bool optional) => builder.AddExtendedXmlFile(path, optional, false);
    public static IConfigurationBuilder AddExtendedXmlFile(tthis IConfigurationBuilder builder, string path, bool optional, bool reloadOnChange)
    {
        builder.Add(new ExtendedXmlConfigurationSource  { Path = path, Optional = optional, ReloadOnChange = reloadOnChange });
        return builder;
    }
}

[ASP.NET Core 3框架揭秘] 配置[1]：读取配置数据[上篇]
[ASP.NET Core 3框架揭秘] 配置[2]：读取配置数据[下篇]
[ASP.NET Core 3框架揭秘] 配置[3]：配置模型总体设计
[ASP.NET Core 3框架揭秘] 配置[4]：将配置绑定为对象
[ASP.NET Core 3框架揭秘] 配置[5]：配置数据与数据源的实时同步
[ASP.NET Core 3框架揭秘] 配置[6]：多样化的配置源[上篇]
[ASP.NET Core 3框架揭秘] 配置[7]：多样化的配置源[中篇]
[ASP.NET Core 3框架揭秘] 配置[8]：多样化的配置源[下篇]
[ASP.NET Core 3框架揭秘] 配置[9]：自定义配置源