摘要：NET应用程序的的嵌入文件（Embedded Files）功能允许将外部文件（如配置文件、图像等）直接嵌入到程序集（.exe 或 .dll）中。这样可以简化部署过程，避免文件丢失或篡改，提升安全性和性能，同时减少路径和依赖管理的麻烦。通过嵌入资源，程序可以更方
NET应用程序的的嵌入文件（Embedded Files）功能允许将外部文件（如配置文件、图像等）直接嵌入到程序集（.exe 或 .dll）中。这样可以简化部署过程，避免文件丢失或篡改，提升安全性和性能，同时减少路径和依赖管理的麻烦。通过嵌入资源，程序可以更方便地访问这些文件，且无需额外的文件操作。
我们在MyModule.csproj中将Volo\Abp\MyModule\Localization\*.json文件嵌入到程序集中.Sdk="Microsoft.NET.Sdk">net9.0
Exe
enable
Include="Microsoft.Extensions.Hosting"Version="9.0.0" />
Include="Volo.Abp.VirtualFileSystem"Version="9.0.0" />
Remove="Volo\Abp\MyModule\Localization\*.json" />
Include
如果我们在IDE中查看en.json文件, 我们会看到它已经被嵌入到程序集中了.
{
publicstaticasyncTaskintMain(string args)
{
varembeddedFiles =typeof(Program).Assembly.GetManifestResourceNames;
foreach(varembeddedFileinembeddedFiles)
{
Console.WriteLine(embeddedFile);
varfileStream =typeof(Program).Assembly.GetManifestResourceStream(embeddedFile);
if(fileStream != )
{
usingvarreader =newSystem.IO.StreamReader(fileStream);
varcontent =awaitreader.ReadToEndAsync;
Console.WriteLine(content);
}
}
}
}
上述代码会输出嵌入的文件名和内容.
MyModule.Volo.Abp.MyModule.Localization.en.json{
"key":"value"
}
ABP虚拟文件系统可以管理那些物理上并不存在于文件系统（磁盘）上的文件。它主要用于将（js、css、图片……）文件嵌入到程序集，并在运行时像使用物理文件一样使用它们。
下面的代码展示了添加当前应用程序集的嵌入文件到ABP虚拟文件系统.
[DependsOn(typeof(AbpVirtualFileSystemModule))]publicclassMyModule:AbpModule
{
publicoverridevoidConfigureServices(ServiceConfigurationContext context)
{
Configure(options =>
{
options.FileSets.AddEmbedded;
});
}
}
ABP会创建一个AbpEmbeddedFileProvider来访问嵌入的文件.MyModule.Volo.Abp.MyModule.Localization.en.json, 它没有目录信息, ABP会使用.来分割和假定目录信息. 最终会在虚拟文件系统中生成如下的目录结构.[Dir] [/MyModule]
[Dir] [/MyModule/Volo]
[Dir] [/MyModule/Volo/Abp]
[Dir] [/MyModule/Volo/Abp/MyModule]
[Dir] [/MyModule/Volo/Abp/MyModule/Localization]
[File] [/MyModule/Volo/Abp/MyModule/Localization/en.json]
现在你可以注入IVirtualFileProvider来根据上面的目录/文件来访问嵌入的文件.你应该已经注意到, 使用来分割和假定目录信息, 如果文件名中包含.的话, 会导致目录结构混乱.比如你的文件名称是zh.Hans.json, 那么ABP会生成如下的目录结构, 这显然不是我们想要的.[Dir] [/MyModule]
[Dir] [/MyModule/Volo]
[Dir] [/MyModule/Volo/Abp]
[Dir] [/MyModule/Volo/Abp/MyModule]
[Dir] [/MyModule/Volo/Abp/MyModule/Localization]
[Dir] [/MyModule/Volo/Abp/MyModule/Localization/zh]
[File] [/MyModule/Volo/Abp/MyModule/Localization/zh/hans.json]
微软提供了
Microsoft.Extensions.FileProviders.Manifest类库来解决这个问题.我们需要在项目中添加这个包的依赖并设置
trueSdk="Microsoft.NET.Sdk">net9.0
Exe
enable
true
Include="Microsoft.Extensions.Hosting"Version="9.0.0" />
Include="Volo.Abp.VirtualFileSystem"Version="9.0.0" />
Include="Microsoft.Extensions.FileProviders.Manifest"Version="9.0.0" />
Remove="Volo\Abp\MyModule\Localization\*.json" />
Include
重新构建项目, 我们反编译的MyModule.dll文件, 会看到会多一个Microsoft.Extensions.FileProviders.Embedded.Manifest.xml文件.
1.0
Name="Microsoft.Extensions.FileProviders.Embedded.Manifest.xml">
Microsoft.Extensions.FileProviders.Embedded.Manifest.xml
Name="Volo">
Name="Abp">
Name="MyModule">
Name="Localization">
Name="zh.hans.json">
MyModule.Volo.Abp.MyModule.Localization.zh.hans.json
baseNamespace
它只有在你没有使用Manifest Embedded File Provider且您的根命名空间不为空时才需要。在这种情况下，请在这里设置您的根命名空间。
baseNamespace 只有在没有使用Manifest Embedded File Provider时才有效.默认情况下，根命名空间就是你的项目名称。你可以在csproj文件里修改它，或者把它设置为空。Sdk="Microsoft.NET.Sdk">MyModule
Sdk
Configure(options =>
{
options.FileSets.AddEmbedded(baseNamespace: "MyModule");
});
[Dir] [/Volo]
[Dir] [/Volo/Abp]
[Dir] [/Volo/Abp/MyModule]
[Dir] [/Volo/Abp/MyModule/Localization]
[File] [/Volo/Abp/MyModule/Localization/en.json]
baseFolder
如果你不想公开项目中所有嵌入的文件，只想公开特定文件夹（及其子文件夹/文件），那么你可以设置相对于项目根文件夹的基准文件夹。
baseFolder 只有在使用时才有效.你可以设置baseFolder参数为, 那么最终的目录结构如下:Configure(options =>{
options.FileSets.AddEmbedded(baseFolder: "/Volo/Abp/MyModule");
});
[Dir] [Localization]
[File] [Localization/en.json]
我们推荐你在你的项目和类库中使用来结合ABP虚拟文件系统来管理嵌入的文件. 希望这篇文章对你有所帮助.
ABP Virtual File System
Manifest Embedded File Provider
https://learn.microsoft.com/en-us/aspnet/core/fundamentals/file-providers#manifest-embedded-file-provider
来源：opendotnet
