Configurazione personalizzata .NET - Posso avere una raccolta di elementi con elementi non omogenei?

Question

Ho una sezione di configurazione personalizzata registrata nell'app/web.config, chiamiamola MySection. Ho un elemento ElementCollection all'interno della sezione, chiamato MyElements. All'interno della collezione di elementi voglio avere elementi che sono rappresentati da classi diverse - l'idea è che si tratta di classi simili con alcune proprietà comuni e alcune specifiche dell'istanza.

Ecco alcuni esempi di configurazione XML:

<MySection> 
    <MyElements> 
    <Element1 name="someProp1" value="someValue" /> 
    <Element2 name="someProp2" format="{0}{1}" /> 
    </MyElements> 
</MySection> 

Nel mio semplice esempio, tutti gli elementi devono avere un 'nome' di proprietà, alcuni avranno anche una proprietà 'valore', e l'altro un 'format' proprietà. Qui, voglio rappresentare Element1 e Element2 nel runtime .NET da due classi diverse che hanno una classe base comune che definisce la proprietà 'nome'.

Per quanto ho scavato nella configurazione .NET, ho avuto l'impressione che una raccolta di elementi (come "MyElements" qui) dovesse contenere elementi omogenei (solo di un tipo). Quindi, potrebbe essere possibile ottenere ciò che voglio: farlo contenere elementi di classi diverse. L'idea è di evitare di avere più di una raccolta di elementi per diversi tipi di elementi e di non scrivere tutte le proprietà di ripetizione per ogni implementazione personalizzata di ConfigurationElement.

Answer 1

È possibile ottenere ciò sostituendo il metodo OnDeserializeUnrecognizedElement nella classe ElementCollection e creando rappresentazioni di Element1 e Element2 attivando il nome del tag per ex. Ma gli elementi figli di AFAIR dovrebbero comunque essere derivati ​​da antenati comuni, farlo altrimenti è troppo disturbo.

Definire collezione come:

public class MyElementCollection : ConfigurationElementCollection 
{ 
    const string ELEMENT1 = "Element1"; 
    const string ELEMENT2 = "Element2"; 

    protected override ConfigurationElement CreateNewElement() 
    { 
     return new MyElement (this); 
    } 

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

    // This method called when framework sees unknown element tag 
    // inside the collection. You can choose to handle it yourself 
    // and return true, or return false to invoke default action 
    // (exception will be thrown). 
    protected override bool OnDeserializeUnrecognizedElement (string elementName, XmlReader reader) 
    { 
     if (elementName == ELEMENT1 || elementName == ELEMENT2 { 
      var myElement = new MyElement (this); 

      switch (elementName) { 
      case ELEMENT1: 
       myElement.Type = MyElementType.Element1; 
       break; 
      case ELEMENT2: 
       myElement.Type = MyElementType.Element2; 
       break; 
      } 

      myElement.DeserializeElementForConfig (reader, false); 
      BaseAdd (myElement); 

      return true; 
     } 

     return false; 
    } 
} 

E elemento secondario:

public enum MyElementType 
{ 
    Element1, 
    Element2, 
} 

public class MyElement : ConfigurationElement 
{ 
    const string NAME = "name"; 
    const string VALUE = "value"; 
    const string FORMAT = "format"; 

    // keys should be unique, current collection count will do 
    // the trick without introducing artificial keys 
    public MyElement (ConfigurationElementCollection collection) 
    { 
     Key = collection.Count; 
    } 

    // note that this is not ConfigurationProperty 
    public int Key { get; private set; } 

    // note that this is not ConfigurationProperty 
    public MyElementType Type { get; set; } 

    [ConfigurationProperty(NAME)] 
    public string Name { 
     get { return (string)this [NAME]; } 
    } 

    [ConfigurationProperty(VALUE)] 
    public string Value { 
     get { return (string)this [VALUE]; } 
    } 

    [ConfigurationProperty(FORMAT)] 
    public string Format { 
     get { return (string)this [FORMAT]; } 
    } 

    // This is called when framework needs a copy of the element, 
    // but it knows only about properties tagged with ConfigurationProperty. 
    // We override this to copy our Key and Type, otherwise they will 
    // have default values. 
    protected override void Reset (ConfigurationElement parentElement) 
    { 
     base.Reset (parentElement); 

     var myElement = (MyElement)parentElement; 
     Key = myElement.Key; 
     Type = myElement.Type; 
    } 

    // original ConfigurationElement have this protected, 
    // redeclaring as protected internal to call it from collection class 
    protected internal void DeserializeElementForConfig (XmlReader reader, bool serializeCollectionKey) 
    { 
     DeserializeElement (reader, serializeCollectionKey); 
    } 
}