ASP.NET Core 中的靜態檔案

1.前言

當我們建立Core專案的時候，Web根目錄下會有個wwwroot檔案目錄，wwwroot檔案目錄裡面預設有HTML、CSS、IMG、JavaScript等檔案，而這些檔案都是Core提供給客戶端使用的靜態檔案。但是這些靜態檔案需要在Core裡面配置才可以對外公開訪問。

2.設定靜態檔案目錄

靜態檔案都儲存在Core Web根目錄中。預設目錄是/wwwroot，但可透過 UseWebRoot方法更改訪問目錄。而content_root是指web專案的所有檔案夾，包括bin和wwwroot檔案夾。

2.1 設定預設靜態檔案目錄

如果我們需要更改預設目錄，該如何更改呢？讓我們來看看如下示例，現在有wwwroot預設目錄和新建MyStaticFiles目錄：

然後配置如下程式碼：

public class Program
{
    public static void Main(string[] args)
    {
        CreateWebHostBuilder(args).Build().Run();
    }
    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
            .UseStartup()
.UseWebRoot(Directory.GetCurrentDirectory() + @"\MyStaticFiles\");//更改預設目錄（wwwroot）路徑方法，如果不需要更改，則註釋這段程式碼。
}
//需要在Startup.Configure配置靜態檔案中介軟體。預設已配置，所以一般不用手動新增。
public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
       app.UseStaticFiles();
    }
}

在Web主機在構建站點的時候，我們透過UseWebRoot方法把預設訪問靜態檔案路徑/wwwroot更改為新建的/MyStaticFiles檔案路徑，再透過Startup.Configure方法配置靜態檔案中介軟體讓其公開可以訪問。透過專案執行，我們可以在瀏覽器位址列上看到如下表格響應結果：

根目錄	URL上圖片連結	更改預設目錄前是否能開啟圖片連結	更改預設目錄後是否能開啟圖片連結
/wwwroot	https://localhost:5001/images/1.jpg	能	不能
/MyStaticFiles	https://localhost:5001/images/2.jpg	不能	能

由上面表格結果，我們可以看到，未更改靜態檔案預設訪問目錄前，/wwwroot目錄下的靜態檔案（HTML、CSS、IMG、JavaScript等）是可以訪問的，而/MyStaticFiles下的靜態檔案是不可訪問的。但是更改為/MyStaticFiles目錄訪問路徑後，/wwwroot目錄下的靜態檔案就訪問不到了。下麵我們在來看看如何配置訪問Web根目錄外的檔案。

2.2 設定訪問Web根目錄外的檔案

有時可能因為業務需求原因，為了區分預設靜態檔案，我們想要在Web根目錄下新建一個靜態檔案夾處理業務。該如何配置呢？現在我們來瞭解下。
在2.1節點示例演示的時候，新建了一個MyStaticFiles目錄，現在就拿這個目錄來演示，請按如下方式配置靜態檔案中介軟體：

public void Configure(IApplicationBuilder app)
{
    //設定預設靜態檔案
app.UseStaticFiles(); 
//設定自定義靜態檔案
    app.UseStaticFiles(new StaticFileOptions
    {
        FileProvider = new PhysicalFileProvider(
            Path.Combine(Directory.GetCurrentDirectory(), "MyStaticFiles")),
        RequestPath = "/StaticFiles" //重寫了一個虛擬路徑。
    });
}

由上述程式碼可知，MyStaticFiles目錄透過StaticFiles URI段公開。請求 http:///StaticFiles/images/2.jpg提供 2.jpg 檔案。也就是說在設定自定義靜態檔案中介軟體同時並不影響設定預設靜態檔案中介軟體。

3.設定HTTP響應標頭

Core提供了StaticFileOptions物件可用於設定HTTP響應標頭。除配置從Web根目錄提供靜態檔案外，以下程式碼還設定Cache-Control標頭，例如設定靜態檔案快取時間：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    var cachePeriod = env.IsDevelopment() ? "600" : "604800";
    app.UseStaticFiles(new StaticFileOptions
    {
        OnPrepareResponse = ctx =>
        {
            // Requires the following import:
            // using Microsoft.AspNetCore.Http;
            ctx.Context.Response.Headers.Append("Cache-Control", $"public, max-age={cachePeriod}");//（秒）
        }
    });
}

程式碼中{cachePeriod}是設定瀏覽器快取時間，這裡我們設定為10分鐘（600秒）快取時間：

透過瀏覽器輔助工具可以看到Response Headers設定了快取時間。

4.靜態檔案授權

在之間第四章節，我們提到過，靜態檔案中介軟體一般在身份驗證/授權中介軟體之前設定，所以靜態檔案不需要驗證，但是比如我們需要Controller控制器授權提供檔案資訊，該如何設定？請看如下程式碼：

[Authorize]
public IActionResult BannerImage()
{
    var file = Path.Combine(Directory.GetCurrentDirectory(), 
                            "MyStaticFiles", "images", "banner1.svg");
    return PhysicalFile(file, "image/svg+xml");
}

傳回結果：

 

5.啟用目錄瀏覽

透過目錄瀏覽，Web應用的使用者可檢視目錄串列和指定目錄中的檔案。出於安全考慮，目錄瀏覽預設處於禁用狀態，啟用目錄瀏覽是有風險的。呼叫Startup.Configure中的UseDirectoryBrowser方法來啟用目錄瀏覽：

public void Configure(IApplicationBuilder app)
{
     //第一個呼叫提供wwwroot檔案夾中的靜態檔案。
　　 app.UseStaticFiles(); 
　　 //第二個呼叫使用URL http:///MyImages瀏覽wwwroot/images檔案夾的目錄。
    app.UseStaticFiles(new StaticFileOptions
    {
        FileProvider = new PhysicalFileProvider(
            Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", "images")),
        RequestPath = "/MyImages"
    });
    app.UseDirectoryBrowser(new DirectoryBrowserOptions
    {
        FileProvider = new PhysicalFileProvider(
            Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", "images")),
        RequestPath = "/MyImages"
    });
}

呼叫Startup.ConfigureServices中的AddDirectoryBrowser方法來新增所需服務：

public void ConfigureServices(IServiceCollection services)
{
    services.AddDirectoryBrowser();
}

上述程式碼允許使用URL http:///MyImages瀏覽wwwroot/images檔案夾的目錄，並連結到每個檔案和檔案夾：

6.設定靜態檔案預設檔案

6.1設定預設檔案

在Core設定預設主頁為訪問者訪問網站時提供了起點，這種情況跟IIS上設定站點預設檔案是一樣的。若要在使用者不完全限定URI的情況下提供預設頁面，請呼叫Startup.Configure中的UseDefaultFiles方法：

public void Configure(IApplicationBuilder app)
{
    //要提供預設檔案，必須在UseStaticFiles前呼叫UseDefaultFiles。UseDefaultFiles實際上    //用於重寫URL，不提供檔案。透過UseStaticFiles啟用靜態檔案中介軟體來提供檔案。
    app.UseDefaultFiles();
    app.UseStaticFiles();
}

在wwwroot目錄下新增一個default.html頁面。這裡要註意一點是，新增預設檔名稱一樣要跟IIS上預設檔名稱（default.htm，default.html，index.htm，index.html）都一致，否則如果自定義名稱，會預設開啟路由預設路徑地址。

6.2更改預設檔名稱

6.1小節提到一個點，新增預設檔案都要跟IIS上預設名稱一致，但是如果我們需要自定義預設檔名稱呢？該如何設定？以下程式碼將預設檔案名更改為mydefault.html：

public void Configure(IApplicationBuilder app)
{
    // Serve my app-specific default file, if present.
    DefaultFilesOptions options = new DefaultFilesOptions();
    options.DefaultFileNames.Clear();
    options.DefaultFileNames.Add("mydefault.html");
    app.UseDefaultFiles(options);
    app.UseStaticFiles();
}

7.UseFileServer

Core提供了UseFileServer物件，這個物件集成了UseStaticFiles、UseDefaultFiles和 UseDirectoryBrowser的功能。下麵我們透過程式碼來看看如何使用。
提供靜態檔案和預設檔案。未啟用目錄瀏覽：
app.UseFileServer();
透過啟用目錄瀏覽基於無引數多載進行構建：
app.UseFileServer(enableDirectoryBrowsing: true);
啟用靜態檔案、預設檔案和及 MyStaticFiles 的目錄瀏覽示例程式碼：

public void ConfigureServices(IServiceCollection services)
{
    services.AddDirectoryBrowser();
}
public void Configure(IApplicationBuilder app)
{
    app.UseStaticFiles(); // For the wwwroot folder

    app.UseFileServer(new FileServerOptions
    {
        FileProvider = new PhysicalFileProvider(
            Path.Combine(Directory.GetCurrentDirectory(), "MyStaticFiles")),
        RequestPath = "/StaticFiles",
        EnableDirectoryBrowsing = true
    });
}

響應結果就不截圖多說了，寫那麼久也累了。因為2-6小節也有示例，大家就自行測試吧。

參考文獻：
ASP.NET Core 中的靜態檔案