ASP.NET Core Web API 中的自定义格式化程序Custom formatters in ASP.NET Core Web API

本文内容

作者：Tom Dykstra

ASP.NET Core MVC 使用输入和输出格式化程序支持 Web API 中的数据交换。模型绑定使用输入格式化程序。格式响应使用输出格式化程序。

该框架为 JSON 和 XML 提供内置的输入和输出格式化程序。它为纯文本提供内置的输出格式化程序，但不为纯文本提供输入格式化程序。

本文展示如何通过创建自定义格式化程序，添加对其他格式的支持。有关纯文本的自定义输入格式化程序的示例，请参阅 GitHub 上的 TextPlainInputFormatter。

查看或下载示例代码（如何下载）

何时使用自定义格式化程序When to use custom formatters

如果希望内容协商过程支持内置格式化程序所不支持的内容类型，可使用自定义格式化程序。

例如，如果 Web API 的某些客户端可以处理 Protobuf 格式，你可能想在这些客户端上使用 Protobuf，因为它更高效。或者，你可能希望 Web API 使用 vCard 格式发送联系人姓名和地址，这种格式经常用于交换联系人数据。本文提供的示例应用可实现简单的 vCard 格式化程序。

有关如何使用自定义格式化程序的概述Overview of how to use a custom formatter

创建和使用自定义格式化程序的步骤如下：

• 如果想对要发送到客户端的数据进行序列化，则创建输出格式化程序类。
• 如果想对从客户端接收的数据进行反序列化，则创建输入格式化程序类。
• 将格式化程序的实例添加到 InputFormattersMvcOptionsOutputFormatters 中的 和 集合。

以下部分针对其中每个步骤提供了指南和代码示例。

如何创建自定义格式化程序类How to create a custom formatter class

若要创建格式化程序，请执行以下操作：

• 从相应的基类中派生类。
• 在构造函数中指定有效的媒体类型和编码。
• 重写 CanReadType/CanWriteType 方法
• 重写 ReadRequestBodyAsync/WriteResponseBodyAsync 方法

从相应的基类中派生Derive from the appropriate base class

对于文本媒体类型（例如，vCard），从 TextInputFormatter 或 TextOutputFormatter 基类派生。

public class VcardOutputFormatter : TextOutputFormatter

有关输入格式化程序示例，请参阅示例应用。

对于二进制类型，从 InputFormatter 或 OutputFormatter 基类派生。

指定有效的媒体类型和编码Specify valid media types and encodings

在构造函数中，通过添加到 SupportedMediaTypes 和 SupportedEncodings 集合来指定有效的媒体类型和编码。

public VcardOutputFormatter()
{
    SupportedMediaTypes.Add(MediaTypeHeaderValue.Parse("text/vcard"));
    SupportedEncodings.Add(Encoding.UTF8);
    SupportedEncodings.Add(Encoding.Unicode);
}

有关输入格式化程序示例，请参阅示例应用。

备注

不能在格式化程序类中执行构造函数依赖关系注入。例如，不能通过向构造函数添加记录器参数来获取记录器。若要访问服务，必须使用传递到方法的上下文对象。下面的代码示例展示了如何执行此操作。

重写 CanReadType/CanWriteTypeOverride CanReadType/CanWriteType

通过重写 CanReadType 或 CanWriteType 方法，指定可反序列化为或从其序列化的类型。例如，可能只能从 Contact 类型创建 vCard 文本，反之亦然。

protected override bool CanWriteType(Type type)
{
    if (typeof(Contact).IsAssignableFrom(type) 
        || typeof(IEnumerable<Contact>).IsAssignableFrom(type))
    {
        return base.CanWriteType(type);
    }
    return false;
}

有关输入格式化程序示例，请参阅示例应用。

CanWriteResult 方法The CanWriteResult method

在某些情况下，必须重写 CanWriteResult，而不是 CanWriteType。如果满足以下条件，则使用 CanWriteResult：

• 操作方法返回模型类。
• 具有可能在运行时返回的派生类。
• 需要知道操作在运行时返回了哪个派生类。

例如，假设操作方法签名返回 Person 类型，但它可能返回从 Student 派生的 Instructor 或 Person 类型。如果希望格式化程序仅处理 Student 对象，请检查提供给 方法的上下文对象中的对象CanWriteResult类型。请注意，当操作方法返回 CanWriteResult 时，不必使用 IActionResult；在这种情况下，CanWriteType 方法可接收运行时类型。

重写 ReadRequestBodyAsync/WriteResponseBodyAsyncOverride ReadRequestBodyAsync/WriteResponseBodyAsync

实际的反序列化或序列化工作在 ReadRequestBodyAsync 或 WriteResponseBodyAsync 中执行。以下示例中突出显示的行展示了如何从依赖关系注入容器中获取服务（不能从构造函数参数中获取它们）。

public override async Task WriteResponseBodyAsync(OutputFormatterWriteContext context, Encoding selectedEncoding)
{
    IServiceProvider serviceProvider = context.HttpContext.RequestServices;
    var logger = serviceProvider.GetService(typeof(ILogger<VcardOutputFormatter>)) as ILogger;
    var response = context.HttpContext.Response;
    var buffer = new StringBuilder();
    if (context.Object is IEnumerable<Contact>)
    {
        foreach (Contact contact in context.Object as IEnumerable<Contact>)
        {
            FormatVcard(buffer, contact, logger);
        }
    }
    else
    {
        var contact = context.Object as Contact;
        FormatVcard(buffer, contact, logger);
    }
    await response.WriteAsync(buffer.ToString());
}
private static void FormatVcard(StringBuilder buffer, Contact contact, ILogger logger)
{
    buffer.AppendLine("BEGIN:VCARD");
    buffer.AppendLine("VERSION:2.1");
    buffer.AppendFormat($"N:{contact.LastName};{contact.FirstName}\r\n");
    buffer.AppendFormat($"FN:{contact.FirstName} {contact.LastName}\r\n");
    buffer.AppendFormat($"UID:{contact.ID}\r\n");
    buffer.AppendLine("END:VCARD");
    logger.LogInformation("Writing {FirstName} {LastName}", contact.FirstName, contact.LastName);
}

有关输入格式化程序示例，请参阅示例应用。

如何将 MVC 配置为使用自定义格式化程序How to configure MVC to use a custom formatter

若要使用自定义格式化程序，请将格式化程序类的实例添加到 InputFormatters 或 OutputFormatters 集合。

services.AddMvc(options =>
{
    options.InputFormatters.Insert(0, new VcardInputFormatter());
    options.OutputFormatters.Insert(0, new VcardOutputFormatter());
})
.SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

按格式化程序的插入顺序对其进行计算。第一个优先。

后续步骤Next steps

• 此文档的示例应用，它可实现简单的 vCard 输入和输出格式化程序。该应用可读取和写入与以下示例类似的 vCard：

BEGIN:VCARD
VERSION:2.1
N:Davolio;Nancy
FN:Nancy Davolio
UID:20293482-9240-4d68-b475-325df4a83728
END:VCARD

若要查看 vCard 输出，请运行该应用程序，并向 http://localhost:63313/api/contacts/（从 Visual Studio 运行时）或 http://localhost:5000/api/contacts/（从命令行运行时）发送具有 Accept 标头“text/vcard”的 Get 请求。

若要将 vCard 添加到内存中联系人集合，请向相同的 URL 发送具有 Content-Type 标头“text/vcard”且正文中包含 vCard 文本的 Post 请求，格式化方式与上面的示例类似。