ASP.NET在绑定中使用嵌入式资源

Question

我正在尝试实现一种通用方法，为我的web解决方案中的不同程序集提供使用嵌入式资源中的嵌入式JavaScript和CSS文件的可能性。这篇博客文章展示了一种使用VirtualPathProvider的技术。这很好，但VirtualPathProvider需要包含在每个包含嵌入式资源的程序集中。

我试图从博客文章中增强VirtualPathProvider，这样就可以将程序集传递到它中，并从它的程序集中加载资源：

public EmbeddedVirtualPathProvider(VirtualPathProvider previous, Assembly assembly)
{
    this.previous = previous;
    this.assembly = assembly;
}

初始化时，它从传递的程序集中读取所有嵌入的资源：

protected override void Initialize()
{
    base.Initialize();
    this.assemblyResourceNames = this.assembly.GetManifestResourceNames();
    this.assemblyName = this.assembly.GetName().Name;
}

GetFile从传递的程序集中读取内容：

public override VirtualFile GetFile(string virtualPath)
{
    if (IsEmbeddedPath(virtualPath))
    {
        if (virtualPath.StartsWith("~", System.StringComparison.OrdinalIgnoreCase))
        {
            virtualPath = virtualPath.Substring(1);
        }
        if (!virtualPath.StartsWith("/", System.StringComparison.OrdinalIgnoreCase))
        {
            virtualPath = string.Concat("/", virtualPath);
        }
        var resourceName = string.Concat(this.assembly.GetName().Name, virtualPath.Replace("/", "."));
        var stream = this.assembly.GetManifestResourceStream(resourceName);
        if (stream != null)
        {
            return new EmbeddedVirtualFile(virtualPath, stream);
        }
        else
        {
            return _previous.GetFile(virtualPath);
        }
    }
    else
        return _previous.GetFile(virtualPath);
}

通过检查Initialize方法中读取的资源名称来检查资源是否是此程序集的嵌入资源：

private bool IsEmbeddedPath(string path)
{
    var resourceName = string.Concat(this.assemblyName, path.TrimStart('~').Replace("/", "."));
    return this.assemblyResourceNames.Contains(resourceName, StringComparer.OrdinalIgnoreCase);
}

我将EmbeddedVirtualPathProvider类移动到主web项目（ProjectA）中，这样它就不需要包含在每个包含嵌入式资源的程序集中，并在Global.asax中使用以下代码进行注册：

HostingEnvironment.RegisterVirtualPathProvider(
    new EmbeddedVirtualPathProvider(
        HostingEnvironment.VirtualPathProvider,
        typeof(ProjectB.SomeType).Assembly));

在包含嵌入式资源的项目（ProjectB）中，我仍然在PostApplicationStartMethod:中创建以下捆绑包

 BundleTable.Bundles.Add(new ScriptBundle("~/Embedded/Js")
     .Include("~/Scripts/SomeFolder/MyScript.js")
 );

Scripts/MyScript.js是ProjectB中的嵌入式资源。

有了这个，我收到了以下例外：

目录"C:\webs\ProjectA\Scripts\SomeFolder\"不存在。未能开始监视文件更改。

更新此Gist中提供完整堆栈跟踪。

更新此外，VirtualPathProvider本身似乎运行良好。如果我直接加载文件，而不是通过捆绑包，并在web.config中设置以下条目，它将从ProjectB:加载嵌入的javascript

<system.webServer>
  <handlers>
    <add name="MyStaticFileHandler" path="*.js" verb="GET,HEAD" type="System.Web.StaticFileHandler"/>
  </handlers>
</system.webServer>

Answer 1

ASP.net优化创建捆绑包时，会为脚本的虚拟目录调用GetCacheDependency。您的GetCacheDependency实现只检查虚拟文件，对于虚拟目录，它依赖于检查目录是否存在并失败的基本VirtualPathProvider。

要解决这个问题，您必须检查路径是否是某个脚本的目录，并为GetCacheDependency返回null。

为了安全地确定virtualPath是否是bundle目录，可以使用BundleTable.Bundles集合或使用约定（即：每个bundle都应该以~/Embedded开头）。

public override CacheDependency GetCacheDependency(
    string virtualPath, 
    IEnumerable virtualPathDependencies, 
    DateTime utcStart)
{
    // if(virtualPath.StartsWith("~/Embedded"))
    if(BundleTables.Bundles.Any(b => b.Path == virtualPath))
    {
        return null; 
    }
    if (this.IsEmbeddedPath(virtualPath))
    {
        return null;
    }
    else
    {
        return this._previous
                   .GetCacheDependency(virtualPath, virtualPathDependencies, utcStart);
    }
}

Answer 2

关于以下错误

目录"C:\webs\ProjectA\Scripts\SomeFolder\"不存在。未能开始监视文件更改。

如果SomeFolder的所有资源文件都被嵌入，从而在发布的网站中，这种情况会发生——它并没有创建这个文件夹。

在bundle的情况下，它在创建bundle时保留时间戳，并监视文件夹中的任何文件更改，以触发bundle文件中的更新。

此处-SomeFolder中没有要监视的文件，因为所有文件都已嵌入。没有找到阻止文件夹监视的方法，但通过处理此特定异常，可以忽略它。