[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


This is the new Microsoft :) Live from #LinuxCon: Sharing the latest news and learnings on #Microsoft’s open journey https://t.co/P8UZUwHHAX

August 23, 2016 07:00

How to create a #Docker Datacenter on Microsoft #Azure https://t.co/dql2jYD0xQ

August 22, 2016 15:00

RT @DockerParis: Notre prochain meetup aura lieu au Palais des Congrès à l'occasion des MS Experiences https://t.co/73ZRAyTiFS

August 22, 2016 14:21

Les sessions de @ContainerDay16 sont en ligne! Ma keynote #Container #Azure / #Windows est ici: https://t.co/DnKgiez1Bk

August 22, 2016 07:04

Provisioning the #Azure #Kubernetes infrastructure with a declarative template https://t.co/yQFOfgzEbR

August 20, 2016 09:58

All you need to know about #Windows #Containers in one pic! https://t.co/p5wcaIZf0R

August 20, 2016 08:39

#DevOps: Build, push and run @Docker images using #VisualStudio Team Services https://t.co/r9KNaZnJ9U https://t.co/DtMagfwjC5

August 19, 2016 13:06

Nice video: Run #PowerShell Natively on #Linux with @Docker :) https://t.co/b8nwA8XbGL

August 19, 2016 06:40

Very cool update: New UI and new navigation for #TeamServices https://t.co/4UFohxPuMA

August 19, 2016 05:38

#PowerShell is now open source and available on #Linux :) https://t.co/HfCYEoSIvz

August 18, 2016 16:37

@fdibot @Azure un outil fait par Docker (un template ARM en fait :)) -> https://t.co/oeoDFPkL7p

August 18, 2016 12:57

First Look: #Docker for @Azure Beta https://t.co/VL1S8Q2csC

August 18, 2016 12:53

#TeamServices Integration with #Jenkins Jobs, Pipelines, and Artifacts Lifecycle Management https://t.co/r2Cz7gjlVC #CloudBees #DevOps

August 18, 2016 12:50

Cloud-first, mobile-first: Microsoft moves to a fully wireless network https://t.co/9vELzKh0a6

August 18, 2016 12:47

Feedback Requested: Microsoft #Azure #Linux Doc survey https://t.co/JS5totMcL1

August 18, 2016 12:45