[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


.NET Core Open Source Update - February 26, 2015 - http://t.co/IumcRBUMGA

February 27, 2015 13:01

Update for #OneDrive app for #WindowsPhone brings a few new features - http://t.co/Lgyw2VOMgi

February 27, 2015 10:54

#Docker support in #Azure ! Sunny and Swarmy in Azure - http://t.co/aF6Puxzdle

February 27, 2015 09:37

Using #Azure #MediaServices streaming video with DashJS player - http://t.co/wWi9YuvXS2

February 26, 2015 09:37

Identity Updates for Web Developers in Visual Studio 2015 CTP6 - http://t.co/qEXw0ywwXc #aspnet

February 26, 2015 08:21

Limit the exposure of sensitive data in #Azure #SQLDatabase using Dynamic Data Masking - http://t.co/MShrGepdE0

February 26, 2015 08:01

#AngularJS: Pourquoi il ne faut pas utiliser ngCloak ? - http://t.co/lVCLsT1HT2

February 25, 2015 16:16

#Azure Blob #Storage Part 7: Snapshots - http://t.co/KmrQfmH3Ta

February 25, 2015 09:37

Cool :) Pointer Events is now a W3C Standard - http://t.co/Rn0UxBMcSD

February 25, 2015 08:21

Fix for blob trigger -> Announcing the 1.0.1-alpha preview of #Microsoft #Azure #WebJobs SDK - http://t.co/Oan1yDXUj9

February 25, 2015 08:01

RT @VisualStudio: What’s new in Babylon.js v2.0 you ask? http://t.co/csoYv7PVsd http://t.co/9egkm9lx06

February 24, 2015 21:17

RT @msdev_fr: Bonne soirée :) #devlife http://t.co/iH6Mz3qQhW

February 24, 2015 20:50

#MustRead: Introducing #ASPNET 5 - http://t.co/5DOrUs5O7l

February 24, 2015 09:37

New CTPs available -> #VS 2015 CTP6 and #TFS 2015 CTP1 shipped today - http://t.co/tCjEhOBDo9

February 24, 2015 08:21

Interesting reading -> #Windows shapes the world’s languages - http://t.co/7NGz2qNyg7

February 24, 2015 08:01