利用 ActionFilter 为 ASP.NET Web API 添加 GZip 压缩功能

最新推荐文章于 2024-06-30 08:11:49 发布

sqlchen

最新推荐文章于 2024-06-30 08:11:49 发布

阅读量1.6k

点赞数

文章标签： web api gzip

本文介绍了一个自定义的WebAPI压缩属性，通过Deflate压缩算法减少响应数据大小，提高传输效率。该实现支持根据客户端请求自动判断是否启用压缩，并提供了一个示例控制器用于演示。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

直接上代码

public class DeflateCompressionAttribute : ActionFilterAttribute
{
   public override void OnActionExecuted(HttpActionExecutedContext actContext)
   {
       var contentType = actContext.Response.Content.Headers.ContentType.ToString();
       var content = actContext.Response.Content;
       var bytes = content == null ? null : content.ReadAsByteArrayAsync().Result;
       var zlibbedContent = bytes == null ? new byte[0] : 
       CompressionHelper.DeflateByte(bytes);
       actContext.Response.Content = new ByteArrayContent(zlibbedContent);
       actContext.Response.Content.Headers.Remove("Content-Type");
       actContext.Response.Content.Headers.Add("Content-encoding", "deflate");
       actContext.Response.Content.Headers.Add("Content-Type", contentType);
       base.OnActionExecuted(actContext);
    }
}

public class CompressionHelper
{ 
    public static byte[] DeflateByte(byte[] str)
    {
        if (str == null)
        {
            return null;
        }

        using (var output = new MemoryStream())
        {
            using (var compressor = new Ionic.Zlib.DeflateStream(output, Ionic.Zlib.CompressionMode.Compress, Ionic.Zlib.CompressionLevel.BestSpeed))
            {
                compressor.Write(str, 0, str.Length);
            }

            return output.ToArray();
        }
    }
}

使用 DeflateCompression 来标记需要压缩的 Web API

public class V1Controller : ApiController
{
    [DeflateCompression]
    public HttpResponseMessage GetCustomers()
    {

    }
}

备注

增加对 Request 中 Accept-Encoding 设定的判断，如果客户端请求包含压缩请求才进行压缩
示例利用了第三方库来进行，可以视情况来自定义替换为其他库