共用方式為


DataContractResolver

DataContractResolver 範例示範如何使用DataContractResolver類別來自定義序列化和還原序列化的過程。 此範例示範如何使用 DataContractResolver,在序列化和反序列化期間,將 CLR 類型對應至 xsi:type 表示。

範例詳情

此範例會定義下列 CLR 類型。

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
    {
    }
}

此範例會載入元件、擷取每個類型,然後將它們序列化和反序列化。 將 DataContractResolver 衍生類別的 DataContractResolver實例傳遞至 DataContractSerializer 建構函式,以插入串行化進程,如下列範例所示。

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

然後,此範例會串行化 CLR 類型,如下列程式代碼範例所示。

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());
}

然後,此範例會還原串行化 xsi:types,如下列程式代碼範例所示。

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);
    }
}

由於自訂 DataContractResolver 被傳入 DataContractSerializer 建構函式,因此在序列化期間會呼叫 TryResolveType,以將 CLR 類型對應至對等 xsi:type。 同樣地,會在還原序列化期間呼叫ResolveName,以將xsi:type對應到等效的CLR類型。 在此範例中,DataContractResolver 的定義如下例所示。

下列程式代碼範例是衍生自 DataContractResolver的類別。

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);
        }
    }
}

作為範例的一部分,Types 專案會產生元件,其中包含此範例中使用的所有類型。 使用此專案來新增、移除或修改將序列化的型別。

若要使用此範例

  1. 使用 Visual Studio 開啟DCRSample.sln方案檔。

  2. 若要執行解決方案,請按 F5

另請參閱