ASP.NET Core - 静态文件

在本章中，我们将学习如何使用文件。几乎每个 Web 应用程序都需要的一个重要功能是能够从文件系统提供文件（静态文件）。

文件系统上的静态文件（例如 JavaScript 文件、图像、CSS 文件）是 ASP.NET Core 应用程序可以直接向客户端提供服务的资产。
静态文件通常位于 Web 根 (wwwroot) 文件夹中。
默认情况下，这是我们可以直接从文件系统提供文件的唯一位置。

例子

现在让我们举一个简单的例子，我们将了解如何在应用程序中提供这些文件。

在这里，我们想要向 FirstAppDemo 应用程序添加一个简单的 HTML 文件，并且该 HTML 文件必须进入 Web 根 (wwwroot) 文件夹。右键单击解决方案资源管理器中的 wwwroot 文件夹，然后选择添加 → 新项目。

在中间窗格中，选择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方法中添加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); 
   } 
}

除非您覆盖选项并传入一些不同的配置参数，否则静态文件对于给定的请求所做的就是查看请求路径。然后将该请求路径与文件系统以及文件系统上的内容进行比较。

如果静态文件看到它可以使用的文件，它将提供该文件而不调用下一个中间件。
如果没有找到匹配的文件，那么它将继续处理下一个中间件。

让我们保存Startup.cs文件并刷新您的浏览器。

您现在可以看到index.html 文件。您在 wwwroot 内的任何位置放置的任何内容 - 任何 JavaScript 文件、CSS 文件或 HTML 文件，您都可以提供它们。

现在，如果您希望index.html成为您的默认文件，这是IIS一直具有的功能。
您始终可以向 IIS 提供要查找的默认文件列表。如果有人访问目录的根目录，或者在本例中访问网站的根目录，并且 IIS 发现名为 index.html 的内容，它就会自动提供该文件。
现在让我们开始做一些改变。首先，我们需要删除强制错误，然后添加另一个中间件，即UseDefaultFiles。下面是Configure方法的实现。

// 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 是您的默认文件。安装中间件的顺序很重要，因为如果在 UseStaticFiles 之后使用 UseDefaultFiles，则不会得到相同的结果。

如果要使用 UseDefaultFiles 和 UseStaticFiles，您可能还需要 Microsoft.aspnet.staticfiles NuGet 包中的另一个中间件，即 FileServer中间件。这本质上包括按正确顺序排列的默认文件和静态文件。

// 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文件。刷新浏览器后，您将看到与以下屏幕截图所示相同的结果。