DataContractResolver

A DataContractResolver minta bemutatja, hogyan szabhatók testre a szerializálási és deszerializálási folyamatok az DataContractResolver osztály használatával. Ez a minta bemutatja, hogyan lehet a DataContractResolver használatával a CLR-típusokat xsi:type reprezentációba és azokból képezni szerializálás és deszerializálás során.

Minta részletei

A minta a következő CLR-típusokat határozza meg.

using System;
using System.Runtime.Serialization;

namespace Types
{
    [DataContract]
    public class Customer
    {
        [DataMember]
        public string Name { get; set; }
    }

    [DataContract]
    public class VIPCustomer : Customer
    {
        [DataMember]
        public string VipInfo { get; set; }
    }

    [DataContract]
    public class RegularCustomer : Customer
    {
    }

    [DataContract]
    public class PreferredVIPCustomer : VIPCustomer
    {
    }
}

A minta betölti az összeállítást, kinyeri ezeket a típusokat, majd sorosítja és visszasorosítja őket. A DataContractResolver szerializálási folyamatba úgy csatlakozik, hogy átadja a DataContractResolver-származtatott osztály egy példányát a DataContractSerializer konstruktornak, ahogyan az az alábbi példában látható.

this.serializer = new DataContractSerializer(typeof(Object), null, int.MaxValue, false, true, null, new MyDataContractResolver(assembly));

A minta ezután szerializálja a CLR-típusokat az alábbi kód példában látható módon.

Assembly assembly = Assembly.Load(new AssemblyName("Types"));

public void serialize(Type type)
{
    Object instance = Activator.CreateInstance(type);

    Console.WriteLine("----------------------------------------");
    Console.WriteLine();
    Console.WriteLine("Serializing type: {0}", type.Name);
    Console.WriteLine();
    this.buffer = new StringBuilder();
    using (XmlWriter xmlWriter = XmlWriter.Create(this.buffer))
    {
        try
        {
            this.serializer.WriteObject(xmlWriter, instance);
        }
        catch (SerializationException error)
        {
            Console.WriteLine(error.ToString());
        }
    }
    Console.WriteLine(this.buffer.ToString());
}

A minta ezután deszerializálja az xsi:types típusokat az alábbi kód példában látható módon.

public void deserialize(Type type)
{
    Console.WriteLine();
    Console.WriteLine("Deserializing type: {0}", type.Name);
    Console.WriteLine();
    using (XmlReader xmlReader = XmlReader.Create(new StringReader(this.buffer.ToString())))
    {
        Object obj = this.serializer.ReadObject(xmlReader);
    }
}

Mivel az egyéni DataContractResolver elemet átadjuk a DataContractSerializer konstruktornak, a szerializálás során a TryResolveType meghívásra kerül, hogy a CLR-típust egy ekvivalens xsi:type-re leképezze. Hasonlóképpen a ResolveName deszerializálás során van meghívva, hogy az xsi:type egy megfelelő CLR típusra legyen leképezve. Ebben a mintában a DataContractResolver következő példában látható módon van definiálva.

Az alábbi példakód egy osztály, amely a következőből DataContractResolverszármazik: .

class MyDataContractResolver : DataContractResolver
{
    private Dictionary<string, XmlDictionaryString> dictionary = new Dictionary<string, XmlDictionaryString>();
    Assembly assembly;

    public MyDataContractResolver(Assembly assembly)
    {
        this.assembly = assembly;
    }

    // Used at deserialization
    // Allows users to map xsi:type name to any Type
    public override Type ResolveName(string typeName, string typeNamespace, DataContractResolver knownTypeResolver)
    {
        XmlDictionaryString tName;
        XmlDictionaryString tNamespace;
        if (dictionary.TryGetValue(typeName, out tName) && dictionary.TryGetValue(typeNamespace, out tNamespace))
        {
            return this.assembly.GetType(tNamespace.Value + "." + tName.Value);
        }
        else
        {
            return null;
        }
    }

    // Used at serialization
    // Maps any Type to a new xsi:type representation
    public override void ResolveType(Type dataContractType, DataContractResolver knownTypeResolver, out XmlDictionaryString typeName, out XmlDictionaryString typeNamespace)
    {
        string name = dataContractType.Name;
        string namesp = dataContractType.Namespace;
        typeName = new XmlDictionaryString(XmlDictionary.Empty, name, 0);
        typeNamespace = new XmlDictionaryString(XmlDictionary.Empty, namesp, 0);
        if (!dictionary.ContainsKey(dataContractType.Name))
        {
            dictionary.Add(name, typeName);
        }
        if (!dictionary.ContainsKey(dataContractType.Namespace))
        {
            dictionary.Add(namesp, typeNamespace);
        }
    }
}

A minta részeként a Types projekt létrehozza a szerelvényt az ebben a mintában használt összes típussal. Ezzel a projektel hozzáadhatja, eltávolíthatja vagy módosíthatja a szerializálni kívánt típusokat.

A minta használata

1. A Visual Studio használatával nyissa meg a DCRSample.sln megoldásfájlt.

2. A megoldás futtatásához nyomja le az F5 billentyűt.

Lásd még

• Adatszerződés-feloldó használata