[小技巧]ASP.NET Core中如何預壓縮靜態文件

原文地址：Pre-compressed static files with ASP.NET Core
作者：Gunnar Peipman
譯者：Lamond Lu
譯文：https://www.cnblogs.com/lwqlun/p/10552131.html
示例代碼：https://github.com/lamondlu/CompressedStaticFileSample

Web應用程序的優化是非常重要，因為使用更少的CPU,占用更少的帶寬可以減少項目的費用。 在ASP.NET Core中我們可以很容易的啟用響應壓縮，但是針對預壓縮文件，就需要做一些額外的功能了。 這篇博客文章展示了如何在ASP.NET Core中預壓縮靜態文件。

為什么需要預壓縮文件？

雖然在從服務器請求文件時， 我們可以動態壓縮文件，但這意味這Web服務器需要做更多的額外工作。 其實只有在新的應用程序部署時才會更改要壓縮的文件。 越好的壓縮效果需要CPU做的工作就越多。

這個事實讓我們產生一個疑問：是否有可能在不對其進行反復壓縮的情況下提供這些文件？ 幸運的是，這個問題答案是肯定的 - 是的，我們可以在ASP.NET Core中通過擴展靜態文件中間件來做到這一點。

創建預壓縮文件

為了讓整個演示盡量簡單，我們可以使用7-Zip來壓縮磁盤上的靜態文件。 以下是壓縮默認ASP.NET Core MVC應用程序的site.css文件時7-Zip的對話框窗口。

這里你可能注意到我啟用了Ultra壓縮。這顯然不是我們希望在Web服務器上動態壓縮的方法，因為它太消耗CPU了。

正常情況下，這里可以使用Gulp來完成文件捆綁和收縮的功能，本文中暫時不會介紹這個。

提供壓縮文件

這里我參考了Stack Overflow上的一個簡單解決方案（How to gzip static content in ASP.NET Core in a self host environment. ）。它處理了Javascript和CSS文件。

app.UseStaticFiles(new StaticFileOptions
{
    OnPrepareResponse = context =>
    {
        IHeaderDictionary headers = context.Context.Response.Headers;
        string contentType = headers["Content-Type"];
        if (contentType == "application/x-gzip")
        {
            if (context.File.Name.EndsWith("js.gz"))
            {
                contentType = "application/javascript";
            }
            else if (context.File.Name.EndsWith("css.gz"))
            {
                contentType = "text/css";
            }
            headers.Add("Content-Encoding", "gzip");
            headers["Content-Type"] = contentType;
        }
    }
});

當然Javascript和CSS文件並不是唯一需要壓縮的文件類型。所以這里我們不能把contentType寫死。這里我采用了.NET Core Tutorials站點中提供的一個解決方案（ Getting A Mime Type From A File Name In .NET Core）。對我來說這個方案已經足夠簡單。

var provider = new FileExtensionContentTypeProvider();
string contentType;
if (!provider.TryGetContentType(fileName, out contentType))
{
    contentType = "application/octet-stream";
}

這里我把2個方案合並在里一起，產生了最終解決方案。

var mimeTypeProvider = new FileExtensionContentTypeProvider();
 
app.UseStaticFiles(new StaticFileOptions
{
    OnPrepareResponse = context =>
    {
        var headers = context.Context.Response.Headers;
        var contentType = headers["Content-Type"];
 
        if (contentType != "application/x-gzip" && !context.File.Name.EndsWith(".gz"))
        {
            return;
        }
 
        var fileNameToTry = context.File.Name.Substring(0, context.File.Name.Length - 3);
 
        if (mimeTypeProvider.TryGetContentType(fileNameToTry, out var mimeType))
        {
            headers.Add("Content-Encoding", "gzip");
            headers["Content-Type"] = mimeType;
        }
    }
});

至此，使用以上的代碼，本文的主題就被解決了。

針對那些想直接使用現成庫的開發人員，可以使用Nuget直接下載Peter Andersson做好的中間件。

Install-Package CompressedStaticFiles -Version 1.0.4

總結

雖然使用預壓縮文件不是Web開發的主流，但它仍然可以節省CPU和帶寬。 壓縮靜態文件可以作為ASP.NET Core應用程序構建的一個步驟。 盡管ASP.NET Core開箱即不支持預壓縮文件，但我們依然可以通過擴展靜態文件中間件，使其支持預壓縮文件。