（5）ASP.NET Core2.2 中的靜態文件

1.前言

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

2.設置靜態文件目錄

靜態文件都存儲在Core Web根目錄中。默認目錄是<content_root>/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<Startup>()
.UseWebRoot(Directory.GetCurrentDirectory() + @"\MyStaticFiles\");//更改默認目錄（wwwroot）路徑方法，如果不需要更改，則注釋這段代碼。
}
//需要在Startup.Configure配置靜態文件中間件。默認已配置，所以一般不用手動添加。
public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
       app.UseStaticFiles();
    }
}

在Web主機在構建站點的時候，我們通過UseWebRoot方法把默認訪問靜態文件路徑<content_root>/wwwroot更改為新建的<content_root>/MyStaticFiles文件路徑，再通過Startup.Configure方法配置靜態文件中間件讓其公開可以訪問。通過項目運行，我們可以在瀏覽器地址欄上看到如下表格響應結果：

根目錄	URL上圖片鏈接	更改默認目錄前是否能打開圖片鏈接	更改默認目錄后是否能打開圖片鏈接
<content_root>/wwwroot	https://localhost:5001/images/1.jpg	能	不能
<content_root>/MyStaticFiles	https://localhost:5001/images/2.jpg	不能	能

由上面表格結果，我們可以看到，未更改靜態文件默認訪問目錄前，<content_root>/wwwroot目錄下的靜態文件（HTML、CSS、IMG、JavaScript等）是可以訪問的，而<content_root>/MyStaticFiles下的靜態文件是不可訪問的。但是更改為<content_root>/MyStaticFiles目錄訪問路徑后，<content_root>/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://<server_address>/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://<server_address>/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://<server_address>/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 中的靜態文件