json 序列化器 NullValueHandling 不使用 datamember 属性

在我的 Web api 项目中，现在我正在跳过 null 值。因此，返回 json 会忽略 null 值并打印属性。

在 Global.asax 文件中：

//manage the null in the response
var json = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
json.SerializerSettings.NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore;

但是，我想用“-”替换空值。但是，我不想为每个属性使用数据成员属性......

[DefaultValue("-")]. 

我的项目中有超过 10 个类...所以，这不是最优雅的解决方案。

我希望有一个简单的解决方案并适用于任何转换，就像 Global.asax 中的空值一样

Example.

public class User
{
    public string user { get; set; }

    public string name { get; set; }

    public string dni { get; set; }
}

当所有数据都存在时，我的服务返回

{
  "user": "usertest",
  "name": "nametest",
  "dni": "123456789"
}

但是，当 dni 不存在时，响应此

{
  "user": "usertest",
  "name": "nametest",
  "dni": ""
}

所以，我想回应如下

{
  "user": "usertest",
  "name": "nametest",
  "dni": "-"
}

您可以使用自定义来处理此问题IContractResolver。解析器可以应用一个IValueProvider到每个字符串属性，然后处理将空值转换为-（如果您要反序列化相同的 JSON，则返回）。

以下是解析器所需的代码：

public class NullStringReplacementResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        IList<JsonProperty> props = base.CreateProperties(type, memberSerialization);

        // Attach a NullStringReplacementProvider instance to each string property
        foreach (JsonProperty prop in props.Where(p => p.PropertyType == typeof(string)))
        {
            PropertyInfo pi = type.GetProperty(prop.UnderlyingName);
            if (pi != null)
            {
                prop.ValueProvider = new NullStringReplacementProvider(pi);
            }
        }

        return props;
    }

    protected class NullStringReplacementProvider : IValueProvider
    {
        PropertyInfo targetProperty;

        public NullStringReplacementProvider(PropertyInfo targetProperty)
        {
            this.targetProperty = targetProperty;
        }

        // GetValue is called by Json.Net during serialization.
        // The target parameter has the object from which to read the string;
        // the return value is the string that gets written to the JSON
        public object GetValue(object target)
        {
            // if the value of the target property is null, replace it with "-"
            string s = (string)targetProperty.GetValue(target);
            return (s == null ? "-" : s);
        }

        // SetValue gets called by Json.Net during deserialization.
        // The value parameter has the original value read from the JSON;
        // target is the object on which to set the value.
        public void SetValue(object target, object value)
        {
            // if the value in the JSON is "-" replace it with null
            string s = (string)value;
            targetProperty.SetValue(target, s == "-" ? null : s);
        }
    }
}

要使用自定义解析器，您需要将其添加到JsonSerializerSettings在序列化和反序列化期间使用。如果您使用 ASP.NET Web API，则可以通过将以下内容添加到Application_Start中的方法Global.asax.cs:

var config = GlobalConfiguration.Configuration;
var settings = config.Formatters.JsonFormatter.SerializerSettings;
settings.ContractResolver = new NullStringReplacementResolver();

Fiddle: https://dotnetfiddle.net/FVA3p8