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

Question

我想减少字符串 Json.NET使用默认值生成。

我的属性之一如下:

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

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

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

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

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

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

Answer 1

是的，您可以使用如下所示的自定义 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

关于这个解决方案的一些说明:

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

• 您可能希望实现类级别的退出机制(即解析器查找的自定义属性，或者可能是您传递给解析器的类名列表)，以防您遇到某些情况您确实希望为某些类而不是其他类序列化默认值。