[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


How Microsoft’s Brendan Burns is trying to make cloud-native app deployment as easy as coding https://t.co/kPa2mzqE9V

December 18, 2017 07:44

RT @brendandburns: Really great overview of @Azure container service! https://t.co/7fk42Ud7m5

December 14, 2017 17:40

#KubeCon 2017 Demo - Istio and Brigade CI/CD https://t.co/60uaK82fIJ

December 14, 2017 08:18

Azure #Functions CI/CD pipeline for #Nodejs using #VSTS https://t.co/3UElDsDsDL

December 14, 2017 08:13

AKS cluster upgrades and managed #Kubernetes in #Azure https://t.co/b0naeEUwl1

December 12, 2017 16:01

Microsoft Azure <3 France ! https://t.co/w4Ak8f4QWN

December 12, 2017 08:09

The future is here! The #Quantum Development Kit has been released :) https://t.co/8mSieAEbCr

December 12, 2017 07:16

A tour of #containerd 1.0 https://t.co/27jtxIu17d

December 12, 2017 07:10

Last week in Azure: OSBA, DevOps and Kubernetes, VM sizes, and more https://t.co/vq6jtWLYTq

December 12, 2017 07:08

RT @BradSmi: We believe #AI is a game changer in creating solutions to protect the planet. That’s why we’re expanding #AIforEarth. #OnePlan

December 11, 2017 13:52

WSL Interoperability with #Docker https://t.co/xtiUafCPyq

December 11, 2017 11:58

RT @jpetazzo: If you are using @docker (or are planning to) to help you in your DevOps initiatives, you might want to read this: https://t.…

December 09, 2017 12:20

RT @benjguin: Free eBook – The Developer’s Guide to Microsoft Azure now available https://t.co/z9VeGYRDQy https://t.co/V0ozQPJllh

December 08, 2017 08:08

Check out the new #Azure Application Architecture Guide https://t.co/M3wIQfkRhi

December 08, 2017 07:53

What’s brewing in Visual Studio Team Services: December 2017 Digest https://t.co/jL8yNATyJR

December 08, 2017 07:51