将 ASP.NET Core MVC 默认的 JSON 解析器换为 Jil（输出）

之前记录了一下，将 ASP.NET MVC5 中的 JSON 解析器替换为 Jil，点此查看。

本文只针对输出时进行替换，新的内容：将 .NET Core 2.0 的默认 JSON 解析器替换为 Jil。

本文涉及的内容是在 ASP.NET Core MVC 中将输出 JSON 解析器替换为 Jil（Nuget、Github）。

列举一些官方的输入/输出的 Json 解析实现源码：

• TextInputFormatter（官方源码，文本输入类）
• TextOutputFormatter（官方源码，文本输出类，本文基类）

---

• MediaTypeHeaderValues（参考官方 Content-Type）

---

• JsonInputFormatter（官方源码，参考）
• JsonOutputFormatter（官方源码，参考）

环境：

• MacBook Pro 13 Retina 8G/256G
• macOS Sierra 10.12.3
• Visual Studio Code 1.10.2
• .NET Core 1.1

整体说明：

由于 .NET Core 的全面拆包，所以，不能像上一篇记录那样，只继承一个 MediaTypeFormatter，实现相关的方法，就全部搞定了。

在 .NET Core 中，Http 请求的 Json 解析，分了 输入解析 和 输出解析。

• 输入（请求参数）：一般来说，参数比较少（即使是泛型列表，Count 也不会很大），所以，官方的 Json.NET 在解析时，也没有太大的性能问题。

• 输出（响应结果）：这个部分可能涉及的数据量比较大，所以，本文只是实现了输出对象的 Json 格式化。

主要步骤

1、建立输出 Json 解析类（继承自 TextOutputFormatter）
2、在 Startup 中注册新的输出 Json 解析器
3、全部结束

具体步骤

1、在 Visual Studio Code 中打开项目，通过其内置终端的 dotnet 命令安装 Jil，如下所示：

dotnet add package jil

本文安装的版本是：2.15.0。

1.1、用单例实现一个 JilHelper 的类，主要方便各处使用序列化和反序列化的方法，代码如下：

// 命名空间
using Jil;

using System.IO;

public class JilHelper
{
    private Options _options;

    private JilHelper()
    {
        _options = new Options(excludeNulls: true, includeInherited: true,
            dateFormat: DateTimeFormat.MillisecondsSinceUnixEpoch,
            serializationNameFormat: SerializationNameFormat.CamelCase);
    }

    public static readonly JilHelper Instance = new JilHelper();

    public void Serialize(TextWriter writer, object data)
    {
        JSON.Serialize(data, writer, _options);
    }
}

1.2、参考官方的 MediaTypeHeaderValues，自建一个（也可以不用这个，直接在代码中，将字符串转换成 MediaTypeHeaderValue 即可，这里单独建立的目的主要是考虑到以后的复用）

// 命名空间
using Microsoft.Net.Http.Headers;

internal class ContentTypeValues
{
    public static readonly MediaTypeHeaderValue AppJson = MediaTypeHeaderValue.Parse("application/json").CopyAsReadOnly();

    public static readonly MediaTypeHeaderValue TxtJson = MediaTypeHeaderValue.Parse("text/json").CopyAsReadOnly();
}

2、在项目中，新建一个 JilOutFormatter 的类，继承自 TextOutputFormatter，如下所示：

// 命名空间
using Microsoft.AspNetCore.Mvc.Formatters;

using System;
using System.Text;
using System.Threading.Tasks;

public class JilOutFormatter : TextOutputFormatter
{
    // 构造函数
    public JilOutFormatter()
    {
        SupportedEncodings.Add(Encoding.UTF8);
        SupportedEncodings.Add(Encoding.Unicode);

        SupportedMediaTypes.Add(ContentTypeValues.AppJson);
        SupportedMediaTypes.Add(ContentTypeValues.TxtJson);
    }

    // 实现父类的核心方法
    public override async Task WriteResponseBodyAsync(OutputFormatterWriteContext context, Encoding encoding)
    {
        if (context == null)
        {
            throw new ArgumentNullException(nameof(context));
        }

        if (encoding == null)
        {
            encoding = Encoding.UTF8;
        }

        var response = context.HttpContext.Response;

        using (var writer = context.WriterFactory(response.Body, encoding))
        {
            JilHelper.Instance.Serialize(writer, context.Object);
            await writer.FlushAsync();
        }
    }
}

3、在 Startup 中，找到 ConfigureServices(IServiceCollection services) 这个方法，按照如下修改：

public void ConfigureServices(IServiceCollection services)
{
    // 一定要在 AddMvc 之前调用 AddMvcCore 方法来注册自定义的 Json 解析器
    services.AddMvcCore(opts => { opts.OutputFormatters.Add(new JilOutFormatter()); });

    services.AddMvc();
}

4、至此，输出的 Json 解析用 Jil 的替换就全部结束了。