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:type,如下面的代码示例所示。
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 项目生成程序集,其中包含此示例中使用的所有类型。 使用此项目可以添加、删除或修改要序列化的类型。
使用此示例
使用 Visual Studio 打开DCRSample.sln解决方案文件。
若要运行解决方案,请按 F5。