如何在 MVC 5 项目中使用 Json.NET 进行 JSON 模型绑定？

Posted 2023-03-27

【中文标题】如何在 MVC 5 项目中使用 Json.NET 进行 JSON 模型绑定？

【英文标题】：How to use Json.NET for JSON modelbinding in an MVC5 project?

【发布时间】：2014-07-22 14:39:39

【问题描述】：

我一直在互联网上寻找答案或示例，但还没有找到。我只是想更改默认的 JSON 序列化程序，该序列化程序用于在模型绑定到 JSON.NET 库时反序列化 JSON。

我找到了this SO 帖子，但目前无法实现，我什至看不到System.Net.Http.Formatters 命名空间，也看不到GlobalConfiguration。

我错过了什么？

更新

我有一个 ASP.NET MVC 项目，它基本上是一个 MVC3 项目。目前我的目标是 .NET 4.5 并使用 ASP.NET MVC 5 和相关的 NuGet 包。

我没有看到 System.Web.Http 程序集，也没有任何类似的命名空间。在这种情况下，我想注入 JSON.NET 作为 JSON 类型请求的默认模型绑定器。

【问题讨论】：

全局配置 -> msdn.microsoft.com/en-us/library/…

是的，我已经看到了，但我无法添加对 System.Web.Http 的引用，因为它不在引用列表中。在我的问题中添加了更多信息。

【参考方案1】：

我终于找到了答案。基本上我不需要 MediaTypeFormatter 的东西，它不是为在 MVC 环境中使用而设计的，而是在 ASP.NET Web API 中，这就是为什么我看不到那些引用和命名空间（顺便说一下，这些都包含在Microsoft.AspNet.WeApi NuGet 包）。

解决方案是使用自定义值提供者工厂。这是所需的代码。

    public class JsonNetValueProviderFactory : ValueProviderFactory
    
        public override IValueProvider GetValueProvider(ControllerContext controllerContext)
        
            // first make sure we have a valid context
            if (controllerContext == null)
                throw new ArgumentNullException("controllerContext");

            // now make sure we are dealing with a json request
            if (!controllerContext.HttpContext.Request.ContentType.StartsWith("application/json", StringComparison.OrdinalIgnoreCase))
                return null;

            // get a generic stream reader (get reader for the http stream)
            var streamReader = new StreamReader(controllerContext.HttpContext.Request.InputStream);
            // convert stream reader to a JSON Text Reader
            var JSONReader = new JsonTextReader(streamReader);
            // tell JSON to read
            if (!JSONReader.Read())
                return null;

            // make a new Json serializer
            var JSONSerializer = new JsonSerializer();
            // add the dyamic object converter to our serializer
            JSONSerializer.Converters.Add(new ExpandoObjectConverter());

            // use JSON.NET to deserialize object to a dynamic (expando) object
            Object JSONObject;
            // if we start with a "[", treat this as an array
            if (JSONReader.TokenType == JsonToken.StartArray)
                JSONObject = JSONSerializer.Deserialize<List<ExpandoObject>>(JSONReader);
            else
                JSONObject = JSONSerializer.Deserialize<ExpandoObject>(JSONReader);

            // create a backing store to hold all properties for this deserialization
            var backingStore = new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);
            // add all properties to this backing store
            AddToBackingStore(backingStore, String.Empty, JSONObject);
            // return the object in a dictionary value provider so the MVC understands it
            return new DictionaryValueProvider<object>(backingStore, CultureInfo.CurrentCulture);
        

        private static void AddToBackingStore(Dictionary<string, object> backingStore, string prefix, object value)
        
            var d = value as IDictionary<string, object>;
            if (d != null)
            
                foreach (var entry in d)
                
                    AddToBackingStore(backingStore, MakePropertyKey(prefix, entry.Key), entry.Value);
                
                return;
            

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

            // primitive
            backingStore[prefix] = value;
        

        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;
        
    

您可以在 Application_Start 方法中像这样使用它：

// remove default implementation    
ValueProviderFactories.Factories.Remove(ValueProviderFactories.Factories.OfType<JsonValueProviderFactory>().FirstOrDefault());
// add our custom one
ValueProviderFactories.Factories.Add(new JsonNetValueProviderFactory());

Here 是为我指明了正确方向的帖子，also this one 对价值提供者和模型绑定器进行了很好的解释。

【讨论】：

从***.com/questions/14591750/…也提到了here

我使用了这个代码的一个稍微修改过的版本，在一个带有单个字符串输入的操作上，比如public ResultObject DoThis(string input)，JSONReader.Read 行会死掉，但会出现“不合适的字符，文本不是”这样的异常t JSON”。有什么想法吗？

@drzaus 回答我的问题，似乎表单数据编码请求，而不是原始 JSON（通过POSTMAN）会触发我的问题，因为它试图反序列化本质上是乱码

使用它似乎破坏了通过整数值传递enum 值的能力（例如someEnum:2）。使用 here 中的 EnumModelBinder 类再次修复它。

【参考方案2】：

我也有这样的问题。我将 JSON 发布到一个操作中，但我的 JsonProperty 名称被忽略了。因此，我的模型属性始终为空。

public class MyModel

    [JsonProperty(PropertyName = "prop1")]
    public int Property1  get; set; 

    [JsonProperty(PropertyName = "prop2")]
    public int Property2  get; set; 

    [JsonProperty(PropertyName = "prop3")]
    public int Property3  get; set; 

    public int Foo  get; set; 

我正在使用此自定义 jquery 函数发布到操作：

(function ($) 
    $.postJSON = function (url, data, dataType) 

        var o = 
            url: url,
            type: 'POST',
            contentType: 'application/json; charset=utf-8'
        ;

        if (data !== undefined)
            o.data = JSON.stringify(data);

        if (dataType !== undefined)
            o.dataType = dataType;

        return $.ajax(o);
    ;
(jQuery));

我这样称呼它：

data = 
    prop1: 1,
    prop2: 2,
    prop3: 3,
    foo: 3,
;

$.postJSON('/Controller/MyAction', data, 'json')
            .success(function (response) 
                ...do whatever with the JSON I got back
            );

不幸的是，只有 foo 被绑定（奇怪，因为大小写不一样，但我猜默认的 modelbinder 不区分大小写）

[HttpPost]
public JsonNetResult MyAction(MyModel model)

    ...

解决方案最终变得相当简单

我刚刚实现了一个通用版本的 Dejan 模型绑定器，它非常适合我。它可能会使用一些虚拟检查（例如确保请求实际上是应用程序/json），但它现在正在发挥作用。

internal class JsonNetModelBinder : IModelBinder

    public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
    
        controllerContext.HttpContext.Request.InputStream.Position = 0;
        var stream = controllerContext.RequestContext.HttpContext.Request.InputStream;
        var readStream = new StreamReader(stream, Encoding.UTF8);
        var json = readStream.ReadToEnd();
        return JsonConvert.DeserializeObject(json, bindingContext.ModelType);
    

当我想在特定操作上使用它时，我只需告诉它我想使用我的自定义 Json.Net 模型绑定器：

[HttpPost]
public JsonNetResult MyAction([ModelBinder(typeof(JsonNetModelBinder))] MyModel model)

    ...

现在我的 [JsonProperty(PropertyName = "")] 属性在 MyModel 上不再被忽略，并且所有内容都已正确绑定！

【讨论】：

github.com/hotjk/dot-rbac/blob/master/Grit.Utility.Web/Json/… 提供了带有虚拟检查的版本

【参考方案3】：

在我的例子中，我必须反序列化复杂的对象，包括接口和动态加载的类型等，因此提供自定义值提供程序不起作用，因为 MVC 仍然需要尝试找出如何实例化接口然后失败。

由于我的对象已经正确注释以与 Json.NET 一起使用，我采取了不同的方法：我实现了一个自定义模型绑定器并使用 Json.NET 显式反序列化请求正文数据，如下所示：

internal class CustomModelBinder : IModelBinder

    public object BindModel(ControllerContext controllerContext, ModelBindingContext bindingContext)
    
        // use Json.NET to deserialize the incoming Position
        controllerContext.HttpContext.Request.InputStream.Position = 0; // see: http://***.com/a/3468653/331281
        Stream stream = controllerContext.RequestContext.HttpContext.Request.InputStream;
        var readStream = new StreamReader(stream, Encoding.UTF8);
        string json = readStream.ReadToEnd();
        return JsonConvert.DeserializeObject<MyClass>(json, ...);
    

自定义模型绑定器注册在Global.asax.cs：

  ModelBinders.Binders.Add(typeof(MyClass), new CustomModelBinder();

【讨论】：

您可以通过添加泛型类型约束来使其更可重用。自定义模型绑定器。然后“返回 JsonConvert.DeserializeObject(json)”。用法：“ModelBinders.Binders.Add(typeof(MyClass), new CustomModelBinder();”