了解ASP.NET Core 中的文件提供程序

写在前面

ASP.NET Core 通过文件提供程序来抽象化文件系统访问。分为物理文件提供程序(PhysicalFileProvider)和清单嵌入的文件提供程序(ManifestEmbeddedFileProvider)还有复合文件提供程序(CompositeFileProvider )；其中PhysicalFileProvider 提供对物理文件系统的访问，而ManifestEmbeddedFileProvider 用于访问嵌入在程序集中的文件，而 CompositeFileProvider 合并 IFileProvider 实例，以便公开一个接口来处理多个提供程序中的文件，相当于前面两种的混合集。

物理和清单嵌入文件提供程序都实现了IFileProvider 接口，然后通过 IFileProvider.Watch 方法提供一种方法来监视一个或多个文件或目录的更改。

使用时需要通过NuGet安装两个拓展：

代码实现

 本文只提供了 PhysicalFileProvider 的代码示例：

using Microsoft.Extensions.FileProviders;
using Microsoft.Extensions.Primitives;
using System.Text;

var physicalFileProvider = new PhysicalFileProvider(@"E:\softwares");

var manifestEmbeddedProvider = new ManifestEmbeddedFileProvider(typeof(Program).Assembly);

var compositeProvider = new CompositeFileProvider(physicalFileProvider, manifestEmbeddedProvider);

// 通过表达式筛选需要监控的文件或目录（Watch可以使用例如 *.* 进行文件通配）
ChangeToken.OnChange(() => physicalFileProvider.Watch("Test.txt"), async () =>
{
    Console.Clear();
    IFileInfo fileInfo = physicalFileProvider.GetFileInfo("Test.txt");
    await using var stream = fileInfo.CreateReadStream();
    var buffer = new byte[stream.Length];
    await stream.ReadAsync(buffer, 0, buffer.Length);
    Console.WriteLine(Encoding.Default.GetString(buffer));
});

Console.Read();

项目配置 

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net8.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
    <GenerateEmbeddedFilesManifest>true</GenerateEmbeddedFilesManifest>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.Extensions.FileProviders.Composite" Version="8.0.0" />
    <PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" Version="8.0.0" />
    <PackageReference Include="Microsoft.Extensions.FileProviders.Physical" Version="8.0.0" />
  </ItemGroup>

    <ItemGroup>
	    <EmbeddedResource Include="Resource.txt" />
    </ItemGroup>

</Project>

调用示例

在示例中由物理文件提供程序指定的目录中，监控Test.txt文件，当文件内容发生变化时就会将最新的内容打印到控制台。