注册的StaticFileMiddleware中间件只会处理针对某个具体静态文件的额请求,如果我们向针对某个目录的URL发送HTTP请求(比如“:5000/img/”),得到的将是一个状态为404的响应。不过我们可以通过注册另一个名为DirectoryBrowserMiddleware的中间件来显示请求目录的内容。具体来说,这个中间件会返回一个HTML页面,请求目录下的所有文件将以表格的形式包含在这个页面中。对于我们演示的这个应用来说,我们可以按照如下的方式调用UseDirectoryBrowser方法来注册这个DirectoryBrowserMiddleware中间件。
public class Program { public static void Main() { string contentRoot = Directory.GetCurrentDirectory(); IFileProvider fileProvider = new PhysicalFileProvider( Path.Combine(contentRoot, "doc")); new WebHostBuilder() .UseContentRoot(contentRoot) .UseKestrel() .Configure(app => app .UseStaticFiles() .UseStaticFiles(new StaticFileOptions { FileProvider = fileProvider, RequestPath = "/documents" }) .UseDirectoryBrowser() .UseDirectoryBrowser(new DirectoryBrowserOptions { FileProvider = fileProvider, RequestPath = "/documents" })) .Build() .Run(); } }
当上面这个应用启动之后,如果我们利用浏览器向针对某个目录的URL(比如“:5000/”或者“:5000/img/”),目标目录的内容(包括子目录和文件)将会以下图所示的形式显示在一个表格中。不仅仅如此,子目录和文件均会显示为链接,指向目标目录或者文件的URL。
三、显示默认页面
从安全的角度来讲,利用注册的UseDirectoryBrowser中间件显示一个目录浏览页面会将整个目标目录的接口和所有文件全部暴露出来,所以这个中间件需要根据自身的安全策略谨慎使用。对于针对目录的请求,另一种更为常用的响应策略就是显示一个保存在这个目录下的默认页面。按照约定,作为默认页面的文件一般采用如下四种命名方式:default.htm、default.html、index.htm或者index.html。针对目标目录下默认页面的呈现实现在一个名为DefaultFilesMiddleware的中间件中,我们演示的这个应用可以按照如下的方式调用UseDefaultFiles方法来注册这个中间件。
public class Program { public static void Main() { string contentRoot = Directory.GetCurrentDirectory(); IFileProvider fileProvider = new PhysicalFileProvider(Path.Combine(contentRoot, "doc")); new WebHostBuilder() .UseContentRoot(contentRoot) .UseKestrel() .Configure(app => app .UseDefaultFiles() .UseDefaultFiles(new DefaultFilesOptions{ RequestPath = "/documents", FileProvider = fileProvider, }) .UseStaticFiles() .UseStaticFiles(new StaticFileOptions { FileProvider = fileProvider, RequestPath = "/documents" }) .UseDirectoryBrowser() .UseDirectoryBrowser(new DirectoryBrowserOptions { FileProvider = fileProvider, RequestPath = "/documents" })) .Build() .Run(); } }
现在我们在“~/wwwroot/img/”目录下创建一个名为index.htm的默认页面,现在利用浏览器访问这个目录对应的URL(“:5000/img/”),显示就时这个页面的内容。
我们必须在注册StaticFileMiddleware和DirectoryBrowserMiddleware之前注册DefaultFilesMiddleware,否则它起不了任何作用。由于DirectoryBrowserMiddleware和DefaultFilesMiddleware这两个中间件处理的均是针对目录的请求,如果DirectoryBrowserMiddleware先被注册,那么显示的总是目录的内容。若DefaultFilesMiddleware先被注册,在默认页面不存在情况下回显示目录的内容。至于为什么要先于StaticFileMiddleware之前注册DefaultFilesMiddleware,则是因为后者是通过采用URL重写的方式实现的,也就是说这个中间件会将针对目录的请求改写成针对默认页面的请求,而最终针对默认页面的请求还得依赖StaticFileMiddleware完成。
DefaultFilesMiddleware中间件在默认情况下总是以约定的名称(default.htm、default.html、index.htm或者index.html)在当前请求的目录下定位默认页面。如果我们希望作为默认页面的文件不能按照这样的约定命名(比如readme.htm),我们需要按照如下的方式显式指定默认页面的文件名。
public class Program { public static void Main() { string contentRoot = Directory.GetCurrentDirectory(); IFileProvider fileProvider = new PhysicalFileProvider(Path.Combine(contentRoot, "doc")); DefaultFilesOptions options1 = new DefaultFilesOptions(); DefaultFilesOptions options2 = new DefaultFilesOptions{ RequestPath = "/documents", FileProvider = fileProvider }; options1.DefaultFileNames.Add("readme.htm"); options2.DefaultFileNames.Add("readme.htm"); new WebHostBuilder() .UseContentRoot(contentRoot) .UseKestrel() .Configure(app => app .UseDefaultFiles(options1) .UseDefaultFiles(options2) .UseStaticFiles() .UseStaticFiles(new StaticFileOptions{ FileProvider = fileProvider, RequestPath = "/documents" }) .UseDirectoryBrowser() .UseDirectoryBrowser(new DirectoryBrowserOptions{ FileProvider = fileProvider, RequestPath = "/documents" })) .Build() .Run(); } }
四、映射媒体类型