c# - 忽略 web api 中序列化程序的空值和默认值

Question

我想忽略 Json 序列化中为 null 的那些属性。为此，我在我的 webapi.config 文件中添加了这一行。

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

public static void Register(HttpConfiguration config)
        {          
            config.SuppressDefaultHostAuthentication();
            config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));
            config.MapHttpAttributeRoutes();
            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{action}/{identifier}",
                defaults: new { identifier = RouteParameter.Optional }  
            );
            config.Formatters.JsonFormatter.SerializerSettings = new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling= DefaultValueHandling.Ignore };
        }

但它并没有忽略那些为空的属性。

这是我的类(class)

public class UserProfile
    {
        [JsonProperty("fullname")]
        public string FullName { get; set; }

        [JsonProperty("imageid")]
        public int ImageId { get; set; }

        [JsonProperty("dob")]
        public Nullable<DateTime> DOB { get; set; }
    }

是web api返回的Json

    {
  "fullname": "Amit Kumar",
  "imageid": 0,
  "dob": null
}

我没有给dob和imageid赋值。

我关注这个Link , 但它并没有解决我的问题。

Answer 1

通过查看 Newtonsoft.Json source code我相信装饰类属性的 JsonPropertyAttribute 会覆盖 JsonSerializerSettings 中指定的默认 NullValueHandling。

要么删除此类属性(如果您想使用全局定义的 NullValueHandling)，要么显式指定 NullValueHandling:

public class UserProfile
{
    [JsonProperty("fullname")]
    public string FullName { get; set; }

    [JsonProperty("imageid")]
    public int ImageId { get; set; }

    [JsonProperty("dob", NullValueHandling = NullValueHandling.Ignore)]
    public Nullable<DateTime> DOB { get; set; }
}