WebAPI：默认 XML 序列化程序不会抑制空值

如何解决WebAPI：默认 XML 序列化程序不会抑制空值

我尝试使用 StackOverflow 上其他文章中关于这个问题的建议，但没有骰子。我无法从 Xml 序列化中抑制我的空属性。

这是我相当简单的课程。如您所见，我正在尝试使用声明性属性以及 ShouldSerialize{variable} 技术，但这些都无法有效地从 Xml 中抑制这些属性。

public class Practice
{
#pragma warning disable 0649
    public int id;
    public string name;
    public string sharedId;
    public string sharedIdType;
    
    [XmlElement(IsNullable = false)]
    public List<Doctor> doctors;

    [XmlElement(IsNullable = false)]
    public List<Employee> employees;

    public bool ShouldSerializedoctors()
    {
        return !(doctors == null);
    }

    public bool ShouldSerializeemployees()
    {
        return !(employees == null);
    }
#pragma warning restore 0649
}

这是生成的 Xml 的一个片段。如您所见，即使它为空，医生也被序列化到 Xml 中。这是一个运行在 Framework 4.5.2 上的 WebAPI 项目。知道我做错了什么吗？

<ArrayOfPractice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/rater8.Common.Models">
   <Practice>
       <doctors i:nil="true"/>
       <employees>
           <Employee>
              <id>49</id>

顺便说一句 - 我能够使用以下方法抑制 Json 序列化中的空值：

config.Formatters.JsonFormatter.SerializerSettings =
    new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore };

以下是一些附加信息：

通过将以下语句添加到 WebApiCofig.Register 中，我现在可以看到对 nil 元素的抑制。

config.Formatters.XmlFormatter.UseXmlSerializer = true;

这里是这个方法的完整代码：

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services

        // Web API routes
        config.MapHttpAttributeRoutes();

        config.Routes.MapHttpRoute(
            name: "DefaultApi",routeTemplate: "api/{controller}/{id}",defaults: new { id = RouteParameter.Optional }
        );

        config.Formatters.JsonFormatter.SerializerSettings =
             new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore };

        config.Formatters.XmlFormatter.UseXmlSerializer = true;

        GlobalConfiguration.Configuration.Formatters.JsonFormatter.MediaTypeMappings.Add
            (new QueryStringMapping("format","json","application/json"));
        GlobalConfiguration.Configuration.Formatters.XmlFormatter.MediaTypeMappings.Add
            (new QueryStringMapping("format","xml","application/xml"));
    }
}

所以这解决了最初的问题描述，但这引发了一些额外的问题。

1. 除了 XmlSerializer 之外，默认的 WebAPI Xml Serializer 是什么？

2. 我注意到 XmlSerializer 发出的 Xml 结构与默认 WebAPI 序列化器发出的结构不同（除了省略 nil 元素）。这是否会导致在接收端尝试将 Xml 反序列化为其类表示时出现问题？

解决方法

此声明性标记 - [XmlElement(IsNullable = false)] - 受 XmlSerializer 支持，但被 DataContractSerializer 忽略。如果要使用此标记，则需要明确选择 XmlSerializer。如下：

public static class WebApiConfig
{
   public static void Register(HttpConfiguration config)
   {
       // Web API configuration and services

       ...

       config.Formatters.XmlFormatter.UseXmlSerializer = true;

       ...

   }
}