EF 实体+ Newtonsoft.Json 输出JSON 时动态忽略属性的解决方法

最新推荐文章于 2024-02-20 11:14:49 发布

adam0413

最新推荐文章于 2024-02-20 11:14:49 发布

阅读量434

点赞数

CC 4.0 BY-SA版权

文章标签： json 测试前端 ViewUI

原文链接：http://www.cnblogs.com/leonsky/p/3300511.html

本文介绍了一种在ASP.NET MVC项目中使用Newtonsoft.Json时，动态控制实体属性序列化的方法。通过重写DefaultContractResolver并实现ExcludePropertiesContractResolver类，可以灵活地决定哪些属性应该被序列化。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

最近的项目采用的是 ASP.NET mvc 4.0 + entity framework 5.0 ,后台以JSON形式抛出数据是借助于Newtonsoft.Json ，

要想忽略的属性前面添加特性[JsonIgnore]即可，但有时候会根据业务需求在不同的地方抛出不同的属性，所以添加特性的方式显示不能满足要求

所以就在设想Newtonsoft.Json 能否动态控制属性是否序列化成JSON，就这问题也找了一些资料，现就解决方法做备忘，希望各位有更好的方法告知。

解决方法：

重写Newtonsoft.Json 的分解器

步骤

1.新建类继承Newtonsoft.Json的类 DefaultContractResolver，重写CreateProperties方法，代码如下：

    public class ExcludePropertiesContractResolver : DefaultContractResolver
    {
        IEnumerable<string> lstExclude;
        public ExcludePropertiesContractResolver(IEnumerable<string> excludedProperties)
        {
            lstExclude = excludedProperties;
        }
        protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
        {
            return base.CreateProperties(type, memberSerialization).ToList().FindAll(p => !lstExclude.Contains(p.PropertyName));
        }
    }

　　这里也可以变通写成。只创建传入的属性，上面代码是排除传入的属性，是只创建指定属性，还是只创建指定属性之外其它的属性，就看大家需求和爱好了

2.使用方法：假设我们需要转化为JSON的EF实体列表是taskList，这个列表中的EF实体包含了延迟加载属性，刚好这些延迟加载属性不需要转成JSON到前端，如下代码：

            string jsonString = JsonConvert.SerializeObject(taskList, Formatting.Indented, new JsonSerializerSettings
            {
                ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
                ContractResolver = new ExcludePropertiesContractResolver(new List<string> { "ApplyUser", "StartUser", "CompleteUser", "AuthoriseUser", "Tests" })
            });

　　上面代码排除了申请人 ApplyUser，开始人StartUser，完成人CompleteUser，审核人AuthoriseUser，测试集 Tests 这些属性的序列化。

转载于:https://www.cnblogs.com/leonsky/p/3300511.html