Usare Json.NET come motore di serializzazione in ASP.NET MVC

di , in ASP.NET MVC,

Quando restituiamo un JsonResult da una action, il framework utilizza internamente JavaScriptSerializer per serializzare il nostro model. Questo avviene in contrasto con ASP.NET Web API, che sfrutta invece la libreria Json.NET.

In casi semplici, probabilmente non ci accorgeremo mai della differenza. Tuttavia questa situazione risulta particolarmente scomoda nel momento in cui abbiamo un object model condiviso tra MVC e Web API, nel quale magari abbiamo personalizzato le regole di serializzazione tramite gli attributi di Json.NET:

public class Person
{
  [JsonProperty("name")]
  public string Name { get; set; } 
}

Per far sì che anche MVC usi questa libreria, l'unica alternativa che abbiamo è quella di creare un ActionResult personalizzato come il seguente:

public class JsonNetResult : ActionResult
{
  public object Data { get; set; }

  public JsonRequestBehavior JsonRequestBehavior { get; set; }

  ...
}

JsonNetResult è molto semplice e contiene solo due proprietà: una per specificare il contenuto del risultato, l'altra (per uniformità alla versione "ufficiale" JsonResult), permette invece di indicare se le richieste di tipo GET sono ammesse o meno.

Il cuore della classe però è costituito dall'override del metodo ExecuteResult:

public override void ExecuteResult(ControllerContext context)
{
  if (context == null)
  {
    throw new ArgumentNullException("context");
  }
  if ((this.JsonRequestBehavior == JsonRequestBehavior.DenyGet) && 
       string.Equals(context.HttpContext.Request.HttpMethod, "GET", 
       StringComparison.OrdinalIgnoreCase))
  {
    throw new InvalidOperationException("GET Not allowed");
  }
            
  HttpResponseBase response = context.HttpContext.Response;
  response.ContentType = "application/json";

  if (Data != null)
  {
    JsonTextWriter writer = new JsonTextWriter(response.Output);

    JsonSerializer serializer = JsonSerializer.Create();
    serializer.Serialize(writer, Data);

    writer.Flush();
  }
}

Il codice può sembrare corposo, ma in realtà è piuttosto lineare: una volta verificato se la richiesta è di tipo GET e se questa sia ammessa, non facciamo altro che impostare il content type corretto e poi sfruttare gli oggetti JsonSerializer e JsonTextWriter per scrivere sullo stream di risposta. Ovviamente perché questa classe compili, è necessario referenziare il package Json.NET tramite NuGet.

Quando usiamo la versione standard JsonResult in una action, abbiamo a disposizione il metodo Json che rende molto comoda la scrittura del codice:

public ActionResult MyAction()
{
  var model = ...

  return this.Json(model);
}

Se vogliamo rendere l'utilizzo di JsonNetResult altrettanto semplice, possiamo creare un extension method della classe Controller:

public static class JsonNetResultHelper
{
  public static JsonNetResult JsonNet(this Controller controller, object data, 
    JsonRequestBehavior behavior = JsonRequestBehavior.DenyGet)
  {
    return new JsonNetResult 
    { 
      Data = data, 
      JsonRequestBehavior = behavior 
    };
  }
}

A questo punto saremo in grado di utilizzare Json.NET in maniera del tutto analoga a quella "ufficiale":

public ActionResult MyAction()
{
  var model = ...

  return this.JsonNet(model);
}

Commenti

Visualizza/aggiungi commenti

Usare Json.NET come motore di serializzazione in ASP.NET MVC (#1167) 1010 3
| Condividi su: Twitter, Facebook, LinkedIn, Google+

Per inserire un commento, devi avere un account.

Fai il login e torna a questa pagina, oppure registrati alla nostra community.

Approfondimenti

I più letti di oggi