WCF服务中的XML序列化怎么配置DataContractSerializer

WCF服务默认使用DataContractSerializer作为序列化器处理对象的XML序列化与反序列化工作，开发者可以通过多种方式配置该序列化器的行为，适配不同的业务需求。

DataContractSerializer的基础配置方式

服务契约级别配置

可以在服务契约的ServiceContract特性上指定ConfigurationName等属性，不过更常用的是在操作契约层面直接设置序列化器相关的参数。WCF提供了DataContractFormat特性，用于指定操作使用DataContractSerializer进行序列化，同时可以配置序列化的样式。

以下是一个操作契约级别配置DataContractSerializer的示例：

using System.ServiceModel;
using System.Runtime.Serialization;

// 定义服务契约
[ServiceContract]
public interface IUserService
{
    // 配置该操作使用DataContractSerializer，设置序列化样式为文档模式
    [OperationContract]
    [DataContractFormat(Style = OperationFormatStyle.Document)]
    UserInfo GetUserInfo(int userId);
}

// 定义数据契约
[DataContract]
public class UserInfo
{
    [DataMember]
    public int UserId { get; set; }

    [DataMember]
    public string UserName { get; set; }

    [DataMember]
    public int Age { get; set; }
}

数据契约特性配置

数据契约本身的特性设置会直接影响DataContractSerializer的序列化结果，常用的特性包括DataContract和DataMember，同时可以通过这些特性的属性控制序列化的细节。

• DataContract的Name和Namespace属性：可以自定义序列化后XML元素的名称和命名空间，避免和默认的.NET类型名称绑定。
• DataMember的Name属性：可以自定义字段或属性序列化后的XML元素名称。
• DataMember的Order属性：可以指定字段或属性在序列化XML中的排列顺序，默认按照字母顺序排列。
• DataMember的IsRequired属性：可以指定该成员是否为必填项，序列化时如果未赋值会按照默认值处理，反序列化时如果缺失会抛出异常。

以下是一个自定义数据契约序列化配置的例子：

using System.Runtime.Serialization;

[DataContract(Name = "User", Namespace = "http://ipipp.com/user")]
public class UserInfo
{
    [DataMember(Name = "Id", Order = 1, IsRequired = true)]
    public int UserId { get; set; }

    [DataMember(Name = "Name", Order = 2, IsRequired = true)]
    public string UserName { get; set; }

    [DataMember(Name = "UserAge", Order = 3)]
    public int Age { get; set; }
}

进阶配置：控制已知类型

当DataContractSerializer需要序列化或反序列化派生类型的对象时，需要提前声明已知类型，否则会出现序列化失败的问题。有两种方式配置已知类型：

使用KnownType特性

直接在数据契约上使用KnownType特性声明所有可能的派生类型，适合派生类型较少且固定的场景。

using System.Runtime.Serialization;

[DataContract]
[KnownType(typeof(StudentUserInfo))]
[KnownType(typeof(TeacherUserInfo))]
public class UserInfo
{
    [DataMember]
    public int UserId { get; set; }

    [DataMember]
    public string UserName { get; set; }
}

[DataContract]
public class StudentUserInfo : UserInfo
{
    [DataMember]
    public string StudentNo { get; set; }
}

[DataContract]
public class TeacherUserInfo : UserInfo
{
    [DataMember]
    public string TeacherTitle { get; set; }
}

使用ServiceKnownType特性

如果已知类型较多或者需要在服务契约层面统一管理，可以使用ServiceKnownType特性，该特性可以应用在服务契约或者操作契约上。

using System.ServiceModel;
using System.Runtime.Serialization;

[ServiceContract]
[ServiceKnownType(typeof(StudentUserInfo))]
[ServiceKnownType(typeof(TeacherUserInfo))]
public interface IUserService
{
    [OperationContract]
    UserInfo GetUserInfo(int userId);
}

配置序列化器的其他参数

在某些情况下，需要更精细地控制DataContractSerializer的行为，比如是否忽略扩展数据、最大对象数限制等，这时候可以通过自定义行为来实现。WCF允许通过DataContractSerializerOperationBehavior类来修改序列化器的配置参数。

以下是一个自定义操作行为修改DataContractSerializer配置的例子：

using System.ServiceModel;
using System.ServiceModel.Description;
using System.Runtime.Serialization;

public class CustomDataContractSerializerBehavior : IOperationBehavior
{
    public void AddBindingParameters(OperationDescription operationDescription, System.ServiceModel.Channels.BindingParameterCollection bindingParameters)
    {
    }

    public void ApplyClientBehavior(OperationDescription operationDescription, ClientOperation clientOperation)
    {
        ApplySerializerBehavior(operationDescription);
    }

    public void ApplyDispatchBehavior(OperationDescription operationDescription, DispatchOperation dispatchOperation)
    {
        ApplySerializerBehavior(operationDescription);
    }

    public void Validate(OperationDescription operationDescription)
    {
    }

    private void ApplySerializerBehavior(OperationDescription operationDescription)
    {
        // 获取操作的DataContractSerializer行为
        DataContractSerializerOperationBehavior serializerBehavior = operationDescription.Behaviors.Find<DataContractSerializerOperationBehavior>();
        if (serializerBehavior != null)
        {
            // 设置最大序列化对象数量
            serializerBehavior.MaxItemsInObjectGraph = 10000;
            // 设置是否忽略未知的数据成员
            serializerBehavior.IgnoreExtensionDataObject = true;
        }
    }
}

之后将该行为添加到对应的操作上即可生效。

常见问题与注意事项

• 只有标记了DataMember特性的属性或字段才会被DataContractSerializer序列化，未标记的会被忽略。
• 如果需要对序列化的XML进行更灵活的控制，比如自定义XML的节点结构、处理循环引用等，可以考虑使用XmlSerializer替代DataContractSerializer，不过XmlSerializer的性能会略低于DataContractSerializer。
• 配置已知类型时，要确保所有可能的派生类型都被声明，否则在反序列化时会抛出SerializationException异常。
• 数据契约的命名空间设置可以避免不同服务之间的类型命名冲突，建议在正式项目中统一设置命名空间。

WCFDataContractSerializerXML序列化DataContractServiceContract修改时间：2026-06-30 14:06:33