[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


.@Docker Built-in Orchestration Ready for Production: Docker 1.12 Goes GA https://t.co/m6iC5zo1Kf

July 29, 2016 02:34

Announcing @Azure #LogicApps general availability! https://t.co/QK63wHKBVB

July 28, 2016 01:59

Application Insights: Work item integration with #GitHub - https://t.co/BnurFYkbv0 #Azure

July 27, 2016 15:46

Cloud is also about #PaaS! >> #IaaS isn’t your only path to outsized gains https://t.co/8eWqYSICTN #Microsoft #Azure

July 25, 2016 16:46

Deploying a #NixOS VM on #Microsoft #Azure https://t.co/aGfkthAuL4

July 23, 2016 13:59

#Containers: Multiple Orchestrators, Multiple Clouds, What a Mess https://t.co/BGBPrgVZJf #DockerSwarm #Mesos #Kubernetes

July 22, 2016 15:21

Wow! Stack overflow documentation, I like the idea! 👍 https://t.co/X88jceIyKJ

July 21, 2016 20:26

#ASPNET Core and .NET Core Overview - https://t.co/G6hqX3xUPT #dotnet #dotnetcore

July 21, 2016 07:08

Just blogged: how to use #Azure CLI to work with @Azure #ContainerService https://t.co/F8u5IrEhaE https://t.co/TVxrK0HXro

July 21, 2016 06:36

Comment déployer @Docker #Datacenter sur la plateforme Cloud #Microsoft @Azure https://t.co/77zZhsLDQ8

July 20, 2016 09:25

Announcing #AzureStorage #Nodejs GA - https://t.co/NtP26OHtrj

July 20, 2016 08:06

Microsoft is member of the Open #Container Initiative, here's why: https://t.co/VVTipHFSVU

July 20, 2016 06:41

Super meetup @DockerParis! Merci à l'orga/sponsors + @laurentgrangeau & @guillaumebizet1 pour l'invit sur la session #DockerWindows 👍

July 19, 2016 21:04