這篇文章主要為大家詳細介紹了ASP.NET Core靜態檔案的使用教程,具有一定的參考價值,感興趣的小夥伴們可以參考一下
在這一章,我們將學習如何使用檔案。幾乎每個web應用程式都需要一個重要特性:能夠從檔案系統提供檔案(靜態檔案)。
靜態檔案像JavaScript檔案、圖片、CSS檔案等,我們Asp.Net Core應用程式可以直接提供給客戶。
靜態檔案通常位於web根(wwwroot)檔案夾。
預設情況下,這是我們可以直接從檔案系統提供檔案的唯一的地方。
案例
現在讓我們通過一個簡單的樣本來瞭解我們在我們的應用程式如何提供這些靜態檔案。
在這裡,我們想要向我們的 FirstAppDemo 應用程式添加一個簡單的 HTML 檔案,該 HTML 檔案放在web 根 (wwwroot) 檔案夾。在方案總管中按右鍵wwwroot檔案夾並選擇Add→新項。
在中間窗格中,選擇 HTML 頁面並稱之為 index.html,單擊添加按鈕。
你會看到一個簡單的index.html檔案。讓我們在其中添加一些簡單的文本和標題如下所示。
<!DOCTYPE html> <html> <head> <meta charset="utf-8" /> <title>Welcome to ASP.NET Core</title> </head> <body> Hello, Wolrd! this message is from our first static HTML file. </body> </html>
當您運行應用程式並在瀏覽器中輸入index.html時,您將看到app.Run中介軟體將拋出一個異常,因為目前在我們的應用程式中什麼都沒有。
現在我們的項目中沒有中介軟體會去找檔案系統上的任何檔案。
為瞭解決這個問題,通過在方案總管中按右鍵您的項目並選擇管理NuGet包進入到NuGet包管理器。
搜尋 Microsoft.AspNet.StaticFiles,會找到靜態檔案中介軟體。讓我們安裝此 nuget 程式包,現在我們可以在Configure方法中註冊中介軟體。
讓我們在下面的程式中所示的Configure方法中添加 UseStaticFiles 中介軟體。
using Microsoft.AspNet.Builder; using Microsoft.AspNet.Hosting; using Microsoft.AspNet.Http; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Configuration; namespace FirstAppDemo { public class Startup { public Startup() { var builder = new ConfigurationBuilder() .AddJsonFile("AppSettings.json"); Configuration = builder.Build(); } public IConfiguration Configuration { get; set; } // This method gets called by the runtime. // Use this method to add services to the container. // For more information on how to configure your application, // visit http://go.microsoft.com/fwlink/?LinkID=398940 public void ConfigureServices(IServiceCollection services) { } // This method gets called by the runtime. // Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app) { app.UseIISPlatformHandler(); app.UseDeveloperExceptionPage(); app.UseRuntimeInfoPage(); app.UseStaticFiles(); app.Run(async (context) => { throw new System.Exception("Throw Exception"); var msg = Configuration["message"]; await context.Response.WriteAsync(msg); }); } // Entry point for the application. public static void Main(string[] args) => WebApplication.Run<Startup>(args); } }
除非你通過傳入一些不同的配置參數來覆蓋選項,否則靜態檔案會對於一個給定的請求看作是請求路徑。這個請求路徑是相對於檔案系統。
如果靜態檔案根據url找到一個檔案,它將直接返回該檔案,而不調用下一個塊中介軟體。
如果沒有找到匹配的檔案,那麼它會繼續執行下一個塊中介軟體。
讓我們儲存Startup.cs檔案並重新整理瀏覽器。
你現在可以看到index.html檔案。你放置在wwwroot檔案夾下任何地方的任何JavaScript檔案、CSS檔案或者HTML檔案,您都能夠在Asp.Net Core中直接當靜態檔案使用。
在如果你想 讓index.html作為您的預設檔案,IIS一直有這種功能。
你可以給 IIS 一個預設檔案清單。如果有人訪問根目錄,在這種情況下,如果 IIS 找到命名為 index.html的檔案,它就會自動將該檔案返回給用戶端。
讓我們現在開始進行少量更改。首先,我們需要刪除強制的錯誤,然後添加另一塊的中介軟體,這就是 UseDefaultFiles。以下是配置方法的實現。
/ This method gets called by the runtime. // Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app) { app.UseIISPlatformHandler(); app.UseDeveloperExceptionPage(); app.UseRuntimeInfoPage(); app.UseDefaultFiles(); app.UseStaticFiles(); app.Run(async (context) => { var msg = Configuration["message"]; await context.Response.WriteAsync(msg); }); }
這段中介軟體將監聽傳入的請求,如果請求是根目錄,就查看是否有匹配的預設檔案。
您可以覆蓋這個中介軟體的選項來告訴它如何匹配預設檔案,但index.html是預設情況下的一個預設的檔案。
讓我們儲存 Startup.cs 檔案並將您的瀏覽器轉到 web 應用程式的根目錄。
你現在可以看到index.html是預設檔案。你安裝中介軟體的順序是很重要的,因為如果你將UseDefaultFiles放置在UseStaticFiles之後,你將可能不會得到相同的結果。
如果你想要使用UseDefaultFiles和UseStaticFiles中介軟體,你可以使用另一個中介軟體Microsoft.aspnet.staticfiles,它也是NuGet包,它是一個伺服器中介軟體。這本質上是以正確的順序包含了預設檔案和靜態檔案。
// This method gets called by the runtime. // Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app) { app.UseIISPlatformHandler(); app.UseDeveloperExceptionPage(); app.UseRuntimeInfoPage(); app. UseFileServer(); app.Run(async (context) => { var msg = Configuration["message"]; await context.Response.WriteAsync(msg); }); }
讓我們再一次儲存 Startup.cs 檔案。一旦你重新整理瀏覽器,你將看到相同的結果,如下面的螢幕快照所示。