mrkt 的程式學習筆記: ASP.NET MVC + JSON 自定義JsonResult 1

2011年10月27日星期四

ASP.NET MVC + JSON 自定義JsonResult 1

在「使用Entity Framework 將物件轉為JSON時遇到循環參考錯誤 1」裡面有提到，

如果把EF取出的物件不做任何處理然後在JsonResult中直接使用 Json()方法傳回，會出現「循環參考」的錯誤，

而文章中有提到說可以使用Json.NET所提供的 JsonConvert.SerializeObject()方法來回傳Json資料，

但是必須要使用ActionResult的類別來回傳，而且為了讓Content-Type正確，也需要指定Content-Type，如以下的程式：

public ActionResult Product(int? id){  if (!id.HasValue)  {    Dictionary<string, string> jo = new Dictionary<string, string>();    jo.Add("Msg", "請輸入產品ID編號.");    return Content(JsonConvert.SerializeObject(jo), "application/json");  }  else  {    ProductService service = new ProductService();    var product = service.Single(id.Value);    return Content(JsonConvert.SerializeObject(product), "application/json");  }}

使用了Json.NET來做為序列化JSON資料的工具，而Json.NET的官網上面也有提供了一個JsonNetResult的類別，

這樣一來在Action就不用再多一個動作去指定使用JsonConvert.Serialize() 方法來序列化資料，

另外也不用使用回傳類別ActionResult，也不用再去指定Content-Type。

Json.NET - ASP.NET MVC and Json.NET： JsonNetResult

http://james.newtonking.com/archive/2008/10/16/asp-net-mvc-and-json-net.aspx

JsonNetResult類別：

public class JsonNetResult : ActionResult {   public Encoding ContentEncoding { get; set; }   public string ContentType { get; set; }   public object Data { get; set; }     public JsonSerializerSettings SerializerSettings { get; set; }   public Formatting Formatting { get; set; }     public JsonNetResult()   {     SerializerSettings = new JsonSerializerSettings();   }     public override void ExecuteResult(ControllerContext context)   {     if (context == null)       throw new ArgumentNullException("context");       HttpResponseBase response = context.HttpContext.Response;       response.ContentType = !string.IsNullOrEmpty(ContentType)       ? ContentType       : "application/json";       if (ContentEncoding != null)       response.ContentEncoding = ContentEncoding;       if (Data != null)     {       JsonTextWriter writer = new JsonTextWriter(response.Output) { Formatting = Formatting };         JsonSerializer serializer = JsonSerializer.Create(SerializerSettings);       serializer.Serialize(writer, Data);         writer.Flush();     }   } } 

使用的方式如下：

public JsonNetResult Product(int? id)
{
  JsonNetResult jsonNetResult = new JsonNetResult();
  jsonNetResult.Formatting = Newtonsoft.Json.Formatting.None;
  jsonNetResult.SerializerSettings.NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore;
  if (!id.HasValue)
  {
    Dictionary<string, string> jo = new Dictionary<string, string>();
    jo.Add("Msg", "請輸入產品ID編號.");
    jsonNetResult.Data = jo;
  }
  else
  {
    ProductService service = new ProductService();
    var product = service.Single(id.Value);
    var result = new 
    {
      ProductID = product.ProductID,
      ProductName = product.ProductName,
      CategoryID = product.CategoryID,
      CategoryName = product.Category.CategoryName,
      UnitPrice = product.UnitPrice,
      UnitsInStock = product.UnitsInStock,
      UnitsOnOrder = product.UnitsOnOrder
    };
    jsonNetResult.Data = result;
  }
  return jsonNetResult;
}

首先建立一個JsonNetResult的物件，接著指定 Formatting 與 SerializerSettings.NullValueHandling，

Formatting

JSON written by the serializer with an option of Formatting.Indented produces nicely formatted, easy to read JSON – great when you are developing. Formatting.None on the other hand keeps the JSON result small, skipping all unnecessary spaces and line breaks to produce the most compact and efficient JSON possible.

NullValueHandling

NullValueHandling is an option on the JsonSerializer and controls how the serializer handles properties with a null value. By setting a value of NullValueHandling.Ignore the JsonSerializer skips writing any properties that have a value of null.

接著就是把要序列化的物件資料給放到 jsonNetResult.Data 中，最後再 return jsonNetResult; 就可以了。

執行結果：