Asp.Net Core 中的“虛擬目錄”
寫在前面
現在部署Asp.Net Core應用已經不再限制於Windows的IIS上，更多的是Docker容器、各種反向代理來部署。也有少部分用IIS部署的，IIS部署確實是又快又簡單，圖形化操作三下五除二就可以釋出好一個系統了。在過去Asp.Net MVC 專案部署的時候，還常常使用IIS一個功能——虛擬目錄。
虛擬目錄可以直接定位到非專案的其他路徑，將路徑作為網站的一部分，可實現上傳檔案儲存到其他碟符或間接的使用專案以外的靜態檔案。在Asp.Net MVC中從虛擬路徑中存取檔案也很簡單，如 Server.MapPath("~/Upload/liohuang.jpg");
但在Asp.Net Core上不同，它被抽象出一個“檔案系統”，也就是FileProvider。FileProvider是對所有實現了IFileProvider介面的所有型別以及對應物件的統稱，在Artech蔣老師的《.NET Core的檔案系統[2]：FileProvider是個什麼東西？》文章中已經透析了，這裡不在羅裡吧嗦了。
這篇文章要解決的內容是：Asp.Net Core應用中，如何優雅的使用“虛擬目錄”。
實操
首先，新建一個.Net Core WebApi空專案部署在D盤，“虛擬目錄”假設物理路徑在F盤，分別建立三個測試目錄： F:/test1 、 F:/test2 和 F:/test3 ，目錄裡分別存放對應的檔案 1/2/3.jpg 和 mybook.txt 。
讀取虛擬目錄檔案
在 Startup.ConfigureServices 注入 IFileProvider ：
services.AddSingleton<IFileProvider>(new PhysicalFileProvider("F:\\test1"));
新建一個控制器，讀取 mybook.txt 中的內容：
[ApiController]
[Route("[controller]/[action]")]
public class LioHuangController : ControllerBase
{
[HttpGet]
public object GetFiles([FromServices]IFileProvider fileProvider)
{
var file = fileProvider.GetFileInfo("mybook.txt");
if (file.Exists)
{
return ReadTxtContent(file.PhysicalPath);
}
return 0;
}
/// <summary>
/// 讀取文字 （原文地址：https://www.cnblogs.com/EminemJK/p/13362368.html）
/// </summary>
private string ReadTxtContent(string Path)
{
if (!System.IO.File.Exists(Path))
{
return "Not found!";
}
using (StreamReader sr = new StreamReader(Path, Encoding.UTF8))
{
StringBuilder sb = new StringBuilder();
string content;
while ((content = sr.ReadLine()) != null)
{
sb.Append(content);
}
return sb.ToString();
}
}
}訪問介面，介面讀取檔案之後，返回內容：
IFileProvider 介面採用目錄來組織檔案，並統一使用 IFileInfo 介面來表示， PhysicalPath 表示檔案的物理路徑。
public interface IFileInfo
{
bool Exists { get; }
bool IsDirectory { get; }
DateTimeOffset LastModified { get; }
string Name { get; }
string PhysicalPath { get; }
Stream CreateReadStream();
}
如多個虛擬目錄，怎麼處理？簡單，注入多個 IFileProvider 即可，
services.AddSingleton<IFileProvider>(new PhysicalFileProvider("F:\\test1"));
services.AddSingleton<IFileProvider>(new PhysicalFileProvider("F:\\test2"));
services.AddSingleton<IFileProvider>(new PhysicalFileProvider("F:\\test3"));
程式碼修改為：
public object GetFiles([FromServices] IEnumerable<IFileProvider> fileProviders)
IEnumerable<IFileProvider> fileProviders 介面陣列將會有三個，按注入的順序對應不同的目錄。當然，注入 IFileProvider 的時候，就可以封裝一層了，下面再講。
另外，有的說直接 ReadTxtContent("F:\test1\mybook.txt"); 不香嗎？香，Asp.Net Core的訪問許可權要比Asp.Net MVC之前老版本專案要高許多，確實是可以直接讀取專案以外的檔案，但是並不適合直接去訪問，除非說你只有一個地方使用到，那麼就可以直接讀取，但靜態的檔案的訪問，就訪問不到了，僅僅是後臺讀取而已。所以統一使用 IFileProvider 來約束，程式碼的可維護性要高許多。
靜態檔案訪問
在Startup.Configure設定靜態檔案目錄，即可：
app.UseStaticFiles(new StaticFileOptions()
{
FileProvider = new PhysicalFileProvider("F:\\test1"),
RequestPath = "/test"
});;
app.UseStaticFiles(new StaticFileOptions()
{
FileProvider = new PhysicalFileProvider("F:\\test2"),
RequestPath = "/test"
});
app.UseStaticFiles(new StaticFileOptions()
{
FileProvider = new PhysicalFileProvider("F:\\test3"),
RequestPath = "/test"
});
FileProvider 同上面所說的，設定好物理路徑的根目錄， RequestPath 則是訪問路徑的字首，必須是斜杆 “/” 開頭，訪問地址字首則為： https://localhost:5001/test/ 。設定好之後，就可以訪問專案以外的路徑了。
如在IIS部署的時候 ，可以直接忽略IIS中的虛擬目錄設定，完完全全可以通過注入的配置來設定達到“虛擬目錄”的效果。
簡化配置
為了方便達到真實專案中可以直接使用，那麼就要設定為可配置的：
在 appsettings.json 中設定：
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information"
}
},
"AllowedHosts": "*",
"VirtualPath": [
{
"RealPath": "F:\\test1", //真實路徑
"RequestPath": "/test",
"Alias": "first"
},
{
"RealPath": "F:\\test2", //真實路徑
"RequestPath": "/test",
"Alias": "second"
},
{
"RealPath": "F:\\test3", //真實路徑
"RequestPath": "/test",
"Alias": "third"
}
]
}
建立對應的實體對映：
public class VirtualPathConfig
{
public List<PathContent> VirtualPath { get; set; }
}
public class PathContent
{
public string RealPath { get; set; }
public string RequestPath { get; set; }
public string Alias { get; set; }
}
在 PhysicalFileProvider 上封裝一層，加入別名便於獲取：
public class MyFileProvider : PhysicalFileProvider
{
public MyFileProvider(string root, string alias) : base(root)
{
this.Alias = alias;
}
public MyFileProvider(string root, Microsoft.Extensions.FileProviders.Physical.ExclusionFilters filters, string alias) : base(root, filters)
{
this.Alias = alias;
}
/// <summary>
/// 別名
/// </summary>
public string Alias { get; set; }
}
調整 Startup.ConfigureServices 和 Startup.Configure ：
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.Configure<VirtualPathConfig>(Configuration);
var config = Configuration.Get<VirtualPathConfig>().VirtualPath;
config.ForEach(f =>
{
services.AddSingleton(new MyFileProvider(f.RealPath,f.Alias));
});
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
var config = Configuration.Get<VirtualPathConfig>().VirtualPath;
config.ForEach(f =>
{
app.UseStaticFiles(new StaticFileOptions()
{
FileProvider = new PhysicalFileProvider(f.RealPath),
RequestPath =f.RequestPath
});
});
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
}
最後，調整呼叫方式，即可。
[HttpGet]
public object GetFiles([FromServices] IEnumerable<MyFileProvider> fileProviders)
{
var file = fileProviders.FirstOrDefault(x=>x.Alias=="first").GetFileInfo("mybook.txt");
if (file.Exists)
{
return ReadTxtContent(file.PhysicalPath);
}
return 0;
}
最後
物理檔案系統的抽象通過 PhysicalFileProvider 這個 FileProvider 來實現，藉助 IFileProvider 的特點，其實可以擴充套件實現輕量“雲盤”的功能了，而不僅僅只是實現IIS虛擬目錄功能。搞定，今晚不加班！
本文同步在DotNetGeek（ID:dotNetGeek）公眾號釋出