.NET Core采用的全新配置系统[9]: 为什么针对XML的支持不够好？如何改进？

物理文件是我们最常用到的原始配置的载体，最佳的配置文件格式主要由三种，它们分别是JSON、XML和INI，对应的配置源类型分别是JsonConfigurationSource、XmlConfigurationSource和IniConfigurationSource。但是对于.NET Core的配置系统来说，我们习以为常的XML反倒不是理想的配置源，至少和JSON比较起来，它具有一个先天不足的劣势，那就是针对集合数据结构的支持不如人意。[ 本文已经同步到《ASP.NET Core框架揭秘》之中]

一、为什么针对集合的配置难以通过优雅的XML来表示

在《配置模型设计详解》一文中我们对配置模型的设计和实现进行了详细介绍。在此文中我们说应用中的配置体现为一种树形化的层次结构，所我将它称为“配置树”，具体的配置数据通过配置树的“叶子节点”承载。当配置数据从不同的来源加载之后都会转换成一个字典，我将其称为“配置字典”。为了让“配置字典”能够存储“配置树”的所有数据和自身结构，我们需要在配置字典中存储所有叶子节点，叶子节点的路径和值将直接作为字典元素的Key和Value。由于字典的Key是唯一的，这就要求配置树中的每一个节点必须具有唯一的路径。XmlConfigurationSource/XmlConfigurationProvider不能很好地支持集合数据结构的问题就出现在这里。

public class Profile
{
    public Gender         Gender { get; set; }
    public int            Age { get; set; }
    public ContactInfo    ContactInfo { get; set; }
}

public class ContactInfo
{
    public string EmailAddress { get; set; }
    public string PhoneNo { get; set; }
}

public enum Gender
{
    Male,
    Female
}

举个简单的例子，假设需要采用XML来表示一个Profile对象的集合（Profile的类型具有如上所示的定义），那么我们很自然地会采用如下的结构。

<Profiles>
  <Profile Gender="Male" Age="18">
    <ContactInfo EmailAddress ="foobar@outlook.com" PhoneNo="123"/>
  </Profile>
  <Profile Gender="Male" Age="25">
    <ContactInfo EmailAddress ="bar@outlook.com" PhoneNo="456"/>
  </Profile>
  <Profile Gender="Male" Age="40">
    <ContactInfo EmailAddress ="baz@outlook.com" PhoneNo="789"/>
</Profile>

对于这段XML结构，XmlConfigurationProvider会采用“简单粗暴”的方式将它映射为如下所示的“配置树”。由于这棵树直接将XML元素的名称作为配置节点名称，所以三个Profile对象在这棵树中的根节点都以“Profile”命名，毫无疑问，这颗树将不能使用字典来表示，因为它不能保证所有的节点都具有不同的路径。

二、按照配置树的要求对XML结构稍作转换

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

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

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

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

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

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

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

        foreach (XmlElement element in sourceDoc.DocumentElement.ChildNodes)
        {
            this.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<XmlElement>().Count() > 1)
        {
            if (element.ChildNodes.OfType<XmlElement>().GroupBy(it => it.Name).Count() == 1)
            {
                int 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)
    {
        string index = source.GetAttribute("append_index");
        string elementName = string.IsNullOrEmpty(index) ? source.Name : $"{source.Name}_index_{index}";
        XmlElement 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);
        }
    }
}