.Net Core中間件之靜態(tài)文件(StaticFiles)示例詳解
一、介紹
靜態(tài)文件(static files),諸如 HTML、CSS、圖片和 JavaScript 之類的資源會被 ASP.NET Core 應(yīng)用直接提供給客戶端。
在介紹靜態(tài)文件中間件之前,先介紹 ContentRoot和WebRoot概念。
ContentRoot:指web的項目的文件夾,包括bin和webroot文件夾。
WebRoot:一般指ContentRoot路徑下的wwwroot文件夾。
介紹這個兩個概念是因為靜態(tài)資源文件一般存放在WebRoot路徑下,也就是wwwroot。下面為這兩個路徑的配置,如下所示:
public static void Main(string[] args)
{var host = new WebHostBuilder()
.UseKestrel()
.UseStartup<Startup>()
.UseContentRoot(Directory.GetCurrentDirectory())
.UseWebRoot(Directory.GetCurrentDirectory() + @"\wwwroot\")
.UseEnvironment(EnvironmentName.Development)
.Build();
host.Run();
}
上面的代碼將ContentRoot路徑和WebRoot路徑都配置了,其實只需配置ContentRoot路徑,WebRoot默認(rèn)為ContentRoot路徑下的wwwroot文件夾路徑。
在了解靜態(tài)文件中間件前,還需要了解HTTP中關(guān)于靜態(tài)文件緩存的機制。跟靜態(tài)文件相關(guān)的HTTP頭部主要有Etag和If-None-Match。
下面為訪問靜態(tài)文件服務(wù)器端和客戶端的流程:
1、客戶端第一次向客戶端請求一個靜態(tài)文件。
2、服務(wù)器收到客戶端訪問靜態(tài)文件的請求,服務(wù)器端會根據(jù)靜態(tài)文件最后的修改時間和文件內(nèi)容的長度生成一個Hash值,并將這個值放到請求頭ETag中。
3、客戶端第二次發(fā)起同一個請求時,因為之前請求過此文件,所以本地會有緩存。在請求時會在請求頭中加上If-Nono-Match,其值為服務(wù)器返回的ETag的值。
4、服務(wù)器端比對發(fā)送的來的If-None-Match的值和本地計算的ETag的值是否相同。如果相同,返回304狀態(tài)碼,客戶端繼續(xù)使用本地緩存。如果不相同,返回200狀態(tài)碼,客戶端重新解析服務(wù)器返回的數(shù)據(jù),不使用本地緩存。
具體看下面例子。
二、簡單使用
2.1 最簡單的使用
最簡單的使用就是在Configure中加入下面一句話,然后將靜態(tài)文件放到webRoot的路徑下,我沒有修改webRoot指定的路徑,所以就是wwwroot文件夾。
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseStaticFiles();
app.UseMvc();
}
在wwwroot文件夾下放一個名稱為1.txt的測試文本,然后通過地址訪問。

這種有一個缺點,暴露這個文件的路徑在wwwroot下。
2.2 指定請求地址
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseMvc();
app.UseStaticFiles(new StaticFileOptions()
{
FileProvider = new PhysicalFileProvider(@"C:\Users\Administrator\Desktop"),
RequestPath = new PathString("/Static")
});
//app.UseStaticFiles("/Static");
}
這種指定了靜態(tài)文件存放的路徑為:C:\Users\Administrator\Desktop,不是使用默認(rèn)的wwwroot路徑,就隱藏了文件的真實路徑,并且需要在地址中加上static才能訪問。
當(dāng)然也可以不指明靜態(tài)文件的路徑,只寫請求路徑,如上面代碼中的注釋的例子。這樣靜態(tài)文件就必須存儲到WebRoot對應(yīng)的目錄下了。如果WebRoot的目錄對應(yīng)的是wwwroot,靜態(tài)文件就放到wwwroot文件夾中。

下面通過例子看一下靜態(tài)文件的緩存,如果你想做這個例子,別忘記先清空緩存。

(第一次請求)

(第二次請求 文件相對第一次請求沒有修改的情況)

(第三次請求 文件相對第一次請求有修改的情況)
三、源碼分析
源碼在https://github.com/aspnet/StaticFiles,這個項目還包含有其他中間件。既然是中間件最重要的就是參數(shù)為HttpContext的Invoke方法了,因為每一個請求都要經(jīng)過其處理,然后再交給下一個中間件處理。
下面為處理流程。
public async Task Invoke(HttpContext context)
{
var fileContext = new StaticFileContext(context, _options, _matchUrl, _logger, _fileProvider, _contentTypeProvider);
if (!fileContext.ValidateMethod())//靜態(tài)文件的請求方式只能是Get或者Head
{
_logger.LogRequestMethodNotSupported(context.Request.Method);
} //判斷請求的路徑和配置的請求路徑是否匹配。如請求路徑為http://localhost:5000/static/1.txt //配置為RequestPath = new PathString("/Static") //則匹配,并將文件路徑賦值給StaticFileContext中點的_subPath
else if (!fileContext.ValidatePath())
{
_logger.LogPathMismatch(fileContext.SubPath);
} //通過獲取要訪問文件的擴展名,獲取此文件對應(yīng)的MIME類型, //如果找到文件對應(yīng)的MIME,返回True,并將MIME類型賦值給StaticFileContext中的_contextType //沒有找到返回False.
else if (!fileContext.LookupContentType())
{
_logger.LogFileTypeNotSupported(fileContext.SubPath);
} //判斷訪問的文件是否存在?! ?//如果存在返回True,并根據(jù)文件的最后修改時間和文件的長度,生成Hash值,并將值賦值給_etag,也就是相應(yīng)頭中的Etag?! ?/如果不存在 返回False,進入下一個中間件中處理
else if (!fileContext.LookupFileInfo())
{
_logger.LogFileNotFound(fileContext.SubPath);
}
else
{
fileContext.ComprehendRequestHeaders(); //根據(jù)StaticFileContext中的值,加上對應(yīng)的相應(yīng)頭,并發(fā)送響應(yīng)。具體調(diào)用方法在下面
switch (fileContext.GetPreconditionState())
{
case StaticFileContext.PreconditionState.Unspecified:
case StaticFileContext.PreconditionState.ShouldProcess:
if (fileContext.IsHeadMethod)
{
await fileContext.SendStatusAsync(Constants.Status200Ok);
return;
}
try
{
if (fileContext.IsRangeRequest)
{
await fileContext.SendRangeAsync();
return;
}
await fileContext.SendAsync();
_logger.LogFileServed(fileContext.SubPath, fileContext.PhysicalPath);
return;
}
catch (FileNotFoundException)
{
context.Response.Clear();
}
break;
case StaticFileContext.PreconditionState.NotModified:
_logger.LogPathNotModified(fileContext.SubPath);
await fileContext.SendStatusAsync(Constants.Status304NotModified);
return;
case StaticFileContext.PreconditionState.PreconditionFailed:
_logger.LogPreconditionFailed(fileContext.SubPath);
await fileContext.SendStatusAsync(Constants.Status412PreconditionFailed);
return;
default:
var exception = new NotImplementedException(fileContext.GetPreconditionState().ToString());
Debug.Fail(exception.ToString());
throw exception;
}
} //進入下一個中間件中處理
await _next(context);
}
添加響應(yīng)頭的方法:
public void ApplyResponseHeaders(int statusCode)
{
_response.StatusCode = statusCode;
if (statusCode < 400)
{
if (!string.IsNullOrEmpty(_contentType))
{
_response.ContentType = _contentType;
} //設(shè)置響應(yīng)頭中最后修改時間、ETag和accept-ranges
_responseHeaders.LastModified = _lastModified;
_responseHeaders.ETag = _etag;
_responseHeaders.Headers[HeaderNames.AcceptRanges] = "bytes";
}
if (statusCode == Constants.Status200Ok)
{
_response.ContentLength = _length;
}
_options.OnPrepareResponse(new StaticFileResponseContext()
{
Context = _context,
File = _fileInfo,
});
}
校驗文件是否修改的方法:
public bool LookupFileInfo()
{
_fileInfo = _fileProvider.GetFileInfo(_subPath.Value);
if (_fileInfo.Exists)
{
_length = _fileInfo.Length;
DateTimeOffset last = _fileInfo.LastModified;
_lastModified = new DateTimeOffset(last.Year, last.Month, last.Day, last.Hour, last.Minute, last.Second, last.Offset).ToUniversalTime();
//通過修改時間和文件長度,得到ETag的值
long etagHash = _lastModified.ToFileTime() ^ _length;
_etag = new EntityTagHeaderValue('\"' + Convert.ToString(etagHash, 16) + '\"');
}
return _fileInfo.Exists;
}
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
- ASP.NET Core 應(yīng)用程序中的靜態(tài)文件中間件的實現(xiàn)
- .net core異常中間件的使用
- ASP.NET Core中間件初始化的實現(xiàn)
- 詳解ASP.NET Core 中基于工廠的中間件激活的實現(xiàn)方法
- 在 asp.net core 的中間件中返回具體的頁面的實現(xiàn)方法
- ASP.NET Core自定義中間件如何讀取Request.Body與Response.Body的內(nèi)容詳解
- .net core webapi通過中間件獲取請求和響應(yīng)內(nèi)容的方法
- 利用.net core實現(xiàn)反向代理中間件的方法
- 如何給asp.net core寫個中間件記錄接口耗時
- ASP.NET Core中間件計算Http請求時間示例詳解
- ASP.NET Core應(yīng)用錯誤處理之ExceptionHandlerMiddleware中間件呈現(xiàn)“定制化錯誤頁面”
- .net core靜態(tài)中間件的使用
相關(guān)文章
.NET中利用js讓子窗體向父頁面?zhèn)髦档膶崿F(xiàn)方法
.NET中利用js讓子窗體向父頁面?zhèn)髦档膶崿F(xiàn)方法,需要的朋友可以參考一下2013-02-02
.Net Core WebApi部署到Windows服務(wù)器上的步驟
這篇文章主要介紹了.Net Core WebApi部署到Windows服務(wù)器上的步驟,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-03-03
asp.net中獲取遠程網(wǎng)頁的內(nèi)容之一(downmoon原創(chuàng))
asp.net中獲取遠程網(wǎng)頁的內(nèi)容之一(downmoon原創(chuàng))...2007-04-04
ASP.NET Core Web App應(yīng)用第三方Bootstrap模板的方法教程
這篇文章主要給大家介紹了關(guān)于ASP.NET Core Web App應(yīng)用第三方Bootstrap模板的相關(guān)資料,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起看看吧2018-06-06
Asp.NET 隨機碼生成基類(隨機字母,隨機數(shù)字,隨機字母+數(shù)字)
對于需要用asp.net 字母,隨機數(shù)字,隨機字母+數(shù)字生成隨機碼的朋友用的到2008-11-11
ASP.NET中實現(xiàn)定制自己的委托和事件參數(shù)類
這篇文章主要介紹了ASP.NET中實現(xiàn)定制自己的委托和事件參數(shù)類,需要的朋友可以參考下2014-08-08
SqlCommandBuilder如何實現(xiàn)批量更新
這篇文章主要介紹了SqlCommandBuilder如何實現(xiàn)批量更新,需要的朋友可以參考下2015-10-10
asp.net Urlrewriter在虛擬主機上的使用方法
在網(wǎng)上看到,很多朋友在asp.net中做urlrewrite,用的是HttpHandle Server.Transfer的方法。其實這種方法是錯誤的。2009-12-12

