超高性能的json序列化之MVC中使用Json.Net

先不废话，直接上代码

Asp.net MVC自带Json序列化

/// <summary>
/// 加载组件列表
/// </summary>
/// <param name="departmentId">作业部/厂</param>
/// <param name="unitId">组件Id</param>
/// <param name="tag">标签号</param>
/// <param name="pageIndex">当前页码</param>
/// <param name="pageSize">每页条数</param>
/// <returns>返回组件json数据</returns>
public JsonResult ListCom(long departmentId, IEnumberable<long> unitIds, string tag, int pageIndex, int pageSize)
{
    var dataEntity = LdarService.ListCom(unitIds, tag, pageIndex + 1, pageSize);
    var dataModel = new Page<LdComModel> {Total = dataEntity.Total};
    var data =
        dataModel.DataList =
            dataEntity.DataList.Select(model => Builder.Builder.Convert<LdComModel>(new object[] {model}));//Entity转ViewModel
    dataModel.DataList = data;
    return Json(new {
            msg = CommonModelBuilder.BuildQuerySuccessMessage("组件信息维护", (int) dataModel.Total),
            data = dataModel.DataList,
            total = dataModel.Total
        });
}

显示到前台界面

接收到的报文中有很多导航属性，前台并不需要这些属性.

LdComModel类中关联了很多外表，也就是导航属性，导航也被序列化，这样不科学，会将所有属性包括导航属性都序列化，还可能会造成循环引用，导致报错。
我只想序列需要的字段，这时可以手写一个匿名类

var data=new {
     model.AreaName,
     model.AreaId,
     ......                  
};

这么写字段少还好，字段多就很不爽吧。

这时我们可以用Json.Net序列化，首先引用newtonsoft.json.dll，使用nuget引用比较方便。在不想序列化的属性上打上[JsonIgnore]特性，序列化就会被忽略。

LdComModel类中的部分代码

/// <summary>
/// 分区
/// </summary>
[JsonIgnore]
public LdAreaModel LdAreaModel { get; set; }

/// <summary>
/// 区域名称
/// </summary>
public string AreaName
{
    get
    {
        return LdAreaModel.LdarAreaName;
    }
}

使用JsonNet序列化

/// <summary>
/// 加载组件列表
/// </summary>
/// <param name="departmentId">作业部/厂</param>
/// <param name="unitId">组件Id</param>
/// <param name="tag">标签号</param>
/// <param name="pageIndex">当前页码</param>
/// <param name="pageSize">每页条数</param>
/// <returns>返回组件json数据</returns>
public JsonResult ListCom(long departmentId, IEnumberable<long> unitIds, string tag, int pageIndex, int pageSize)
{
    var dataEntity = LdarService.ListCom(unitIds, tag, pageIndex + 1, pageSize);
    var dataModel = new Page<LdComModel> {Total = dataEntity.Total};
    var data =
        dataModel.DataList =
            dataEntity.DataList.Select(model => Builder.Builder.Convert<LdComModel>(new object[] {model}));//Entity转ViewModel
    dataModel.DataList = data;
    var result = new JsonNetResult()
        {
            Data = new
            {
                msg = CommonModelBuilder.BuildQuerySuccessMessage("组件信息维护", (int) dataModel.Total),
                data = dataModel.DataList,
                total = dataModel.Total
            }
        };
        return result;
}

这时返回到前台的json中没有多余的导航属性.

导航属性没有被序列化，速度也快了很多。

这样写，虽然可以实现功能，很每次都要new一个JsonNetResult对象，写起来很是不爽，能不能给Controller写个扩展方法，像Json(...)一样直接写JsonNet(...)?

Controller中Json(...)方法的部分源码

    /// <summary>
    /// 创建一个将指定对象序列化为 JavaScript 对象表示法 (JSON) 的 <see cref="T:System.Web.Mvc.JsonResult"/> 对象。
    /// </summary>
    /// 
    /// <returns>
    /// 将指定对象序列化为 JSON 格式的 JSON 结果对象。在执行此方法所准备的结果对象时，ASP.NET MVC 框架会将该对象写入响应。
    /// </returns>
    /// <param name="data">要序列化的 JavaScript 对象图。</param>
    protected internal JsonResult Json(object data)
    {
      return this.Json(data, (string) null, (Encoding) null, JsonRequestBehavior.DenyGet);
    }

// <summary>
    /// 创建 <see cref="T:System.Web.Mvc.JsonResult"/> 对象，该对象使用内容类型、内容编码和 JSON 请求行为将指定对象序列化为 JavaScript 对象表示法 (JSON) 格式。
    /// </summary>
    /// 
    /// <returns>
    /// 将指定对象序列化为 JSON 格式的结果对象。
    /// </returns>
    /// <param name="data">要序列化的 JavaScript 对象图。</param><param name="contentType">内容类型（MIME 类型）。</param><param name="contentEncoding">内容编码。</param><param name="behavior">JSON 请求行为</param>
    protected internal virtual JsonResult Json(object data, string contentType, Encoding contentEncoding, JsonRequestBehavior behavior)
    {
      return new JsonResult()
      {
        Data = data,
        ContentType = contentType,
        ContentEncoding = contentEncoding,
        JsonRequestBehavior = behavior
      };
    }

我们可以仿照Controller中的源码，自己给Controller写个扩展方法JsonNet(...)

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Web;

namespace System.Web.Mvc
{
    public static class ControllerExt
    {
        /// <summary>
        /// 创建一个将指定对象序列化为 JavaScript 对象表示法 (JSON) 的 <see cref="T:System.Web.Mvc.JsonNetResult"/> 对象。
        /// </summary>
        /// 
        /// <returns>
        /// 将指定对象序列化为 JSON 格式的 JSON 结果对象。在执行此方法所准备的结果对象时，ASP.NET MVC 框架会将该对象写入响应。
        /// </returns>
        /// <param name="controller">控件器</param>
        /// <param name="data">要序列化的 JavaScript 对象图。</param>
        public static JsonNetResult JsonNet(this Controller controller, object data)
        {
            return JsonNet(data, (string) null, (Encoding) null, JsonRequestBehavior.DenyGet);
        }

        /// <summary>
        /// 创建一个将指定对象序列化为 JavaScript 对象表示法 (JSON) 格式的 <see cref="T:System.Web.Mvc.JsonNetResult"/> 对象。
        /// </summary>
        /// 
        /// <returns>
        /// 将指定对象序列化为 JSON 格式的 JSON 结果对象。
        /// </returns>
        /// <param name="controller">控件器</param>
        /// <param name="data">要序列化的 JavaScript 对象图。</param>
        /// <param name="contentType">内容类型（MIME 类型）。</param>
        public static JsonNetResult JsonNet(this Controller controller, object data, string contentType)
        {
            return JsonNet(data, contentType, (Encoding) null, JsonRequestBehavior.DenyGet);
        }

        /// <summary>
        /// 创建一个将指定对象序列化为 JavaScript 对象表示法 (JSON) 格式的 <see cref="T:System.Web.Mvc.JsonNetResult"/> 对象。
        /// </summary>
        /// 
        /// <returns>
        /// 将指定对象序列化为 JSON 格式的 JSON 结果对象。
        /// </returns>
        /// <param name="controller">控件器</param>
        /// <param name="data">要序列化的 JavaScript 对象图。</param>
        /// <param name="contentType">内容类型（MIME 类型）。</param>
        /// <param name="contentEncoding">内容编码。</param>
        public static JsonNetResult JsonNet(this Controller controller, object data, string contentType,
            Encoding contentEncoding)
        {
            return JsonNet(data, contentType, contentEncoding, JsonRequestBehavior.DenyGet);
        }

        /// <summary>
        /// 创建 <see cref="T:System.Web.Mvc.JsonNetResult"/> 对象，该对象使用指定 JSON 请求行为将指定对象序列化为 JavaScript 对象表示法 (JSON) 格式。
        /// </summary>
        /// 
        /// <returns>
        /// 将指定对象序列化为 JSON 格式的结果对象。
        /// </returns>
        /// <param name="controller">控件器</param>
        /// <param name="data">要序列化的 JavaScript 对象图。</param>
        /// <param name="behavior">JSON 请求行为。</param>
        public static JsonNetResult JsonNet(this Controller controller, object data, JsonRequestBehavior behavior)
        {
            return JsonNet(data, (string) null, (Encoding) null, behavior);
        }

        /// <summary>
        /// 创建 <see cref="T:System.Web.Mvc.JsonNetResult"/> 对象，该对象使用指定内容类型和 JSON 请求行为将指定对象序列化为 JavaScript 对象表示法 (JSON) 格式。
        /// </summary>
        /// 
        /// <returns>
        /// 将指定对象序列化为 JSON 格式的结果对象。
        /// </returns>
        /// <param name="controller">控件器</param>
        /// <param name="data">要序列化的 JavaScript 对象图。</param>
        /// <param name="contentType">内容类型（MIME 类型）。</param>
        /// <param name="behavior">JSON 请求行为</param>
        public static JsonNetResult JsonNet(this Controller controller, object data, string contentType,
            JsonRequestBehavior behavior)
        {
            return JsonNet(data, contentType, (Encoding) null, behavior);
        }

        /// <summary>
        /// 创建 <see cref="T:System.Web.Mvc.JsonNetResult"/> 对象，该对象使用内容类型、内容编码和 JSON 请求行为将指定对象序列化为 JavaScript 对象表示法 (JSON) 格式。
        /// </summary>
        /// 
        /// <returns>
        /// 将指定对象序列化为 JSON 格式的结果对象。
        /// </returns>
        /// <param name="controller">控件器</param>
        /// <param name="data">要序列化的 JavaScript 对象图。</param>
        /// <param name="contentType">内容类型（MIME 类型）。</param>
        /// <param name="contentEncoding">内容编码。</param><param name="behavior">JSON 请求行为</param>
        public static JsonNetResult JsonNet(this Controller controller, object data, string contentType,
            Encoding contentEncoding, JsonRequestBehavior behavior)
        {
            return JsonNet(data, contentType, contentEncoding, behavior);
        }

        /// <summary>
        /// 创建 <see cref="T:System.Web.Mvc.JsonNetResult"/> 对象，该对象使用内容类型、内容编码和 JSON 请求行为将指定对象序列化为 JavaScript 对象表示法 (JSON) 格式。
        /// </summary>
        /// <param name="data">要序列化的 JavaScript 对象图。</param>
        /// <param name="contentType">内容类型（MIME 类型）。</param>
        /// <param name="contentEncoding">内容编码。</param>
        /// <param name="behavior"></param>
        /// <returns>JSON 请求行为</returns>
        private static JsonNetResult JsonNet(object data, string contentType, Encoding contentEncoding,
            JsonRequestBehavior behavior)
        {
            return new JsonNetResult()
            {
                Data = data,
                ContentType = contentType,
                ContentEncoding = contentEncoding,
                JsonRequestBehavior = behavior
            };
        }

    }
}

写个JsonNetResult类，继承自JsonResult，重写ExecuteResult()方法，内部使用JsonNet来序列化。

using System.Text;
using Newtonsoft.Json;

namespace System.Web.Mvc
{
    public class JsonNetResult : JsonResult
    {
        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)
            {
                var writer = new JsonTextWriter(response.Output) { Formatting = Formatting };

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

                writer.Flush();
            }
        }
    }
}

封装后的JsonNet序列化

/// <summary>
/// 加载组件列表
/// </summary>
/// <param name="departmentId">作业部/厂</param>
/// <param name="unitId">组件Id</param>
/// <param name="tag">标签号</param>
/// <param name="pageIndex">当前页码</param>
/// <param name="pageSize">每页条数</param>
/// <returns>返回组件json数据</returns>
public JsonNetResult ListCom(long departmentId, IEnumberable<long> unitIds, string tag, int pageIndex, int pageSize)
{
    var dataEntity = LdarService.ListCom(listUnitId, tag, pageIndex + 1, pageSize);
    var dataModel = new Page<LdComModel> {Total = dataEntity.Total};
    var data =
        dataModel.DataList =
            dataEntity.DataList.Select(model => Builder.Builder.Convert<LdComModel>(new object[] {model}));//Entity转ViewModel
    dataModel.DataList = data;
    return this.JsonNet(new
    {
        msg = CommonModelBuilder.BuildQuerySuccessMessage("组件信息维护", (int) dataModel.Total),
        data = dataModel.DataList,
        total = dataModel.Total
    });
}

 这样调用起来跟自带的Json(...)一样，非常方便。

由于时间关系，博客就先写到这里。不足及错误之处，敬请批评指正。