[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


Join @shanselman speaking about the Microsoft’s 15 years journey on .NET ! https://t.co/HqYQrhrOM9 #dotnethttps://t.co/SpZ2g4wBp6

September 27, 2016 16:00

#DevOps, #NoOps, everything-as-code, commoditisation. Quel futur pour les #ops ? https://t.co/uIpjsl3Dm6 @adrienblind @patcito #experiences

September 27, 2016 09:00

Docker & DevOps : adopter les mêmes pratiques sous #Windows et sous #Linux https://t.co/vixudq72h0 @treeptik #devopsdday

September 27, 2016 08:47

Finalisation de notre session #aspnet core pour Microsoft #experiences ! https://t.co/DOwuXI9il3 @benjiiimhttps://t.co/DnMw2FyVxR

September 27, 2016 07:20

Microsoft CEO Satya Nadella on how #AI will transform his company https://t.co/kQ7snrxpaV

September 27, 2016 04:28

Announcing @Azure Command-Line Interface (Azure CLI) 2.0 Preview https://t.co/UfXH6FTC73 #AzureCLI

September 26, 2016 20:49

@asiffermann des news de KeyVault :) https://t.co/PBmbLjVPu7

September 26, 2016 20:11

#Cloud innovations empowering IT for business transformation https://t.co/n0vylJAavj #Azure #Hybrid #HyperScale #EnterpriseGrade

September 26, 2016 20:11

Announcing the public preview of #Azure Monitor https://t.co/lutbdfd1Ne

September 26, 2016 20:06

#Microsoft and #Docker offer supported Docker Engine to #WindowsServer 2016 customers https://t.co/JnXqgkaDao

September 26, 2016 19:51

Build and run your first #Docker #WindowsServer container https://t.co/hq9Dl99v9K

September 26, 2016 19:43

Announcing the launch of Windows Server 2016 https://t.co/y0rrKiuolW

September 26, 2016 19:38

It's here !! :) Introducing @Docker for #WindowsServer2016 https://t.co/5KvQ6fZNVr

September 26, 2016 14:33

#Docker Announces Commercial Partnership with #Microsoft https://t.co/k7vR5VFoEw

September 26, 2016 14:32

Pour tout savoir sur @Azure #ServiceFabric, retrouvez @wilfriedwoivre et @nclerc lors des Microsoft #experiences'16… https://t.co/e2Fg5YZbxp

September 26, 2016 14:00