WebAPI：默认 XML 序列化程序未抑制空值答案

【问题标题】：WebAPI: Null values not suppressed by Default XML SerializerWebAPI：默认 XML 序列化程序未抑制空值
【发布时间】：2021-08-22 03:59:07
【问题描述】：

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

这是我相当简单的课程。如您所见，我正在尝试使用声明性属性以及 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 中的一个 sn-p。如您所见，医生被序列化到 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"));
    }
}

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

除了 XmlSerializer 之外，默认的 WebAPI Xml Serializer 是什么？
我注意到 XmlSerializer 发出的 Xml 的结构与默认 WebAPI 序列化程序发出的结构不同（除了省略 nil 元素）。这是否会在尝试将 Xml 反序列化为接收端的类表示时出现问题？

【问题讨论】：

我无法重现您的问题。你能分享一个小项目来展示你的进展吗？
如果我明确使用 XmlSerializer，问题就会消失。 (config.Formatters.XmlFormatter.UseXmlSerializer = true;)

标签： c# asp.net-web-api xml-serialization

【解决方案1】：

添加类

[Serializable]
[DataContract(IsReference = true)]

添加字段

[DataMember]

并添加配置

config.Formatters.XmlFormatter.UseXmlSerializer = true;

并删除

[XmlElement(IsNullable = false)]

在字段中

【讨论】：

【解决方案2】：

此声明性标记 - [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;

       ...

   }
}

【讨论】：