首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >Json.NET按深度和属性序列化

Json.NET按深度和属性序列化
EN

Stack Overflow用户
提问于 2016-03-22 16:04:21
回答 2查看 6.7K关注 0票数 4

例如,我们有两个类

代码语言:javascript
复制
class FooA
{
    [SomeSpecialAttribute]
    public int SomeValueA { get; set; }

    public int SomeValueB { get; set; }

    public int SomeValueC { get; set; }
}

class FooB
{
    public FooA FooA { get; set; }
}

我使用Json.NET,最大深度为1。在序列化FooA时,它应该像往常一样输出所有属性,但是在序列化FooB时,它应该只输出一个具有特殊属性的FooA属性。因此,只有在解析嵌套引用属性(深度> 0)时,我们才应该得到一个字段。

输出应为:{ "FooA":{ "SomeValueA":"0“}

有什么想法吗?

EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2016-03-22 22:53:39

这里的基本困难是,Json.NET是一个基于合同的序列化程序,它为要序列化的每个类型创建一个契约,然后根据合同进行序列化。无论对象图中的类型出现在何处,都适用相同的约定。但是,您希望根据对象图的深度有选择地包含给定类型的属性,这与基本的“一种类型一契约”设计相冲突,因此需要做一些工作。

完成所需任务的一种方法是创建一个JsonConverter,为每个对象执行默认序列化,然后按照在返回给客户端之前修改JSON的通用方法的方式修剪不想要的属性。请注意,这与递归结构(如树)有问题,因为转换器必须为子节点禁用自身,以避免无限递归。

另一种可能是创建一个IContractResolver,根据序列化深度为每种类型返回不同的契约。这必须使用序列化回调来跟踪对象序列化何时开始和结束,因为契约解析器不知道序列化深度:

代码语言:javascript
复制
[System.AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = true, Inherited = true)]
public class JsonIncludeAtDepthAttribute : System.Attribute
{
    public JsonIncludeAtDepthAttribute()
    {
    }
}

public class DepthPruningContractResolver : IContractResolver
{
    readonly int depth;

    public DepthPruningContractResolver()
        : this(0)
    {
    }

    public DepthPruningContractResolver(int depth)
    {
        if (depth < 0)
            throw new ArgumentOutOfRangeException("depth");
        this.depth = depth;
    }

    [ThreadStatic]
    static DepthTracker currentTracker;

    static DepthTracker CurrentTracker { get { return currentTracker; } set { currentTracker = value; } }

    class DepthTracker : IDisposable
    {
        int isDisposed;
        DepthTracker oldTracker;

        public DepthTracker()
        {
            isDisposed = 0;
            oldTracker = CurrentTracker;
            currentTracker = this;
        }

        #region IDisposable Members

        public void Dispose()
        {
            if (0 == Interlocked.Exchange(ref isDisposed, 1))
            {
                CurrentTracker = oldTracker;
                oldTracker = null;
            }
        }
        #endregion

        public int Depth { get; set; }
    }

    abstract class DepthTrackingContractResolver : DefaultContractResolver
    {
        static DepthTrackingContractResolver() { } // Mark type with beforefieldinit.

        static SerializationCallback OnSerializing = (o, context) =>
        {
            if (CurrentTracker != null)
                CurrentTracker.Depth++;
        };

        static SerializationCallback OnSerialized = (o, context) =>
        {
            if (CurrentTracker != null)
                CurrentTracker.Depth--;
        };

        protected override JsonObjectContract CreateObjectContract(Type objectType)
        {
            var contract = base.CreateObjectContract(objectType);
            contract.OnSerializingCallbacks.Add(OnSerializing);
            contract.OnSerializedCallbacks.Add(OnSerialized);
            return contract;
        }
    }

    sealed class RootContractResolver : DepthTrackingContractResolver
    {
        // As of 7.0.1, Json.NET suggests using a static instance for "stateless" contract resolvers, for performance reasons.
        // http://www.newtonsoft.com/json/help/html/ContractResolver.htm
        // http://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_Serialization_DefaultContractResolver__ctor_1.htm
        // "Use the parameterless constructor and cache instances of the contract resolver within your application for optimal performance."
        static RootContractResolver instance;
        static RootContractResolver() { instance = new RootContractResolver(); }
        public static RootContractResolver Instance { get { return instance; } }
    }

    sealed class NestedContractResolver : DepthTrackingContractResolver
    {
        static NestedContractResolver instance;
        static NestedContractResolver() { instance = new NestedContractResolver(); }
        public static NestedContractResolver Instance { get { return instance; } }

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

            if (property.AttributeProvider.GetAttributes(typeof(JsonIncludeAtDepthAttribute), true).Count == 0)
            {
                property.Ignored = true;
            }

            return property;
        }
    }

    public static IDisposable CreateTracker()
    {
        return new DepthTracker();
    }

    #region IContractResolver Members

    public JsonContract ResolveContract(Type type)
    {
        if (CurrentTracker != null && CurrentTracker.Depth > depth)
            return NestedContractResolver.Instance.ResolveContract(type);
        else
            return RootContractResolver.Instance.ResolveContract(type);
    }

    #endregion
}

然后将您的课程标记为:

代码语言:javascript
复制
class FooA
{
    [JsonIncludeAtDepthAttribute]
    public int SomeValueA { get; set; }

    public int SomeValueB { get; set; }

    public int SomeValueC { get; set; }
}

class FooB
{
    public FooA FooA { get; set; }
}

并按以下方式序列化:

代码语言:javascript
复制
var settings = new JsonSerializerSettings { ContractResolver = new DepthPruningContractResolver(depth), Formatting = Formatting.Indented };

using (DepthPruningContractResolver.CreateTracker())
{
    var jsonB = JsonConvert.SerializeObject(foob, settings);
    Console.WriteLine(jsonB);

    var jsonA = JsonConvert.SerializeObject(foob.FooA, settings);
    Console.WriteLine(jsonA);
}

需要稍微尴尬的CreateTracker(),以确保在序列化过程中抛出异常时,重置当前对象深度,并且不会影响对JsonConvert.SerializeObject()的未来调用。

票数 6
EN

Stack Overflow用户

发布于 2016-03-22 16:23:13

此解决方案假定您不希望更改FooA类的所有序列化。如果是这样的话,您应该创建自己的JsonConverter。

代码语言:javascript
复制
public class FooConverter : JsonConverter
{      
   public FooConveter(params Type[] parameterTypes)
   {

   }

   public override bool CanConvert(Type objectType)
   {
      return objectType.IsAssignableFrom(typeof(FooA));
   }

   public override object ReadJson(JsonReader reader, Type objectType)
   {
      //Put your code to deserialize FooA here.  
      //You probably don't need it based on the scope of your question.
   }

   public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
   {
      //Code to serialize FooA.
      if (value == null)
      {
         writer.WriteNull();
         return;
      }

      //Only serialize SomeValueA
      var foo = value as FooA;
      writer.WriteStartObject();
      writer.WritePropertyName("FooA");
      writer.Serialize(writer, foo.SomeValueA);
      writer.WriteEndObject();          
   }
}

并在代码中使用转换器作为

代码语言:javascript
复制
class FooB
{
   [FooConverter]
   public FooA FooA { get; set; }
}

否则,可以使用JsonIgnore属性忽略不希望序列化的FooA中的字段。请记住,当您将FooA转换为Json时,它总是忽略标记有该属性的字段。

票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/36159424

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档