[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


Episode 198: #Azure #ContainerService with Ross Gardler - https://t.co/aioAoEso2d @docker

February 05, 2016 19:59

The second era of #cloud platforms will dwarf the first - https://t.co/pPAFHHYOhz

February 05, 2016 19:55

Announcing @Docker #Birthday #3 - https://t.co/pjh9tzn8kO

February 05, 2016 08:58

An early look at #Azure #Stack and what it means for IT - https://t.co/OSipXhlhGC

February 05, 2016 08:57

.@VorlonJS is now available in the @Docker Hub ! https://t.co/eVEIQ9yUzv https://t.co/QaRF83w7cp

February 04, 2016 17:56

Introducing #Microsoft @Azure #Stack https://t.co/elek6oVByJ

February 04, 2016 07:36

#Container Fundamentals | Part 5 - Hyper-V Containers - https://t.co/WapUJQPnjj

February 02, 2016 23:12

#Containers as a Service (CaaS) as your new platform for application development and operations - https://t.co/baeyPagEMH via @Docker

February 02, 2016 23:11

#Azure welcomes #Parse developers - https://t.co/AGDzBPjKIM

February 02, 2016 23:09

@Azure #Stack offers #hybrid #cloud on your terms - https://t.co/7bceyQh0fx

February 02, 2016 23:07

RT @meulta: .@VorlonJS 0.2.1 is out! What's new https://t.co/4rgvyiHh5f (@nodejs debugging, #accessibility, #devops & more!) https://t.co/4…

February 01, 2016 23:09

#VorlonJS 0.2.1 is out ! With a lot of new awesome stuff, more info here: https://t.co/B5974NqxYf via @meulta

February 01, 2016 22:50

This week in @Azure – February 1, 2016 - https://t.co/a4vEqw353c

February 01, 2016 13:37

Sending #ASPNET #WebHooks from #Azure #WebJobs - https://t.co/YpyHBtJHVh

January 31, 2016 20:46