[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


New @cloudcovershow episode ! Using #Docker Machine with @Azure with @AhmetAlpBalkan https://t.co/IzEAxwzGPG

April 29, 2016 17:20

Deploying @ASPNET Core RC1 to #Azure #AppServices https://t.co/c6Khnv7vDa

April 29, 2016 13:17

Introducing #Azure Cool Blob Storage - https://t.co/AOiI0R6IMT

April 29, 2016 06:43

#DocumentDB now supports Time-To-Live (TTL) - https://t.co/8Ri1owpgMB

April 29, 2016 06:42

All you need to know to get started with @Docker containers on @WindowsServer 2016 TP5: https://t.co/GM7zzLg1sC https://t.co/3mE13F61A0

April 29, 2016 06:03

Getting started with #Containers and @Docker on #WindowsServer 2016 Technical Preview 5 https://t.co/NJK8iqirgM cc @Azure

April 28, 2016 21:47

Discover #HyperV Containers on @ch9 https://t.co/LbSooktGfn

April 28, 2016 06:03

#WindowsServer 2016 TP 5 is here ! With a lot of improvements & new features for containers and #Docker https://t.co/VS2UuSa7RG

April 28, 2016 05:42

Introducing #Windows Server and #HyperV #Containers https://t.co/X2xo0HGxXs

April 28, 2016 05:38

RT @MUGStrasbourg: Retrouvez les slides de notre session Back From #Build2016 sur SlideShare : https://t.co/aTzbaUhCNk

April 27, 2016 19:41

RT @benjiiim: Open Source History of .Net @ #XamarinEvolve by @migueldeicaza https://t.co/OwKpBsaIUJ

April 27, 2016 14:14

10 things to know about @Azure #DocumentDB Partitioned Collections https://t.co/20s6uhkeTy

April 27, 2016 09:37

#Azure #SQLDatabase now supports powerful geo-replication features for all service tiers https://t.co/UAYOaRe3Oc

April 27, 2016 08:21

Migrate your #ApplicationInsights mobile app to #HockeyApp today https://t.co/1uof6zh2wS

April 27, 2016 07:25

Create a @Docker #Swarm cluster using #Azure #ContainerService https://t.co/NEDVMTEls2

April 25, 2016 13:08