[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


#Microsoft #Azure #Diagnostics Part 4: Custom Logging Components and Azure Diagnostics 1.3 Changes - http://t.co/Fy7XX9XyVV

December 21, 2014 08:21

Exemple d’une directive #AngularJS utilisant la phase compile - http://t.co/K9IByIkkoG

December 21, 2014 08:01

@UbiJustin Since the 1.4 patch of AC Unity (PC) I can't play anymore : the game crashes at launch on come back to the desktop... Any idea ?

December 19, 2014 08:20

@assassinscreed AC Unity crashes at launch (not responding) since patch 1.4 has been installed (PC, Steam). I can't play anymore...

December 19, 2014 08:12

#Microsoft: We have more than 1.5 million #Windows 10 'Insiders' http://t.co/RoCXqgy3JJ

December 19, 2014 08:01

@AssassinsFR depuis l'installation du patch 1.4 d'AC Unity le jeu crash au lancement sur PC... Systématiquement... Impossible de jouer !!

December 19, 2014 08:00

#Docker – a reading list http://t.co/qUGAedDybV

December 18, 2014 17:28

Active Directory from on-premises to the cloud – #Azure AD whitepapers http://t.co/utieQxOfxr

December 18, 2014 16:16

#ASPNET #MVC 5.2.3, #WebPages 5.2.3 and #WebAPI 5.2.3 Beta releases http://t.co/MSQALH5bGb

December 18, 2014 14:17

Secure #ASP.NET #WebAPI using API Key Authentication – HMAC Authentication http://t.co/aZ6x480Rfq

December 18, 2014 13:01

2015 Technology Trends: Internet of Things and #DevOps : http://t.co/WrFe1grkm3 #IoT

December 18, 2014 10:54

Final Root Cause Analysis and Improvement Areas: Nov 18 #Azure #Storage Service Interruption: http://t.co/sXX3D6c521

December 18, 2014 09:37

#Azure #Backup – Announcing Support for Windows Client Operating System

December 17, 2014 08:01

#Azure #VirtualMachines : Using Chef, Puppet and Docker for managing Linux VMs - http://t.co/S7XwAjQlmg

December 16, 2014 09:37