[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


.@FredericWickert nous présente une archi full #PaaS dans @Azure ! @ArollaFr https://t.co/saXb2JsUAu

December 06, 2016 20:54

#Jenkins pipeline continuous deployment of a #Java application in @Azure #AppService w/ @jpbriend https://t.co/jpVEfd1MwE

December 06, 2016 20:07

What’s new upcoming in #Docker #Compose v1.9.0? https://t.co/ME15cFHHAh

December 06, 2016 08:30

#howto -> NoSQL #dotnetcore development using an local @Azure DocumentDB Emulator https://t.co/sJpwzIiymP

December 05, 2016 18:37

Want to know more about #VisualStudio #MobileCenter? Check this new @CloudCoverShow episode! https://t.co/3hVZ0tk7Bz

December 05, 2016 18:36

A #Kafka connector is now available for @Azure #IoT Hub https://t.co/pDWKuWizoo

December 05, 2016 18:33

Running #Azure "Functions Locally with the CLI and VS @Code https://t.co/7nou4YYAUm #serverless

December 05, 2016 18:31

Yey! #VisualStudio Tools for @Azure #Functions!! https://t.co/E5DaIs4jJb

December 01, 2016 19:45

From “A PC on every desktop” to “Deep Learning in every software” https://t.co/8mOOdjO9kM

December 01, 2016 08:44

Full CI/CD pipeline with @Docker #Swarm on #Azure #ContainerService #DevOps @VSTeam https://t.co/UHeBBxSaHz

November 30, 2016 20:50

@sandayuu thanks ;-)

November 30, 2016 06:37

@lamouetterieuse ni l'un ni l'autre :)

November 29, 2016 19:08

Just blogged: full CI/CD pipeline to deploy a multi-containers application on @Azure #ContainerService with #VSTShttps://t.co/PEAxL13eRf

November 29, 2016 18:16

Announcing #Azure #DevTest Labs support for creating environment with ARM templates https://t.co/AzCCuRZSqZ

November 29, 2016 09:52

Les conteneurs @Docker sous #Windows, accélérateurs de votre démarche #DevOps https://t.co/QecTyHY1hc

November 28, 2016 12:16