具有多个不同类型的 ConfigurationElement 的 ConfigurationElementCollection

Question

是否可以拥有一个具有许多不同类型 CollectionElements 的 CollectionElementCollection，例如：

<collection>
    <add type="MyType1, MyLib" Type1SpecificProp="1" />
    <add type="MyType2, MyLib" Type2SpecificProp="2" />
</collection

我拥有此类解决方案所需的所有类：

class MyCollection : ConfigurationElementCollection { }
class MyElement : ConfigurationElement { }
class MyType1 : MyElement { }
class MyType2 : MyElement { }
...
etc

但是当我启动我的应用程序时，我会收到下一个可预测的错误：

无法识别的属性“Type1SpecificProp”。

因为 Type1SpecificProp 是在 MyType1 中定义的，而不是在 MyElement 中定义的，特别是如果 MyCollection 有 next 方法：

protected override ConfigurationElement CreateNewElement()
{
    return new MyElement(); // but I want instantiate not the base class but by a type given
}

即返回基类，因此 <子类中的 code>OnDeserializeUnrecognizedAttribute() 从未被调用。

那么问题来了：如何让子类自己解决未知元素呢？

Answer 1

我也调查了这一点。 PolymorphicConfigurationElementCollection 似乎已弃用。
编辑：不是，请参阅下面“abatishchev”的评论，我只是链接旧版本。

Rest Wing 的解决方案很有希望，但不幸的是需要调用驻留在另一个命名空间中的内部方法。虽然这可以通过反射实现，但在这种情况下，它不会因为编码美观而付出代价。

我也用 Reflection 深入研究了源代码，并提出了以下解决方案：

[ConfigurationCollection(typeof(ElementBaseConfig), CollectionType=ConfigurationElementCollectionType.BasicMap)]
public class MyTypesConfigCollection : ConfigurationElementCollection
{
    protected override ConfigurationElement CreateNewElement()
    {
        // Not used but function must be defined
        return null;
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        return element;
    }

    protected override ConfigurationElement CreateNewElement(string elementName)
    {
        switch (elementName)
        {
            case "mytype1":
                return new MyType1Config();

            case "mytype2":
                return new MyType2Config();

            default:
                throw new ConfigurationErrorsException(
                    string.Format("Unrecognized element '{0}'.", elementName));
        }
    }

    protected override bool IsElementName(string elementName)
    {
        // Required to be true
        return true;
    }

    public override ConfigurationElementCollectionType CollectionType
    {
        get { return ConfigurationElementCollectionType.BasicMap; }
    }
}

CollectionType 的重写是必需的，即使这是通过顶部的属性指定的。当不重写基类时，CollectionType 仍然引用“AddRemoveClearMap”，它不会触发所需的“CreateNewElement(string elementName)”函数，但它是无参数变体“CreateNemElement()”。出于同样的原因，覆盖的 IsElementName 函数应该返回 true。

请注意，我创建了一个 ElementBaseConfig，它是 MyType1Config 和 MyType2Config 的基类，您可以在其中定义一些共享属性。

Answer 2

来自 EntLib5 的 Microsoft.Practices.EnterpriseLibrary.Common.Configuration.PolymorphicConfigurationElementCollection 可以作为一个魅力来完成这项工作。

Answer 3

需要创建特定类型（MyType1 和 MyType2）的实例，以便子类能够自行解析未知元素或属性。

由于 CreateNewElement 方法不提供有关元素属性的任何信息，因此这不是可以发生特定类型实例化的地方。

通过 Reflector 进行一些挖掘后，我们得到以下部分调用堆栈：

VariantCollection.MyCollection.CreateNewElement()
System.Configuration.ConfigurationElementCollection.CallCreateNewElement()
System.Configuration.ConfigurationElementCollection.OnDeserializeUnrecognizedElement(string elementName, XmlReader reader)

可以在 MyCollection 类中重写 OnDeserializeUnrecognizedElement 方法，以便创建特定类型实例。不要使用无参数 CallCreateNewElement 方法，而是使用接收 XmlReader:

1. Read attribute type 的新方法（确保其存在和有效性）。
2. 创建指定类型的新元素。
3. 在元素上调用 System.Configuration.ConfigurationElement 的内部 virtual void AssociateContext( BaseConfigurationRecord configRecord ) 方法。
4. 在元素上调用 System.Configuration.ConfigurationElement 的 internal void CallInit() 方法。
5. 返回准备好的元素。

顺便说一句，如果不会有太多不同的集合元素，请考虑使用类似的方法：

<myType1Collection>
    <add Type1SpecificProp="1" />
</myType1Collection>
<myType2Collection>
    <add Type2SpecificProp="2" />
</myType2Collection>

这样您就可以避免将项目从 MyCollection 转换为特定类型。