Question

我需要能够控制如何/是否序列化类上的某些属性。最简单的情况是[ScriptIgnore]。但是，我只希望这些属性能够适用于我正在处理的这个特定的序列化情况 - 如果应用程序中的下游其他模块也想要序列化这些对象，则这些属性都不应该妨碍。

所以我的想法是在属性上使用自定义属性MyAttribute，并使用知道查找该属性的钩子初始化JsonSerializer的特定实例。

乍一看，我没有看到JSON.NET中任何可用的钩子点都会为当前属性提供PropertyInfo来进行这样的检查 - 只有属性的值。我错过了什么吗？或者更好的方法来解决这个问题？

Answer 1

这是基于the accepted answer的通用可重用“忽略属性”解析器：

/// <summary>
/// Special JsonConvert resolver that allows you to ignore properties.  See https://stackoverflow.com/a/13588192/1037948
/// </summary>
public class IgnorableSerializerContractResolver : DefaultContractResolver {
    protected readonly Dictionary<Type, HashSet<string>> Ignores;

    public IgnorableSerializerContractResolver() {
        this.Ignores = new Dictionary<Type, HashSet<string>>();
    }

    /// <summary>
    /// Explicitly ignore the given property(s) for the given type
    /// </summary>
    /// <param name="type"></param>
    /// <param name="propertyName">one or more properties to ignore.  Leave empty to ignore the type entirely.</param>
    public void Ignore(Type type, params string[] propertyName) {
        // start bucket if DNE
        if (!this.Ignores.ContainsKey(type)) this.Ignores[type] = new HashSet<string>();

        foreach (var prop in propertyName) {
            this.Ignores[type].Add(prop);
        }
    }

    /// <summary>
    /// Is the given property for the given type ignored?
    /// </summary>
    /// <param name="type"></param>
    /// <param name="propertyName"></param>
    /// <returns></returns>
    public bool IsIgnored(Type type, string propertyName) {
        if (!this.Ignores.ContainsKey(type)) return false;

        // if no properties provided, ignore the type entirely
        if (this.Ignores[type].Count == 0) return true;

        return this.Ignores[type].Contains(propertyName);
    }

    /// <summary>
    /// The decision logic goes here
    /// </summary>
    /// <param name="member"></param>
    /// <param name="memberSerialization"></param>
    /// <returns></returns>
    protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization) {
        JsonProperty property = base.CreateProperty(member, memberSerialization);

        if (this.IsIgnored(property.DeclaringType, property.PropertyName)
        // need to check basetype as well for EF -- @per comment by user576838
        || this.IsIgnored(property.DeclaringType.BaseType, property.PropertyName)) {
            property.ShouldSerialize = instance => { return false; };
        }

        return property;
    }
}

用法：

var jsonResolver = new IgnorableSerializerContractResolver();
// ignore single property
jsonResolver.Ignore(typeof(Company), "WebSites");
// ignore single datatype
jsonResolver.Ignore(typeof(System.Data.Objects.DataClasses.EntityObject));
var jsonSettings = new JsonSerializerSettings() { ReferenceLoopHandling = ReferenceLoopHandling.Ignore, ContractResolver = jsonResolver };

Answer 2

使用JsonIgnore属性。

例如，要排除Id：

public class Person {
    [JsonIgnore]
    public int Id { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
}

Answer 3

您有几个选择。我建议您在阅读下面的内容之前阅读Json.Net文档article on the subject。

本文介绍了两种方法：

创建一个方法，该方法根据Json.Net将遵循的命名约定返回bool值，以确定是否序列化该属性。
创建忽略该属性的自定义合约解析程序。

在这两者中，我赞成后者。完全跳过属性 - 仅使用它们来忽略所有形式的序列化中的属性。相反，创建一个忽略相关属性的自定义合约解析程序，并且只在您想要忽略该属性时才使用合同解析程序，让该类的其他用户可以自由地序列化该属性，或者不要随意使用。

修改为了避免链接损坏，我发布了文章中的相关代码

public class ShouldSerializeContractResolver : DefaultContractResolver
{
   public new static readonly ShouldSerializeContractResolver Instance =
                                 new ShouldSerializeContractResolver();

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

      if( property.DeclaringType == typeof(Employee) &&
            property.PropertyName == "Manager" )
      {
         property.ShouldSerialize = instance =>
         {
            // replace this logic with your own, probably just  
            // return false;
            Employee e = (Employee)instance;
            return e.Manager != e;
         };
      }

      return property;
   }
}

Answer 4

这是一个基于drzaus优秀序列化器合约的方法，它使用lambda表达式。只需将其添加到同一个班级。毕竟，谁不喜欢编译器来检查它们？

public IgnorableSerializerContractResolver Ignore<TModel>(Expression<Func<TModel, object>> selector)
{
    MemberExpression body = selector.Body as MemberExpression;

    if (body == null)
    {
        UnaryExpression ubody = (UnaryExpression)selector.Body;
        body = ubody.Operand as MemberExpression;

        if (body == null)
        {
            throw new ArgumentException("Could not get property name", "selector");
        }
    }

    string propertyName = body.Member.Name;
    this.Ignore(typeof (TModel), propertyName);
    return this;
}

现在，您可以轻松，流畅地忽略属性：

contract.Ignore<Node>(node => node.NextNode)
    .Ignore<Node>(node => node.AvailableNodes);

Answer 5

我不关心将属性名称设置为字符串，以防它们更改它会破坏我的其他代码。

我需要序列化的对象上有几个“视图模式”，所以我最终在合同解析器中执行了类似的操作（构造函数参数提供的视图模式）：

protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
{
    JsonProperty property = base.CreateProperty(member, memberSerialization);
    if (viewMode == ViewModeEnum.UnregisteredCustomer && member.GetCustomAttributes(typeof(UnregisteredCustomerAttribute), true).Length == 0)
    {
        property.ShouldSerialize = instance => { return false; };
    }

    return property;
}

我的对象看起来像这样：

public interface IStatement
{
    [UnregisteredCustomer]
    string PolicyNumber { get; set; }

    string PlanCode { get; set; }

    PlanStatus PlanStatus { get; set; }

    [UnregisteredCustomer]
    decimal TotalAmount { get; }

    [UnregisteredCustomer]
    ICollection<IBalance> Balances { get; }

    void SetBalances(IBalance[] balances);
}

这方面的缺点是解析器中的反射，但我认为有更多可维护的代码是值得的。

Answer 6

结合drzaus和Steve Rukuts的答案，我取得了不错的成绩。但是，当我为属性设置不同名称或大小写的JsonPropertyAttribute时，我遇到了问题。例如：

[JsonProperty("username")]
public string Username { get; set; }

考虑包含UnderlyingName可以解决问题：

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

    if (this.IsIgnored(property.DeclaringType, property.PropertyName)
        || this.IsIgnored(property.DeclaringType, property.UnderlyingName)
        || this.IsIgnored(property.DeclaringType.BaseType, property.PropertyName)
        || this.IsIgnored(property.DeclaringType.BaseType, property.UnderlyingName))
    {
        property.ShouldSerialize = instance => { return false; };
    }

    return property;
}

Answer 7

如果您愿意使用F＃（或只是使用未针对C＃优化的API），则FSharp.JsonSkippable库允许您以简单且类型明确的方式控制序列化时是否包括给定的属性（以及确定在反序列化时是否包含属性），此外，还可以控制/确定排除是否为null的可能性。（完全公开：我是图书馆的作者。）

通过自定义属性（json.net）从序列化中排除属性

7 个答案: