Json.Net 忽略 Unity 中的序列化私有字段

Question

我想从 json 序列化中忽略序列化的私有字段，但似乎 [JsonIgnore] 仅适用于 public 字段，不适用于 [SerializeField] private 字段。有没有其他方法可以忽略这些字段？

这是一个示例类：

using UnityEngine;
using Newtonsoft.Json;

[JsonObject(MemberSerialization.OptIn)]
public class ExampleObject : MonoBehaviour {
    [JsonProperty]
    private string property = "Property";

    [JsonIgnore]
    [SerializeField]
    private string ignored = "Ignored";
}

输出

{"property":"Property","ignored":"Ignored"}

它仍然将ignored 字段序列化为json，即使我在类上使用[JsonObject(MemberSerialization.OptIn)] 并在private 字段上使用[JsonIgnore]。

MemberSerialization.OptIn 这么说

“只有标有JsonPropertyAttribute 或System.Runtime.Serialization.DataMemberAttribute 的成员才会被序列化”

，但它似乎也包含SerializeField 属性。

编辑：我正在使用 JilleJr Newtonsoft.Json-for-Unity (github link) 和 JilleJr Newtonsoft.Json-for-Unity.Converters(github link)

Answer 1

问题是您使用的 Json.NET 端口JilleJr Newtonsoft.Json-for-Unity.Converters 包含一个自定义合约解析器UnityTypeContractResolver，其中包括标记为[SerializeField] 的成员即使还标记为[JsonIgnore]。来自source：

protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
{
   JsonProperty jsonProperty = base.CreateProperty(member, memberSerialization);

   // A check for member.GetCustomAttribute<JsonIgnoreAttribute>() is missing in the following line:
   if (member.GetCustomAttribute<SerializeField>() != null) 
   {
       jsonProperty.Ignored = false;
       jsonProperty.Writable = CanWriteMemberWithSerializeField(member);
       jsonProperty.Readable = CanReadMemberWithSerializeField(member);
       jsonProperty.HasMemberAttribute = true;
   }

   return jsonProperty;
}

如果您不希望这样，则需要将此合同解析器子类化并纠正行为：

public class FixedUnityTypeContractResolver : Newtonsoft.Json.UnityConverters.UnityTypeContractResolver
{
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
    {
       JsonProperty jsonProperty = base.CreateProperty(member, memberSerialization);

       if (!jsonProperty.Ignored && member.GetCustomAttribute<Newtonsoft.Json.JsonIgnoreAttribute>() != null) 
           jsonProperty.Ignored = true;

       return jsonProperty;
    }
}

然后序列化如下：

// Cache and reuse the contract resolver throughout your project to improve performance.
static Newtonsoft.Json.Serialization.IContractResolver _resolver = new FixedUnityTypeContractResolver ();

var settings = new JsonSerializerSettings 
{
    ContractResolver = _resolver,
};
JsonConvert.SerializeObject(this, settings);