Microsoft.AspNet.WebApi.MessageHandlers.Compression 项目教程

Microsoft.AspNet.WebApi.MessageHandlers.Compression 项目教程

Microsoft.AspNet.WebApi.MessageHandlers.Compression Drop-in module for ASP.Net WebAPI that enables GZip and Deflate support 项目地址: https://gitcode.com/gh_mirrors/mi/Microsoft.AspNet.WebApi.MessageHandlers.Compression

1. 项目目录结构及介绍

Microsoft.AspNet.WebApi.MessageHandlers.Compression/
├── dist/
│   └── nuget/
├── src/
│   ├── Microsoft.AspNet.WebApi.Extensions.Compression.Server/
│   ├── System.Net.Http.Extensions.Compression.Client/
│   └── ...
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
└── appveyor.yml

目录结构介绍

• dist/nuget/: 包含项目的 NuGet 包相关文件。
• src/: 包含项目的源代码，主要分为两个部分：
  • Microsoft.AspNet.WebApi.Extensions.Compression.Server/: 服务器端压缩处理的相关代码。
  • System.Net.Http.Extensions.Compression.Client/: 客户端压缩处理的相关代码。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• appveyor.yml: AppVeyor CI 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要涉及 App_Start\WebApiConfig.cs 文件，该文件用于配置 ASP.NET Web API 的路由和消息处理程序。

WebApiConfig.cs

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // 添加消息处理程序
        config.MessageHandlers.Insert(0, new ServerCompressionHandler(new GZipCompressor(), new DeflateCompressor()));

        // 其他配置...
    }
}

启动文件介绍

• ServerCompressionHandler: 该处理程序用于在服务器端启用 GZip 和 Deflate 压缩。它应该作为第一个消息处理程序插入到请求管道中，以确保在处理请求时首先应用压缩。

3. 项目的配置文件介绍

项目的配置文件主要包括 appveyor.yml 和 Web.config。

appveyor.yml

version: 1.0.{build}
image: Visual Studio 2019
build_script:
  - cmd: dotnet build
test: off
deploy: off

Web.config

<configuration>
  <system.webServer>
    <handlers>
      <add name="ExtensionlessUrlHandler-Integrated-4.0" path="*." verb="*" type="System.Web.Handlers.TransferRequestHandler" preCondition="integratedMode,runtimeVersionv4.0" />
    </handlers>
  </system.webServer>
</configuration>

配置文件介绍

• appveyor.yml: 用于配置 AppVeyor CI 的构建脚本，指定使用 Visual Studio 2019 进行构建。
• Web.config: 配置 ASP.NET Web API 的 HTTP 处理程序，确保正确处理无扩展名的 URL。

通过以上配置，项目能够在服务器端和客户端启用 GZip 和 Deflate 压缩，提升数据传输效率。

Microsoft.AspNet.WebApi.MessageHandlers.Compression Drop-in module for ASP.Net WebAPI that enables GZip and Deflate support 项目地址: https://gitcode.com/gh_mirrors/mi/Microsoft.AspNet.WebApi.MessageHandlers.Compression