由ASP.NET Core根据路径下载文件异常引发的探究

优质资源分享

学习路线指引（点击解锁）	知识定位	人群定位
Python实战微信订餐小程序	进阶级	本课程是python flask+微信小程序的完美结合，从项目搭建到腾讯云部署上线，打造一个全栈订餐系统。
Python量化交易实战	入门级	手把手带你打造一个易扩展、更安全、效率更高的量化交易系统

前言

最近在开发新的项目，使用的是ASP.NET Core6.0版本的框架。由于项目中存在文件下载功能，没有使用类似MinIO或OSS之类的分布式文件系统，而是下载本地文件，也就是根据本地文件路径进行下载。这其中遇到了一个问题，是关于如何提供文件路径的，通过本文记录一下相关总结，希望能帮助更多的同学避免这个问题。

使用方式

由于我们的系统没有公司内部使用的也没有做负载均衡之类的，所以文件是存储在当前服务器中的，所以我们直接使用文件绝对路径的方式来进行下载的，使用的是ASP.NET Core自带的File方法，使用的是如下方法(实际上文件的路径是存储在数据库中的)

[HttpGet]
[Produces("application/msword", Type = typeof(FileResult))]
public FileResult Virtual()
{
    // AppContext.BaseDirectory用来获取当前执行程序的基目录
    // 结果为绝对路径,比如 D:\CodeProject\MyTest.WebApi\bin\Debug\net6.0\
    var filePath = Path.Combine(AppContext.BaseDirectory, "files/疫情防控规范说明.docx");
    return File(filePath, "application/msword", "疫情防控规范说明.docx");
}

这是比较常用的方式没太在意会有什么问题，不过，等自测的时候发现报了一个System.InvalidOperationException异常，大致内容如下所示

 System.InvalidOperationException: No file provider has been configured to process the supplied file.
         at Microsoft.AspNetCore.Mvc.Infrastructure.VirtualFileResultExecutor.GetFileInformation(VirtualFileResult result, IWebHostEnvironment hostingEnvironment)
         at Microsoft.AspNetCore.Mvc.Infrastructure.VirtualFileResultExecutor.ExecuteAsync(ActionContext context, VirtualFileResult result)
         at Microsoft.AspNetCore.Mvc.VirtualFileResult.ExecuteResultAsync(ActionContext context)

看异常内容问题是出在VirtualFileResultExecutor.GetFileInformation()方法，它的意思大概是没有提供文件提供来处理文件，对于文件提供程序如果了解过ASP.NET Core静态文件相关的话应该是了解这个的。如果想访问ASP.NET Core中的静态文件，默认是不可以直接访问的，这也是一种安全机制，想使用的话必须开启静态文件访问机制，且默认的静态文件要存储在wwwroot路径下。如果想在其它路径提供静态文件则必须要提供文件处理程序，我们常用的方式则是

var fileProvider = new PhysicalFileProvider($"{env.ContentRootPath}/staticfiles");
app.UseStaticFiles(new StaticFileOptions {
    RequestPath="/staticfiles",
    FileProvider = fileProvider
});

同样的在这里我们也需要提供IFileProvider实例，因为我们是使用的本地文件系统，所以要提供PhysicalFileProvider实例，通过下面方法解决了这个问题

[HttpGet]
[Produces("application/msword", Type = typeof(FileResult))]
public FileResult Virtual()
{
    var filePath = "files/疫情防控规范说明.docx";
    return new VirtualFileResult(filePath, "application/msword")
    {
        // 提供指定目录的文件访问程序
        FileProvider = new PhysicalFileProvider(AppContext.BaseDirectory),
        FileDownloadName = "疫情防控规范说明.docx"
    };
}

亦或者是通过原始的方式，比如读取文件的Stream或者byte[]的方式

[HttpGet]
[Produces("application/msword", Type = typeof(FileResult))]
public FileResult Virtual()
{
    //读取byte[]方式
    var filePath = Path.Combine(AppContext.BaseDirectory, @"files\疫情防控规范说明.docx");
    var fileBytes = System.IO.File.ReadAllBytes(filePath);
    return File(fileBytes, "application/msword", "疫情防控规范说明.docx");

    //读取Stream的方式
    //var filePath = Path.Combine(AppContext.BaseDirectory, @"files\疫情防控规范说明.docx");
    //var fileStream = System.IO.File.OpenRead(filePath);
    //return File(fileStream, "application/msword", "疫情防控规范说明.docx");
}

通过这些方式虽然可以解决问题，但是看起来不是很优雅，而且如果提供不同路径的文件还得要有许多的PhysicalFileProvider实例，或者自己封装方法去解决问题。
当时就想微软不至于连读取自定义物理路径的方法都不提供吧，于是就在ControllerBase基类中查找相关方法，终于看到了一个叫PhysicalFile的方法，看名字就知道是提供物理文件用的，不知道行不行写代码试