ASP.NET Core 中文文档 第三章 原理（3）静态文件处理

原文：Working with Static Files
作者：Rick Anderson
翻译：刘怡(AlexLEWIS)
校对：谢炀(kiler398)、许登洋(Seay)、孟帅洋(书缘)

静态文件（static files），诸如 HTML、CSS、图片和 JavaScript 之类的资源会被 ASP.NET Core 应用直接提供给客户端。

章节：

  • 静态文件服务

  • 静态文件授权

  • 允许直接浏览目录

  • 默认文档服务

  • UseFileServer

  • 非标准的内容类型

  • 扩展资源

静态文件服务

静态文件通常位于 web root（<content-root>/wwwroot）文件夹下。更多有关 Content root 或 Web root 的信息请访问 intro 。你通常会把项目的当前目录设置为 Content root，这样项目的 web root 就可以在开发阶段被明确。

public static void Main(string[] args){var host = new WebHostBuilder().UseKestrel().UseContentRoot(Directory.GetCurrentDirectory()) .UseIISIntegration().UseStartup<Startup>().Build();host.Run();
}

静态文件能够被保存在网站根目录下的任意文件夹内，并通过相对根的路径来访问。比方说，当你通过 Visual Studio 创建一个默认的 Web 应用程序项目，在 wwwroot 目录下会多出几个文件夹：css、images以及 js 文件夹。形如下例的 URL 能够直接访问 images 目录下的图片：

  • http://<app>/images/<imageFileName>

  • http://localhost:9189/images/banner3.svg

为了能够启用静态文件服务，你必须配置中间件（middleware），把静态文件中间件加入到管道内。静态文件中间件能够通过下述方法来配置：在你的项目中增加 Microsoft.AspNetCore.StaticFiles 包依赖，然后从 Startup.Configure 调用 UseStaticFiles 扩展方法：

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory){app.UseStaticFiles(); }

app.UseStaticFiles(); 使得 web root（默认为 wwwroot）下的文件可以被访问。随后我将展示如何通过使用 UseStaticFiles 将其他目录下的内容也向外提供服务。

你必须在 project.json 文件中包含 “Microsoft.AspNetCore.StaticFiles”。

注意
web root 的默认目录是 wwwroot，但你可以通过 UseWebRoot 来设置 web root 。具体可参考 intro 。

假设你有一个有层次结构的项目，你希望其中静态文件的位于 web root 的外部，比如：

  • wwwroot

    • css

    • images

    • ...

  • MyStaticFiles

    • test.png

对于访问 test.png 的请求，可以如此配置静态文件中间件：

复制代码
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory){app.UseStaticFiles();app.UseStaticFiles(new StaticFileOptions()                                    {                                                                              FileProvider = new PhysicalFileProvider(                                   Path.Combine(Directory.GetCurrentDirectory(), @"MyStaticFiles")), RequestPath = new PathString("/StaticFiles")                            });                                
}

在请求 http://<app>/StaticFiles/test.png 时，就能访问到 test.png 文件。

静态文件授权

静态文件模块并 不 提供授权检查。任何通过该模块提供访问的文件，包括位于 wwwroot 下的文件都是公开的。为了给文件提供授权：

  • 将文件保存在 wwwroot 之外并将目录设置为可被静态文件中间件访问到，同时——

  • 通过一个控制器的 Action 来访问它们，通过授权后返回 FileResult

允许直接浏览目录

目录浏览允许网站用户看到指定目录下的目录和文件列表。基于安全考虑，默认情况下是禁用目录访问功能的（参考 注意事项 ）。在 Startup.Configure 中调用 UseDirectoryBrowser 扩展方法可以开启网络应用目录浏览：

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory){app.UseStaticFiles(); // For the wwwroot folderapp.UseStaticFiles(new StaticFileOptions(){FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), @"wwwroot\images")),RequestPath = new PathString("/MyImages")});app.UseDirectoryBrowser(new DirectoryBrowserOptions(){FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), @"wwwroot\images")),RequestPath = new PathString("/MyImages")});
}

并且通过从 Startup.ConfigureServices 调用 AddDirectoryBrowser 扩展方法来增加所需服务。

public void ConfigureServices(IServiceCollection services){services.AddDirectoryBrowser();
}

这段代码允许在访问 http://<app>/MyImages 时可浏览 wwwroot/images 文件夹的目录，其中包括该文件夹下的每一个文件与文件夹：

查看关于开放访问目录时的安全隐患 注意事项 一节。

注意两个 app.UseStaticFiles 调用。第一个调用请求 wwwroot 文件夹下的 CSS、图片和 JavaScript，第二个调用通过 http://<app>/MyImages 请求浏览 wwwroot/images 文件夹的目录

复制代码
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory){app.UseStaticFiles(); // For the wwwroot folder                             app.UseStaticFiles(new StaticFileOptions()                                     {FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), @"wwwroot\images")),RequestPath = new PathString("/MyImages")});app.UseDirectoryBrowser(new DirectoryBrowserOptions(){FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), @"wwwroot\images")),RequestPath = new PathString("/MyImages")});
}

默认文档服务

设置默认首页能给你的站点的每个访问者提供一个起始页。为使站点能提供默认页，避免用户输入完整 URI，须在 Startup.Configure 中调用 UseDefaultFiles 扩展方法：

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

注意
UseDefaultFiles 必须在 UseStaticFiles 之前调用。UseDefaultFiles 只是重写了 URL，而不是真的提供了这样一个文件。你必须开启静态文件中间件（UseStaticFiles）来提供这个文件。

通过 UseDefaultFiles，请求文件夹的时候将检索以下文件：

  • default.htm

  • default.html

  • index.htm

  • index.html

上述列表中第一个被找到的文件将返回给用户（作为该完整 URI 的请求的应答，而此时浏览器 URL 将继续显示用户输入的 URI）。

下述代码展示如何将默认文件名改为 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();
}

UseFileServer

UseFileServer 包含了 UseStaticFiles 、UseDefaultFiles 和 UseDirectoryBrowser 的功能。

下面的代码启用了静态文件和默认文件，但不允许直接访问目录：

app.UseFileServer();

下面的代码启用了静态文件、默认文件和目录浏览功能：

app.UseFileServer(enableDirectoryBrowsing: true);

查看直接提供目录访问时的安全风险注意事项。作为一个集合了 UseStaticFiles、UseDefaultFiles 和 UseDirectoryBrowser 方法于一体的方法，如果你希望提供 web root 之外存在的文件，你要实例化并配置一个 FileServerOptions 对象传递给 UseFileServer 的参数。比方说在你的应用中有如下层次的目录：

  • wwwroot

    • css

    • images

    • ...

  • MyStaticFiles

    • test.png

    • default.html

使用上面这个层次结构的示例，你可能希望启用静态文件、默认文件以及浏览 MyStaticFiles 目录。下面的代码片段演示了调用一次 FileServerOptions 来完整实现这些功能：

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory){app.UseStaticFiles();app.UseFileServer(new FileServerOptions()                                    {                                                                               FileProvider = new PhysicalFileProvider(                                    Path.Combine(Directory.GetCurrentDirectory(), @"MyStaticFiles")),       RequestPath = new PathString("/StaticFiles"),                           EnableDirectoryBrowsing = true                                              });                                                                          
}

如果在你从 Startup.ConfigureServices 请求调用 AddDirectoryBrowser 扩展方法时将 enableDirectoryBrowsing 置为 true，那么：

public void ConfigureServices(IServiceCollection services){services.AddDirectoryBrowser();
}

使用的文件层次结构：

URIResponse
http://<app>/StaticFiles/test.pngStaticFiles/test.png
http://<app>/StaticFilesMyStaticFiles/default.html

如果在 MyStaticFiles 目录下没有默认命名的文件，则 http://<app>/StaticFiles 将返回目录列表，其中包含可供点击的链接：

注意
UseDefaultFiles 和 UseDirectoryBrowser 将会把末尾不带斜杠的 URL http://<app>/StaticFiles 重新定向到 http://<app>/StaticFiles/ （末尾增加了一个斜杠）。如果末尾不带斜杠，文档内相对 URL 会出错。

FileExtensionContentTypeProvider

FileExtensionContentTypeProvider 类内包含一个将文件扩展名映射到 MIME 内容类型的集合。在下面的例子中，多个文件扩展名注册为已知的 MIME 类型，“.rtf”被替换，“.mp4”被移除。

复制代码
public void Configure(IApplicationBuilder app){    // Set up custom content types -associating file extension to MIME type          var provider = new FileExtensionContentTypeProvider();              // Add new mappings                                                            provider.Mappings[".myapp"] = "application/x-msdownload";                   provider.Mappings[".htm3"] = "text/html";                                    provider.Mappings[".image"] = "image/png";                              // Replace an existing mapping                                                  provider.Mappings[".rtf"] = "application/x-msdownload";            // Remove MP4 videos.                                                           provider.Mappings.Remove(".mp4");                                            app.UseStaticFiles(new StaticFileOptions(){FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), @"wwwroot\images")),RequestPath = new PathString("/MyImages"),ContentTypeProvider = provider                                               });app.UseDirectoryBrowser(new DirectoryBrowserOptions(){FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), @"wwwroot\images")),RequestPath = new PathString("/MyImages")});
}

查看 MIME 内容类型。

非标准的内容类型

ASP.NET 静态文件中间件能够支持超过 400 种已知文件内容类型。如果用户请求一个未知的文件类型，静态文件中间件将返回 HTTP 404（未找到）响应。如果启用目录浏览，该文件的链接将会被显示，但 URI 会返回一个 HTTP 404 错误。

下方代码把不能识别的类型和文件作为图片处理。

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory){app.UseStaticFiles(new StaticFileOptions{ServeUnknownFileTypes = true,DefaultContentType = "image/png"});
}

根据上面的代码，未知内容类型的文件请求将返回一张图片。

警告
开启 ServeUnknownFileTypes 存在安全风险，请打消这个念头。FileExtensionContentTypeProvider （下文将解释）提供了更安全的非标准扩展替代。

注意事项

警告
UseDirectoryBrowser 和 UseStaticFiles 可能会泄密。我们推荐你 不要 在生产环境开启目录浏览。要小心哪些被你开启了 UseStaticFiles或 UseDirectoryBrowser 的目录（使得其子目录都可被访问）。我们建议将公开内容放在诸如 <content root>/wwwroot 这样的目录中，远离应用程序视图、配置文件等。

  • 使用 UseDirectoryBrowser 和 UseStaticFiles 暴露的文件的 URL 是否区分大小写以及字符限制受制于底层文件系统。比方说 Windows 是不区分大小写的，但 macOS 和 Linux 则区分大小写。

  • 托管于 IIS 的 ASP.NET Core 应用程序使用 ASP.NET Core 模块向应用程序转发所有请求，包括静态文件。IIS 静态文件处理程序（IIS Static File Handler）不会被使用，因为在 ASP.NET Core 模块处理之前它没有任何机会来处理请求。

  • 以下步骤可移除 IIS 静态文件处理程序（在服务器层级或网站层级上）：

    • 导航到 模块 功能

    • 从列表中选中 StaticFileModule

    • 在 操作 侧边栏中点击 删除

警告
如果 IIS 静态文件处理程序开启 并且 ASP.NET Core 模块（ANCM）没有被正确配置（比方说web.config 没有部署），（也能）将会提供静态文件。

  • 代码文件（包括 C# 和 Razor）应该放在应用程序项目的 web root （默认为 wwwroot）之外的地方。这将确保您创建的应用程序能明确隔离客户端侧和服务器侧源代码，此举能防止服务器侧的代码被泄露。


相关文章：

  • ASP.NET Core 中文文档 第三章 原理（1）应用程序启动

  • ASP.NET Core 中文文档 第三章 原理（2）中间件

原文地址：http://www.cnblogs.com/dotNETCoreSG/p/aspnetcore-3_3-static-files.html

.NET社区新闻，深度好文，微信中搜索dotNET跨平台或扫描二维码关注

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/328825.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

使用IDEA Maven搭建Mybatis环境

使用IDEA Maven搭建Mybatis环境

本文是使用IDEA Maven搭建Mybatis环境 涉及到的搭配环境 JDK1.8 Maven3.6.3 IDEA2019 MySQL数据库 一、Maven介绍 Maven 是一个项目管理工具&#xff0c;可以对 Java 项目进行构建、依赖管理&#xff0c;是一个自动化构建工具。 自动化构建工具&#xff1a;将原材料&…
阅读更多...
常用推荐算法

常用推荐算法

转载自 常用推荐算法在推荐系统简介中&#xff0c;我们给出了推荐系统的一般框架。很明显&#xff0c;推荐方法是整个推荐系统中最核心、最关键的部分&#xff0c;很大程度上决定了推荐系统性能的优劣。目前&#xff0c;主要的推荐方法包括&#xff1a;基于内容推荐、协同过滤…
阅读更多...
不该活着的SqlHelper和DBHelper

不该活着的SqlHelper和DBHelper

前言&#xff1a; 还记得刚学ADO.NET的情景么&#xff1f; 还记得当年是怎么从ADO.NET被忽悠到用SqlHelper的么&#xff1f; 话说从入门到走上工作岗位那些年&#xff0c;我们就一直被纯纯地教导或引导&#xff0c;ADO.NET太原始&#xff0c;得封装成SqlHelper或DBHelper......…
阅读更多...
使用IDEA配置Mybatis-Plus框架

使用IDEA配置Mybatis-Plus框架

使用IDEA配置Mybatis-Plus框架 本文是以使用IDEA配置Mybatis-Plus框架作为简单的讲解。 所涉及到的应用&#xff1a; IDEA2019Mybatis-Plus框架Mysql数据库Maven3.6.3jdk1.8 一、什么是Mybatis-Plus框架&#xff1f; MyBatis-Plus(简称MP)是一个MyBatis的增强工具&#xff…
阅读更多...
css实现一级下拉菜单

css实现一级下拉菜单

涉及到的图片请到这里下载 涉及到的图片请到这里下载 涉及到的图片请到这里下载 html代码 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns"…
阅读更多...
UserCF,基于用户的协同过滤算法

UserCF,基于用户的协同过滤算法

转载自 UserCF,基于用户的协同过滤算法UserCF&#xff1a;User Collaboration Filter&#xff0c;基于用户的协同过滤 算法核心思想&#xff1a;在一个在线推荐系统中&#xff0c;当用户A需要个性化推荐时&#xff0c;可以先找到和他有相似兴趣的其它用户&#xff0c;然后…
阅读更多...
用BenchmarkDotNet给C#程序做性能测试

用BenchmarkDotNet给C#程序做性能测试

BenchmarkDotNet是一个用MIT协议开源的C#程序性能测试的一个库&#xff0c;非常简单易用。 用法 安装NuGet包&#xff0c;BenchmarkDotNet在需要做性能测试的方法前加上属性[Benchmark]。在Main函数调用性能测试var summary BenchmarkRunner.Run<Md5VsSha256>();。 工作…
阅读更多...
ItemCF,基于物品的协同过滤算法

ItemCF,基于物品的协同过滤算法

转载自 ItemCF,基于物品的协同过滤算法ItemCF&#xff1a;Item Collaboration Filter&#xff0c;基于物品的协同过滤 算法核心思想&#xff1a;给用户推荐那些和他们之前喜欢的物品相似的物品。 比如&#xff0c;用户A之前买过《数据挖掘导论》&#xff0c;该算法会根据此行…
阅读更多...
用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档

用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档

Swagger是一个描述RESTful的Web API的规范和框架。如果使用ASP.NET的话&#xff0c;可以用Swashbuckle来自动生成Swagger,具体参考如何使 WebAPI 自动生成漂亮又实用在线API文档。下面详细的介绍一下如何给ASP.NET Core的项目自动生成Swagger的API帮助文档。 创建ASP.NET Core的…
阅读更多...
涨知识 | 100个中国最难读的地名，第一个就折了

涨知识 | 100个中国最难读的地名，第一个就折了

内容来源网络&#xff0c;侵删&#xff01; 1.浙江丽水的丽&#xff0c;不读l&#xff0c;读l。 2.浙江台州、天台的台&#xff0c;不读ti&#xff0c;读tāi。 3.浙江嵊州的嵊&#xff0c;读音为shng。 4.浙江鄞县的鄞&#xff0c;读音为yn&#xff0c;不读jn。 5.浙江乐清的乐…
阅读更多...
JSP 教程

JSP 教程

JSP 教程JSP 教程JSP 简介JSP 开发环境搭建Eclipse JSP/ServletJSP 结构JSP 生命周期JSP 语法JSP 指令JSP 动作元素JSP 隐式对象JSP 客户端请求JSP 服务器响应JSP HTTP 状态码JSP 表单处理JSP 过滤器JSP Cookie 处理JSP SessionJSP 文件上传JSP 日期处理JSP 页面重定向JSP 点击…
阅读更多...
IronPython项目有了新负责人

IronPython项目有了新负责人

运行IronPython项目的社区领导职责已经交给了Alex Earl和Benedikt Eggers。之前的负责人Jeff Hardy自微软在2010年不再积极参与以来一直负责项目的运行。 Jeff Hardy写道&#xff1a; 应该已经相当明显了&#xff0c;IronPython项目有点停滞不前&#xff0c;那主要是我的错&…
阅读更多...
修改Tomcat编码方式的两种方法

修改Tomcat编码方式的两种方法

转载自 修改Tomcat编码方式的两种方法方法一&#xff1a;推荐&#xff0c;不会影响到其它项目 见我的另一篇博客&#xff1a;http://www.cnblogs.com/x_wukong/p/3292664.html 修改方法&#xff1a; 修改tomcat下的conf/server.xml文件&#xff0c;找到Connector标签&#x…
阅读更多...
Microsoft宣布.NET Core支持计划

Microsoft宣布.NET Core支持计划

微软宣布针对.NET Core、ASP.NET Core和Entity Framework Core的支持计划。据来自微软的Lee Coward介绍&#xff0c;公司计划使用一种双管齐下的方法来管理这些系统的发布。该计划回答了微软开源计划背后的其中一个主要问题——开发人员可以在多长时间内依赖微软向这些年轻的项…
阅读更多...
《机器学习项目开发实战》送书活动结果公布

《机器学习项目开发实战》送书活动结果公布

截止到8月8日24&#xff1a;00&#xff0c;本次送书活动 共收到70位同学参与回复&#xff0c;本次很多同学在看到活动的书《机器学习项目开发实践》&#xff0c;自行就到各大网络商店上购买了书&#xff0c;据反馈这个书很不错&#xff0c;小二昨天也收到一本人民邮电出版社的书…
阅读更多...
如何在局域网访问Tomcat项目

如何在局域网访问Tomcat项目

转载自 如何在局域网访问Tomcat项目1 前言有时候因为工作需要&#xff0c;我们需要访问服务器上的项目或是把你的机器上的项目让你的同事访问到&#xff0c;诸如此类的&#xff0c;都涉及到了这个课题&#xff1a;如何在局域网访问Tomcat项目&#xff1f;而tomcat本身是支持局…
阅读更多...
键盘录入一个正整数，把它的各个位上的数字倒着排列形成一个新的整数并输出。 例如：12345 数出54321 78760 输出6787（0省去）

键盘录入一个正整数，把它的各个位上的数字倒着排列形成一个新的整数并输出。 例如：12345 数出54321 78760 输出6787（0省去）

package com.coffn.demos; /*** 4、键盘录入一个正整数&#xff0c;把它的各个位上的数字倒着排列形成一个新的整数并输出。例如&#xff1a;12345 数出54321 78760 输出6787&#xff08;0省去&#xff09;*/ import java.util.Scanner;public class Demo1 {public static vo…
阅读更多...
Entity Framework Core延期及弃用的特性

Entity Framework Core延期及弃用的特性

由于破坏了向后兼容性&#xff0c;Entity Framework的名声相当不光彩&#xff0c;但与Entity Framework Core的完全重写相比就相形见绌了。在本文中&#xff0c;InfoQ将着眼于其中部分主要特性的变化及其影响。 延期及弃用的特性 首先&#xff0c;我们将看下那些EF Core 1.0没有…
阅读更多...
JSP页面EL表达式不解析

JSP页面EL表达式不解析

转载自 JSP页面EL表达式不解析问题是这样&#xff1a;在搭建springMVC环境的时候&#xff0c;笔者写了一个简单的Controller如下&#xff1a;Controller public class HelloController {RequestMapping(value "/hello.do", method RequestMethod.GET)public Strin…
阅读更多...
将字符串String str= “abc god 中国 java“ 反转每个单词 结果： “cba dog 国中

将字符串String str= “abc god 中国 java“ 反转每个单词 结果： “cba dog 国中

/*** String str "abc god 中国 java"&#xff08;较难&#xff09; 反转每个单词结果&#xff1a; "cba dog 国中 avaj"**/ public class Demo2 {public static void main(String[] args) {String str …
阅读更多...
最新文章

Copyright @ 2022~2023