web-dev-qa-db-ja.com

MVC5プロジェクトでJSONモデルバインディングにJson.NETを使用する方法は?

私は答えや例のためにインターネットを見回してきましたが、まだ見つけられませんでした。 JSON.NETライブラリーへのモデルバインド中にJSONをデシリアライズするために使用されるデフォルトのJSONシリアライザーを単に変更したいと思います。

this SO postが見つかりましたが、今のところ実装できません。System.Net.Http.Formatters名前空間。GlobalConfigurationも表示されません。

私は何が欠けていますか?

更新

ASP.NET MVCプロジェクトがあり、基本的にはMVC3プロジェクトでした。現在、.NET 4.5をターゲットにし、ASP.NET MVC 5および関連するNuGetパッケージを使用しています。

System.Web.Http Assemblyも、同様の名前空間も表示されません。このコンテキストでは、JSONタイプのリクエストのデフォルトモデルバインダーとして使用されるJSON.NETを挿入します。

25
Zoltán Tamási

私はついに答えを見つけました。基本的に、MVC環境で使用するように設計されていないMediaTypeFormatterのものは必要ありませんが、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());

ここ は、私を正しい方向に向けたポストであり、 これも( -)バリュープロバイダーとモデルバインダーについて適切に説明しました。

28
Zoltán Tamási

私もこの問題を抱えていました。 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のモデルバインダーの汎用バージョンを実装したところ、非常にうまく機能します。おそらく、いくつかのダミーチェック(要求が実際にapplication/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で無視されなくなり、すべてが正しくバインドされました!

16
Jason Butera

私の場合、インターフェースや動的にロードされるタイプなどを含む複雑なオブジェクトをデシリアライズする必要があったため、カスタム値プロバイダーの提供は、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://stackoverflow.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();
1
Dejan