防止属性在网络 API 中序列化

Question

我正在使用 MVC 4 网络 API，并 asp.net Web 表单 4.0 来构建一个静态 API。它工作得很好：

[HttpGet]
public HttpResponseMessage Me(string hash)
{
    HttpResponseMessage httpResponseMessage;
    List<Something> somethings = ...

    httpResponseMessage = Request.CreateResponse(HttpStatusCode.OK, 
                                 new { result = true, somethings = somethings });

    return httpResponseMessage;
}

现在我需要阻止一些属性被序列化。我知道我可以在列表上使用一些LINQ，只获取我需要的属性，通常这是一个很好的方法，但是在目前的场景中，某物对象太复杂了，我需要在不同的方法中使用不同的属性集，所以在运行时更容易标记要忽略的每个属性。

有没有办法做到这一点？

Answer 1

默认情况下，您可以采用“选择加入”方法，而不是让所有内容都序列化。在这种情况下，只允许您序列化您指定的属性。您可以使用“数据合同属性”和“数据成员属性”执行此操作，这些属性位于“系统.运行时.序列化”命名空间中。

DataContactAt⃣应用于类，DataMemberAt⃣应用于要序列化的每个成员：

[DataContract]
public class MyClass {

  [DataMember]
  public int Id { get; set;} // Serialized

  [DataMember]
  public string Name { get; set; } // Serialized

  public string DontExposeMe { get; set; } // Will not be serialized
}

我敢说这是一种更好的方法，因为它迫使您通过序列化来明确决定什么会或不会成功。它还允许您的模型类单独存在于项目中，而不必仅仅因为在其他地方使用 JSON.net 序列化它们而依赖于 JSON.net。

Answer 2

根据 Web API 文档页中的 JSON 和 XML 序列化 ASP.NET Web API 中要显式阻止对属性的序列化，您可以将 [JsonIgnore] 用于 Json 序列化程序，或者将 [忽略数据记忆] 用于默认的 XML 序列化程序。

但是，在测试中，我注意到 [IgnoreDataMember] 会阻止 XML 和 Json 请求的序列化，因此我建议使用它，而不是使用多个属性来修饰属性。

Answer 3

ASP.NET Web API使用< code>Json。Net作为默认格式化程序，因此，如果您的应用程序只使用JSON作为数据格式，您可以使用< code>[JsonIgnore]忽略用于序列化的属性:

public class Foo
{
    public int Id { get; set; }
    public string Name { get; set; }

    [JsonIgnore]
    public List<Something> Somethings { get; set; }
}

但是，这种方式不支持XML格式。所以，万一你的应用必须更多地支持XML格式(或者只支持XML)，而不是使用< code>Json。Net时，您应该使用同时支持JSON和XML的< code>[DataContract]:

[DataContract]
public class Foo
{
    [DataMember]
    public int Id { get; set; }
    [DataMember]
    public string Name { get; set; }

    //Ignore by default
    public List<Something> Somethings { get; set; }
}

要了解更多信息，您可以阅读官方文章。