DefaultModelBinder 无法反序列化作为 JSON 对象传递给操作的 .NET Dictionary 对象？

Question

我有一个非常简单的类：

public class FilterItem
{
    public Dictionary<string, string> ItemsDictionary { get; set; }

    public FilterItem()
    {
        ItemsDictionary = new Dictionary<string, string>();
    }
}

我想填充客户端字典中的数据，然后将其作为 JSON 对象传递给我的控制器操作。但是，无论我在客户端上尝试什么，DefaultModelBinder 似乎都无法反序列化它。

下面是一个调用我的操作的 javascript 代码示例：

var simpleDictionary = {"ItemsDictionary": {"1": "5", "2": "7"}};

$.ajax({ cache: false, type: "POST", data: JSON.stringify(simpleDictionary),
contentType: "application/json; charset=utf-8", 
url: "/Catalog7Spikes/GetFilteredProductsJson", success: function (data) {...});

这是我的操作方法的简化版本：

[HttpPost]
public ActionResult GetFilteredProductsJson(FilterItem filterItem)
{   
    ProductsModel productsModel = new ProductsModel();
    return View("SevenSpikes.Nop.UI.Views.Products", productsModel);
}

请注意，相反的工作方式。当作为 JsonResult 传递时，FilterItem 对象已成功序列化并作为 JSON 对象传递到客户端。然而试图反其道而行之是行不通的。

我读了 Connect 上的票证 并认为解决方法可行，但事实并非如此。

是否可以使用 ASP.NET MVC 3 中的 DefaultModelBinder 反序列化 .NET 字典？

Answer 1

汉塞尔曼谈到了这一点：

来源：
http://www.hanselman.com/blog/ASPNETWireFormatForModelBindingToArraysListsCollectionsDictionaries.aspx

DefaultModelBinder 需要一些不太理想的语法字典。尝试使用这种语法：

 {
 "dictionary[0]":{"Key":"a", "Value":"b"},
 "dictionary[1]":{"Key":"b", "Value":"b"}
 }

它有点庞大，但它具有绑定性。以下也可以，但我个人更喜欢上面的；它更短。

 {
 "dictionary[0].Key":"a",
 "dictionary[0].Value":"b",
 "dictionary[1].Key":"b"
 "dictionary[1].Value":"b"
 }

Answer 2

更新

根据 Jeroen 的博客文章（请参阅下面他的答案，以及链接），以及重新审查代码后我的大脑闪现，我更新了 ExtendedJsonValueProviderFactory 这样它将始终为通过 JSON 提交的顶级字典正确创建 BackingStore。

该代码可在 GitHub 上找到： https://github.com/counsellorben/ASP.NET- MVC-JsonDictionaryBinding，工作示例位于 http://oss.form.vu/json-dictionary-example/。

---

通过删除当前的 JsonValueProviderFactory 并替换为可以处理字典创建的 JsonValueProviderFactory，您可以绑定字典。首先，正如 Keith 指出的那样，在 Javascript 中，请务必将字典包装在“filterItem”内，因为这是控制器操作中模型变量的名称，对于 JSON，这是控制器操作中变量的名称必须与返回的 Json 元素的名称匹配。此外，在传递类时，任何嵌套元素都必须与类中的属性名称匹配。

接下来，创建一个 ExtendedJsonValueProviderFactory 类，如下所示：

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Globalization;
using System.IO;
using System.Web.Script.Serialization;

public sealed class ExtendedJsonValueProviderFactory : ValueProviderFactory
{

    private void AddToBackingStore(Dictionary<string, object> backingStore, string prefix, object value)
    {
        IDictionary<string, object> d = value as IDictionary<string, object>;
        if (d != null)
        {
            foreach (KeyValuePair<string, object> entry in d)
            {
                if (entry.Key.EndsWith("Dictionary", StringComparison.CurrentCulture))
                    CreateDictionary(backingStore, entry);
                else
                    AddToBackingStore(backingStore, MakePropertyKey(prefix, entry.Key), entry.Value);
            }
            return;
        }

        IList l = value as IList;
        if (l != null)
        {
            for (int i = 0; i < l.Count; i++)
            {
                AddToBackingStore(backingStore, MakeArrayKey(prefix, i), l[i]);
            }
            return;
        }

        // primitive
        backingStore[prefix] = value;
    }

    private void CreateDictionary(Dictionary<string, object> backingStore, KeyValuePair<string, object> source)
    {
        var d = source.Value as IDictionary<string, object>;
        var dictionary = new Dictionary<string, string>();
        foreach (KeyValuePair<string, object> entry in d)
            dictionary.Add(entry.Key, entry.Value.ToString());

        AddToBackingStore(backingStore, source.Key, dictionary);
        return;
    }

    private static object GetDeserializedObject(ControllerContext controllerContext)
    {
        if (!controllerContext.HttpContext.Request.ContentType.StartsWith("application/json", StringComparison.OrdinalIgnoreCase))
        {
            // not JSON request
            return null;
        }

        StreamReader reader = new StreamReader(controllerContext.HttpContext.Request.InputStream);
        string bodyText = reader.ReadToEnd();
        if (String.IsNullOrEmpty(bodyText))
        {
            // no JSON data
            return null;
        }

        JavaScriptSerializer serializer = new JavaScriptSerializer();
        object jsonData = serializer.DeserializeObject(bodyText);
        return jsonData;
    }

    public override IValueProvider GetValueProvider(ControllerContext controllerContext)
    {
        if (controllerContext == null)
        {
            throw new ArgumentNullException("controllerContext");
        }

        object jsonData = GetDeserializedObject(controllerContext);
        if (jsonData == null)
        {
            return null;
        }

        Dictionary<string, object> backingStore = new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);
        AddToBackingStore(backingStore, String.Empty, jsonData);

        return new DictionaryValueProvider<object>(backingStore, CultureInfo.CurrentCulture);
    }

    private static string MakeArrayKey(string prefix, int index)
    {
        return prefix + "[" + index.ToString(CultureInfo.InvariantCulture) + "]";
    }

    private static string MakePropertyKey(string prefix, string propertyName)
    {
        return (String.IsNullOrEmpty(prefix)) ? propertyName : prefix + "." + propertyName;
    }
}

您可能会注意到，该类几乎与标准 JsonValueProviderFactory 类相同，除了用于构建 Dictionary< 类型的 DictionaryValueProvider 条目的扩展之外。字符串，字符串>。您还应该注意到，为了作为字典进行处理，元素必须具有以“Dictionary”结尾的名称（虽然我认为这是一个明显的代码味道，但我想不出另一个此时的替代方案......我愿意接受建议）。

接下来，将以下内容添加到 Global.asax.cs 中的 Application_Start 中：

var j = ValueProviderFactories.Factories.FirstOrDefault(f => f.GetType().Equals(typeof(JsonValueProviderFactory)));
if (j != null)
    ValueProviderFactories.Factories.Remove(j);
ValueProviderFactories.Factories.Add(new ExtendedJsonValueProviderFactory());

这将删除标准 JsonValueProviderFactory，并将其替换为我们的扩展类。

最后一步：享受美好。

Answer 3

您尝试过以下方法吗？

var simpleDictionary = {"ItemsDictionary": {"1": "5", "2": "7"}};

$.ajax({ cache: false, type: "POST", data: {filterItem : JSON.stringify(simpleDictionary)},
contentType: "application/json; charset=utf-8", 
url: "/Catalog7Spikes/GetFilteredProductsJson", success: function (data) {...});

Answer 4

昨天，我在尝试将 JavaScript (JSON) 字典发布到控制器操作方法时遇到了完全相同的问题。我创建了一个自定义模型绑定器，它可以直接（在操作方法参数中）或包含在模型类中处理具有不同类型参数的通用字典。我只在 MVC 3 中测试过它。

有关我的经验和自定义模型绑定器的源代码的详细信息，请参阅我的博客文章 http://buildingwebapps.blogspot.com/2012/01/passing-javascript-json-dictionary-to.html

Answer 5

默认模型绑定程序无法处理列表。
我在我的开源项目中解决了这个问题： http://jsaction.codeplex.com 并写了一篇关于此问题的文章问题：请阅读此处
http://jsaction.codeplex.com/wikipage?title=AllFeatures&referringTitle=文档

...Asp.net MVC 具有将发送的数据转换为强类型对象的内置功能。但是我们发送的数据必须以正确的方式准备，以便默认数据绑定器可以填充控制器操作参数对象的属性。
问题是向 jQuery.ajax() 函数调用提供 JSON 对象不起作用。完全没有。数据不会在服务器上绑定数据，因此控制器操作参数具有可能无效的默认值。
问题是 JSON 对象被 jQuery 转换为请求查询字符串，并且二级属性值被破坏成 Asp.net MVC 默认模型绑定器无法理解的形式...