ASP.NET Core 中的静态文件(知识整理)

布满荆棘的人生 2021-06-26 16:06 533阅读 0赞

# 概念 #

静态文件（如HTML、CSS、图像和JS）是ASP.NET Core应用直接提供给客户端的资产，需要进行一些配置才能提供这些文件。

静态文件存储在项目的web根目录中，默认目录是 `{content root}/wwwroot` ，但是可以通过 `UseWebRoot` 方法修改。

# 使用默认路径 #

新建 `wwwroot` 文件夹，添加images文件夹，添加图片两张，分别为 .net.png 和 vue.png（文件设置为较新则复制）。

![02新建wwwroot文件夹.png][02_wwwroot_.png]

在 Startup.Configure 中使用 `UseStaticFiles` 方法：

public void Configure(IApplicationBuilder app)
    {
        app.UseStaticFiles();
    }

无参数的 UseStaticFiles 方法将 `Web根目录` 中的文件标记为可用，引用方法如下

也可以通过地址栏直接访问

![03访问vue.png.png][03_vue.png.png]

# 使用其他路径 #

*  **wwwroot**
    
     *  **css**
     *  **images**
     *  **js**
 *  **MyStaticFiles**
    
     *  **images**
        
         *  java.png

如果此时想访问 java.png，可以修改设置如下：

app.UseStaticFiles();
    app.UseStaticFiles(new StaticFileOptions
    {
        FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), "MyStaticFiles")),
        RequestPath = "/StaticFiles"
    });

> 两个UseStaticFiles，无参的提供对wwwroot目录中静态文件，第二个通过 “/StaticFiles”浏览 “MyStaticFiles”文件夹下的静态文件

引用方法如下：

也可以通过地址栏访问

![04其他目录.png][04_.png]

# 设置HTTP响应标头 #

`StaticFileOptions` 对象可用于设置HTTP响应标头。除配置从 `Web根目录` 提供静态文件wait，还可以设置 `Cache-Control` 标头

> [HeaderDictionaryExtensions.Append][] 方法存在于 [Microsoft.AspNetCore.Http][] 包中。

app.UseStaticFiles(new StaticFileOptions
    {
        OnPrepareResponse = ctx => {
            // 需要添加引用：using Microsoft.AspNetCore.Http;
            ctx.Context.Response.Headers.Append("Cache-Control", "public, max-age=600");
        }
    });

效果如下：

![05添加缓存.png][05_.png]

# 启用目录浏览 #

通过目录浏览，Web应用的用户可查看目录列表和指定目录中的文件。

> 出于安全考虑，目录浏览默认处于禁用状态

在StartUp.Configure 中的 `UseDirectoryBrowser` 方法来启用目录浏览。

app.UseDirectoryBrowser(new DirectoryBrowserOptions
    {
        FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), "MyStaticFiles", "images")),
        RequestPath = "/Images"
    });

效果如下

![06目录浏览.png][06_.png]

--------------------

# 如何将静态文件注入到项目中 #

在startup.cs文件的Configure方法中写入：

app.UseStaticFiles();

这方法的默认路径是wwwroot目录。

# 如何使用自己的文件路径 #

在startup.cs文件的`Configure`方法中写入：

app.UseStaticFiles(new StaticFileOptions()
    { 
    　　FileProvider = new PhysicalFileProvider(
    　　Path.Combine(Directory.GetCurrentDirectory(), @"MyStaticFiles")),
    　　RequestPath = new PathString("/StaticFiles")
    });

这时候我们知道`FileProvider`是指定路径，`RequestPath`是将对外的路径重写。  
即可用 `StaticFiles`来访问而不是`MyStaticFiles`。  
猜测这样地址重写的意义在于可以隐藏项目的路径结构同时易于访问（类似路由）。

# 如何浏览目录的文件与文件夹 #

在出于安全问题默认情况下是不允许浏览目录的文件和文件夹的，但是如果需要浏览可以用以下方法。

首先要在startup.cs文件的`ConfigureServices`方法中加入：

services.AddDirectoryBrowser();

然后在startup.cs文件的`Configure`方法中写入：

app.UseDirectoryBrowser(new DirectoryBrowserOptions()
    { 
    　　FileProvider = new PhysicalFileProvider(
    　　Path.Combine(Directory.GetCurrentDirectory(), @"wwwroot\images")),
    　　RequestPath = new PathString("/wwwroot/images")
    });

注:.net默认不开放静态文件夹的浏览,出于安全考虑

--------------------

# ASP.NET CORE中配置静态文件 #

## 在Statup.cs文件中的`Configure`中添加下列语句，必须在`app.UseMvc()`之前添加 ##

app.UseStaticFiles(new StaticFileOptions()
    { 
        FileProvider = new PhysicalFileProvider(
            Path.Combine(Directory.GetCurrentDirectory(),"../AiXueXiImage/")),//表示在当前目录的上一级目录下的AiXueXiImage文件夹可以被访问
        RequestPath = new PathString("/MyImages")//设置虚拟目录
    });
    //AiXueXiImage文件夹下有一张图片 hi.png
    //访问方式：http://主机地址:12585/MyImages/hi.ong

[02_wwwroot_.png]: /images/20210626/27d9516aa4134358b1328281321f6811.png
[03_vue.png.png]: /images/20210626/3e11ccb732014145a8a1c4374d77d91e.png
[04_.png]: /images/20210626/2afaa0e063fe4e288415cb4395ae332e.png
[HeaderDictionaryExtensions.Append]: https://docs.microsoft.com/zh-cn/dotnet/api/microsoft.aspnetcore.http.headerdictionaryextensions.append
[Microsoft.AspNetCore.Http]: https://www.nuget.org/packages/Microsoft.AspNetCore.Http/
[05_.png]: /images/20210626/f887c43d277d4c72bacf145cda83ec58.png
[06_.png]: /images/20210626/585fc89c9c1b4400b2399fb3f47594ea.png