Json.NET 从自动属性初始值设定项获取默认值

我想减少字符串Json.NET https://github.com/JamesNK/Newtonsoft.Json使用默认值生成。

我的属性之一如下：

public string Name { get; set; } = "Jennifer";

我已经使用自动属性初始值设定项，因此如果字符串为空，则会填充该字符串。

当使用 Json.NET 进行序列化时，我使用DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate因此只有更改的属性才会被保留。

我知道我可以使用DefaultValueAttribut像这样：

[DefaultValue("Jennifer")]
public string Name { get; set; } = "Jennifer";

但我想知道是否可以跳过此属性并在序列化时使用自动属性初始值作为默认值。

是的，您可以使用自定义来做到这一点ContractResolver比如下面这个。它的工作原理是为每个Type（假设Type是一个类并且有一个可用的默认构造函数），然后设置ShouldSerialize对每个属性进行谓词，根据引用实例检查属性的当前值。如果它们匹配，那么ShouldSerialize返回 false 并且该属性未序列化。

class CustomResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        IList<JsonProperty> props = base.CreateProperties(type, memberSerialization);
        if (type.IsClass)
        {
            ConstructorInfo ctor = type.GetConstructor(Type.EmptyTypes);
            if (ctor != null)
            {
                object referenceInstance = ctor.Invoke(null);
                foreach (JsonProperty prop in props.Where(p => p.Readable))
                {
                    prop.ShouldSerialize = instance =>
                    {
                        object val = prop.ValueProvider.GetValue(instance);
                        object refVal = prop.ValueProvider.GetValue(referenceInstance);
                        return !ObjectEquals(val, refVal);
                    };
                }
            }
        }
        return props;
    }

    private bool ObjectEquals(object a, object b)
    {
        if (ReferenceEquals(a, b)) return true;
        if (a == null || b == null) return false;
        if (a is IEnumerable && b is IEnumerable && !(a is string) && !(b is string))
            return EnumerableEquals((IEnumerable)a, (IEnumerable)b);
        return a.Equals(b);
    }

    private bool EnumerableEquals(IEnumerable a, IEnumerable b)
    {
        IEnumerator enumeratorA = a.GetEnumerator();
        IEnumerator enumeratorB = b.GetEnumerator();
        bool hasNextA = enumeratorA.MoveNext();
        bool hasNextB = enumeratorB.MoveNext();
        while (hasNextA && hasNextB)
        {
            if (!ObjectEquals(enumeratorA.Current, enumeratorB.Current)) return false;
            hasNextA = enumeratorA.MoveNext();
            hasNextB = enumeratorB.MoveNext();
        }
        return !hasNextA && !hasNextB;
    }
}

要使用解析器，您需要将其添加到JsonSerializerSettings并将设置传递给SerializeObject像这样的方法：

JsonSerializerSettings settings = new JsonSerializerSettings
{
    ContractResolver = new CustomResolver(),
};
string json = JsonConvert.SerializeObject(yourObject, settings);

这是一个工作演示：https://dotnetfiddle.net/K1WbSP https://dotnetfiddle.net/K1WbSP

关于此解决方案的一些注意事项：

• 使用该解析器比使用该解析器具有功能优势DefaultValue属性，因为它可以处理复杂的默认值，例如Lists, Dictionaries和子对象（前提是您已正确实现Equals子类的方法）。属性只能处理简单的常量表达式（例如字符串、枚举和其他原语）。但是，如果您需要的只是简单的默认值，请注意，此解析器的性能可能比仅使用属性稍差，因为它需要使用额外的反射来实例化引用对象并比较所有属性值。因此需要进行一些权衡。如果您的 JSON 很小，您可能不会注意到差异。但如果您的 JSON 很大，那么您可能需要做一些基准测试。

• 您可能想要实现类级选择退出机制（即解析器查找的自定义属性，或者可能是传递给解析器的类名列表），以防遇到以下情况：do希望为某些类序列化默认值，但不序列化其他类。