.netcore中的虚拟文件EmbeddedFile

以前一直比较好奇像swagger,cap,skywalking等组件是如何实现引用一个dll即可在网页上展示界面的，难道这么多html,js,css等都是硬编码写死在代码文件中的？后面接触apb里面也有虚拟文件的功能，一直没去深入了解，最近仔细看了一下他们的代码，发现内部其实就是用嵌入式文件(EmbeddedFile)来实现的，在项目中将html,css,js等文件的属性修改为“嵌入的资源”。

 此时编译后的dll就会包含这些数据文件，生成的嵌入式文件命名规则为:项目名称.物理路径1.物理路径2...文件名.扩展名，之后代码中可以通过当前项目的Assembly.GetManifestResourceInfo方法获取到这些文件，通过Assembly.GetManifestResourceNames方法可以获取到所有嵌入式资源

有了以上这些基础，如果我们想对外提供这些嵌入式文件的访问，只需要创建一个中间件，将请求的url转换成嵌入式资源的路径，获取对应的内容返回即可。例如swagger,cap,skywalking等各类组件自带的界面，就是在中间件中硬编码了url和相关嵌入式资源文件的映射关系，拦截到相关url后直接返回嵌入式资源文件，这样发布的组件就只需要dll即可，不再需要其它html,css,js文件了。

除了以上的自己通过中间件实现对嵌入式资源文件的访问外，.netcore中还内置了Microsoft.Extensions.FileProviders.EmbeddedFileProvider文件提供器，在调用UseStaticFiles时可以指定文件提供器，如下示例直接就可以对外提供这些嵌入式文件的访问了

            app.UseStaticFiles(new StaticFileOptions()
            {
                FileProvider = new EmbeddedFileProvider(typeof(Program).Assembly)
            });

 

最后分享一个本人学习时写的一个虚拟文件系统，主要是参考学习了abp,swagger,.netcore的StaticFileMiddleware。其功能主要建立在UseStaticFiles之上，没有另外单独建立自己的中间件了，节约点代码和中间件吧，另外重写了EmbeddedFileProvider类，性能提升在4倍以上。具体使用方法参照VirtualFileSystem的readme

VirtualFileSystem: 虚拟文件系统，可用于支持嵌入式文件 (gitee.com)