[ASPNET MVC] Utiliser le framework Json .NET de Newtonsoft à la place du JavaScriptSerializer dans vos JsonResult

March 05, 2013 -

ASP.NET MVC fait appel au JavaScriptSerializer lorsque l’on retourne un JsonResult, contrairement à ASP.NET Web API qui lui utilise nativement le Framework Json.NET de Newtonsoft. Cela peut entraîner des comportements assez étranges dans le cas d’intéropérabilité entre une application MVC et un service Web API.

Concrètement, le framework Json.NET est beaucoup plus riche que le JavaScriptSerializer pour la manipulation d’objets JSON, du coup, il est clairement recommandé de l’utiliser, même en ASP.NET MVC. Pour le récupérer, il suffit de télécharger le package NuGet Json.NET :

image

La première étape consiste à créer un ActionResult personnalisé qui utilise Json.NET dans la méthode ExecuteResult :

public class JsonNetResult : JsonResult
{
    public override void ExecuteResult(ControllerContext context)
    {
        if (context == null)
            throw new ArgumentNullException("context");

        var response = context.HttpContext.Response;

        response.ContentType = !String.IsNullOrEmpty(ContentType) ? ContentType : "application/json";

        if (ContentEncoding != null)
            response.ContentEncoding = ContentEncoding;

        if (Data == null)
            return;

        var serializedObject = JsonConvert.SerializeObject(Data, Formatting.Indented);
        response.Write(serializedObject);
    }
}

Ensuite, pour pouvoir faire en sorte que ce soit ce JsonNetResult là qui soit automatiquement renvoyé par la méthode Json de vos contrôleurs, il suffit de passer par un contrôleur intermédiaire dans lequel vous pouvez redéfinir les différentes surcharges de la méthode Json, et notamment :

protected override JsonResult Json(object data, string contentType, Encoding contentEncoding, JsonRequestBehavior behavior)
{
    var result = new JsonNetResult()
    {
        Data = data,
        ContentType = contentType,
        ContentEncoding = contentEncoding,
        JsonRequestBehavior = behavior
    };

    return result;
}

Désormais, tous les contrôleurs qui dérivent de votre contrôleur de base utiliseront automatiquement Json.NET pour sérialiser des objets en Json. Au passage, c’est toujours une bonne pratique de créer votre propre contrôleur au démarrage d’un projet (ou dans un Framework) pour pouvoir à tout moment influer sur le comportement de tous vos contrôleurs sans impacter votre code !

Enjoy Winking smile

Julien

Comments

Share

Tags


Twitter


#DevOps Lessons Learned at #Microsoft Engineering https://t.co/29nnVGOn4D

May 28, 2016 07:36

Hyper-V #Containers in #Windows 10 - https://t.co/ozT1MGQJkm

May 27, 2016 15:56

#DevOps: Continuous deployment/delivery with #Jenkins and @VisualStudio Team Services https://t.co/dtVnoHJ44W

May 27, 2016 15:55

Wow! #Microsoft and #Facebook to build subsea cable across Atlantic - https://t.co/EOpi4dCQoR

May 27, 2016 15:53

#Docker Containers as the new Binaries of deployment - https://t.co/jjYx4SsbLj

May 26, 2016 16:59

Turning on #Windows features using #Powershell DSC extension and #Azure CLI - https://t.co/kxpnBMVXJj

May 26, 2016 16:57

RT @meulta: Full packed lab about #DevOps and @VorlonJS in DevOps intensive track #msdevcon Russia :) cc @jcorioland https://t.co/tH6W4DBaPE

May 26, 2016 14:06

RT @a_bogdanova: Ключевой доклад офисного трека на #msdevcon уже начался! https://t.co/TV4iebh3LX

May 26, 2016 07:36

The future of mobile app development: learn, build, integrate, test, iterate. https://t.co/Puy8hcZGBe #DevOps #Xamarin #Azure #VisualStudio

May 26, 2016 07:33

#Docker All The Things at #OSCON! https://t.co/LrblXcNO6r

May 26, 2016 07:22

Creating Better User Experiences with #Microsoft #CognitiveServices https://t.co/Uf2hVkvX4Y

May 26, 2016 07:18

Announcing #WCF Connected Service for .NET Core RC2 and https://t.co/7Z4RnrQUHN Core RC2 https://t.co/psjl3rKI2I #dotnet #dotnetcore

May 26, 2016 07:10

Announcing general availability of @Azure #DevTest Labs https://t.co/V1gOTKmmCW

May 26, 2016 05:36

#DevOps mobile demonstration using #Xamarin Test Cloud and @VisualStudio Team Services! #msdevcon https://t.co/unWRCWfitR

May 25, 2016 07:56