在帮别人升级YiSha.Web版本到.net9.0时候遇到下面这个错误:
https://github.com/liukuo362573/YiShaAdmin
System.InvalidOperationException: No file exists for the asset at either location 'D:\xx\YiSha.Web\YiSha.Admin.Web\wwwroot\lib\bootstrap.tagsinput\0.8.0\bootstrap-tagsinput.min.css' or 'wwwroot\lib\bootstrap.tagsinput\0.8.0\bootstrap-tagsinput.min.css'.
在 Microsoft.AspNetCore.StaticWebAssets.Tasks.StaticWebAsset.ResolveFile(String identity, String originalItemSpec)
在 Microsoft.AspNetCore.StaticWebAssets.Tasks.DefineStaticWebAssets.ResolveFileDetails(String originalItemSpec, String identity)
在 Microsoft.AspNetCore.StaticWebAssets.Tasks.DefineStaticWebAssets.Execute()
通过编辑项目文件,添加下述节点解决
<PropertyGroup><StaticWebAssetsEnabled>false</StaticWebAssetsEnabled></PropertyGroup>
发现网上有一篇文章介绍了StaticWebAssets构建 Razor 项目时的问题
https://blog.gitcode.com/76bece0856c6c7df231c32193bc8dd92.html
StaticWebAssets 项目中 Razor 编译缓存问题的分析与解决
问题背景
在 .NET 生态系统中,StaticWebAssets 是一个用于管理静态 Web 资源的组件,它负责在构建过程中处理 Razor 视图和页面的编译。近期有开发者报告,在使用 .NET SDK 9.0.300 版本构建 Razor 项目时,遇到了 DefineStaticWebAssets 任务失败的问题,而同样的项目在 SDK 9.0.105 和 8.0.409 版本下却能正常构建。
问题现象
当开发者使用 .NET SDK 9.0.300 构建 Razor 项目时,首次构建可能成功,但后续构建会失败并显示以下错误信息:
The "DefineStaticWebAssets" task failed unexpectedly.
System.ArgumentException: An item with the same key has already been added.
错误表明在计算静态资源哈希值时出现了键冲突,导致任务执行失败。同时,系统还会提示项目未正确配置为支持 MVC 的 Razor 视图编译。
技术分析
缓存机制的问题
深入分析后发现,问题的根源在于 StaticWebAssets 的缓存机制。在 SDK 9.0.300 版本中,DefineStaticWebAssets 任务会生成一个名为 rpswa.dswa.cache.json 的缓存文件,存储在项目的 obj 目录下。这个缓存文件用于记录静态资源的哈希值,以提高后续构建的效率。
然而,该缓存机制存在两个主要问题:
-
缓存清理不彻底:执行
dotnet clean或使用 Visual Studio 的"清理解决方案"功能时,不会自动删除这个缓存文件。 -
哈希冲突处理不当:当缓存中存在重复的哈希键时,系统没有正确处理冲突,而是直接抛出异常。
影响范围
这个问题主要影响以下场景:
- 使用 .NET SDK 9.0.300 构建 Razor 项目
- 项目包含静态 Web 资源
- 项目在不同分支间切换时(因为缓存文件会保留)
解决方案
临时解决方案
在官方修复发布前,开发者可以采用以下临时解决方案:
-
手动清理缓存:删除项目目录下的
obj文件夹,强制重新生成所有中间文件。 -
锁定 SDK 版本:在项目根目录下创建或修改
global.json文件,指定使用 9.0.204 或更低版本的 SDK:
{"sdk": {"version": "9.0.204","rollForward": "disable"} }
永久解决方案
微软已在后续版本中修复了这个问题。解决方案包括:
-
改进缓存清理:确保清理操作能正确删除缓存文件。
-
优化哈希处理:当检测到缓存文件是最新状态或没有资源时,不再写入缓存文件。
-
增强错误处理:当遇到哈希冲突时,采用更优雅的处理方式而非直接抛出异常。
最佳实践建议
为了避免类似问题,建议开发者:
-
定期清理构建缓存:特别是在切换分支后,手动删除
obj文件夹。 -
关注 SDK 更新:及时升级到修复了该问题的 SDK 版本(如 9.0.301 及以上)。
-
使用版本锁定:对于关键项目,使用
global.json锁定已知稳定的 SDK 版本。 -
监控构建日志:注意是否有关于 Razor 编译或静态资源处理的警告信息。
总结
StaticWebAssets 的缓存机制问题是一个典型的构建系统缺陷,它展示了在优化构建性能(通过引入缓存)时可能带来的副作用。这个问题提醒我们,在软件开发中,缓存策略需要精心设计,不仅要考虑性能提升,还要确保在各种场景下的可靠性和一致性。微软团队通过后续更新解决了这个问题,体现了 .NET 生态系统对开发者反馈的积极响应。