Question

我正在尝试创建一个条件ContractResolver，以便我可以根据Web请求/控制器操作以不同方式控制序列化。

例如在我的用户控制器中，我想序列化我的用户的所有属性，但是我可能只序列化基本类型的一些相关对象。但是，如果我去公司控制器，我想序列化公司的所有属性，但可能只是用户的原始属性（因此我不想使用数据注释或应该序列化函数。

所以看一下我创建自己的自定义ContractResolver页面。 http://james.newtonking.com/projects/json/help/index.html?topic=html/ContractResolver.htm

看起来像这样

public class IgnoreListContractResolver : DefaultContractResolver
{
    private readonly Dictionary<string, List<string>> IgnoreList;

    public IgnoreListContractResolver(Dictionary<string, List<string>> i)
    {
        IgnoreList = i;
    }

    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        List<JsonProperty> properties = base.CreateProperties(type, memberSerialization).ToList();

        if(IgnoreList.ContainsKey(type.Name))
        {
            properties.RemoveAll(x => IgnoreList[type.Name].Contains(x.PropertyName));                
        }
        return properties;
    }
}

然后在GetUsers的web api控制器操作中，我这样做

public dynamic GetUsers()
{
    List<User> Users = db.Users.ToList();
    List<string> RoleList = new List<string>();
    RoleList.Add("UsersInRole");
    List<string> CompanyList = new List<string>();
    CompanyList.Add("CompanyAccesses");
    CompanyList.Add("ArchivedMemberships");
    CompanyList.Add("AddCodes");

    Dictionary<string, List<string>> IgnoreList = new Dictionary<string, List<string>>();
    IgnoreList.Add("Role", RoleList);
    IgnoreList.Add("Company", CompanyList);
    GlobalConfiguration
            .Configuration
            .Formatters.JsonFormatter
            .SerializerSettings
            .ContractResolver = new IgnoreListContractResolver(IgnoreList);

    return new { List = Users, Status = "Success" };
}

因此，在调试时，我看到我的合约解析器运行并返回正确的属性，但返回浏览器的Json仍然包含我从列表中删除的属性的条目。

任何想法我缺少什么或如何进入webapi控制器中的Json序列化步骤。

*的更新 ** 我应该补充一点，这是一个MVC4项目，它同时具有MVC控制器和webapi控制器。 User，Company和Role对象是从EF5加载的对象（首先由代码创建）。有问题的控制器是一个web api控制器。不知道为什么这很重要，但我在一个干净的WebApi项目（没有EF5）而不是MVC项目中尝试了这个，并且它按预期工作。这有助于确定问题的所在位置吗？

由于

*更新2 * * 在同一个MVC4项目中，我为Object类创建了一个名为ToJson的扩展方法。它使用Newtonsoft.Json.JsonSerializer来序列化我的实体。这很简单。

public static string ToJson(this object o, Dictionary<string, List<string>> IgnoreList)
{
    JsonSerializer js = JsonSerializer.Create(new Newtonsoft.Json.JsonSerializerSettings()
    {
        Formatting = Formatting.Indented,
        DateTimeZoneHandling = DateTimeZoneHandling.Utc,
        ContractResolver = new IgnoreListContractResolver(IgnoreList),
        ReferenceLoopHandling = ReferenceLoopHandling.Ignore  
    });

    js.Converters.Add(new Newtonsoft.Json.Converters.StringEnumConverter());

    var jw = new StringWriter();
    js.Serialize(jw, o);
    return jw.ToString();

}

然后在MVC动作中我创建一个像这样的json字符串。

model.jsonUserList = db.Users.ToList().ToJson(IgnoreList);

创建忽略列表的方式与我以前的帖子完全相同。我再次看到合同解析器运行并正确限制属性列表，但输出json字符串仍然包含所有内容（包括我从列表中删除的属性）。这有帮助吗？我必须做错事，现在好像它不是MVC或web api框架。这可能与EF交互/代理/等有关。任何想法将不胜感激。

由于

* 更新3 ***

消除过程和更彻底的调试使我意识到EF 5动态代理正在弄乱我的序列化和ContractResolver检查类型名称匹配。所以这是我更新的IgnoreListContractResolver。 此时我只是在寻找更好的方法或者我正在做一些可怕的事情的意见。我知道这是为了直接使用我的EF对象而不是DTO而跳过很多箍但是在结束我发现这个解决方案非常灵活。

public class IgnoreListContractResolver : CamelCasePropertyNamesContractResolver
{
    private readonly Dictionary<string, List<string>> IgnoreList;

    public IgnoreListContractResolver(Dictionary<string, List<string>> i)
    {
        IgnoreList = i;
    }

    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        List<JsonProperty> properties = base.CreateProperties(type, memberSerialization).ToList();

        string typename = type.Name;
        if(type.FullName.Contains("System.Data.Entity.DynamicProxies.")) {
            typename = type.FullName.Replace("System.Data.Entity.DynamicProxies.", "");
            typename = typename.Remove(typename.IndexOf('_'));
        }

        if (IgnoreList.ContainsKey(typename))
        {
            //remove anything in the ignore list and ignore case because we are using camel case for json
            properties.RemoveAll(x => IgnoreList[typename].Contains(x.PropertyName, StringComparer.CurrentCultureIgnoreCase));
        }
        return properties;
    }
}

Answer 1

我认为如果您使用Type而不是string作为忽略列表的密钥类型可能会有所帮助。因此，您可以避免命名问题（在不同的命名空间中具有相同名称的多个类型），并且您可以使用继承。我不熟悉EF5和代理，但我想代理类派生自你的实体类。因此，您可以检查Type.IsAssignableFrom()，而不只是检查typename是否是忽略列表中的键。

private readonly Dictionary<Type, List<string>> IgnoreList;

protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
{
    List<JsonProperty> properties = base.CreateProperties(type, memberSerialization).ToList();

    // look for the first dictionary entry whose key is a superclass of "type"
    Type key = IgnoreList.Keys.FirstOrDefault(k => k.IsAssignableFrom(type));

    if (key != null)
    {
        //remove anything in the ignore list and ignore case because we are using camel case for json
        properties.RemoveAll(x => IgnoreList[key].Contains(x.PropertyName, StringComparer.CurrentCultureIgnoreCase));
    }
    return properties;
}

然后必须像这样创建忽略列表（我还使用了短语法来创建列表和字典）：

var CompanyList = new List<string> {
    "CompanyAccesses",
    "ArchivedMemberships",
    "AddCodes"
};

var IgnoreList = new Dictionary<Type, List<string>> {
    // I just replaced "Company" with typeof(Company) here:
    { typeof(Company), CompanyList }
};

请注意，如果您使用上面的代码，添加typeof(object)作为忽略列表的第一个键将导致此条目每时间匹配，而不是您的其他任何时间条目将被使用！发生这种情况是因为object类型的变量可以从每个其他类型分配。

使用MVC 4.0 Web Api的NewtonSoft json Contract Resolver不按预期生成输出

1 个答案: