CefSharp项目迁移至chromiumembeddedframework.runtime Nuget包的技术指南

背景介绍

CefSharp是一个基于Chromium Embedded Framework(CEF)的.NET封装库，它允许开发者在.NET应用程序中嵌入完整的网页浏览器功能。随着技术的发展，项目团队决定对Nuget包依赖进行重大更新，从传统的cef.redist包迁移到更现代的chromiumembeddedframework.runtime包。

迁移的必要性

此次迁移主要基于以下几个技术考量：

1. 统一依赖管理：此前.NET Core项目已经使用了chromiumembeddedframework.runtime包，而.NET Framework项目仍在使用旧的cef.redist包，这种分裂状态增加了维护成本。

2. 存储空间优化：项目在MyGet存储库中已经超过了500MB的限制，迁移可以消除重复的二进制文件，优化资源使用。

3. 未来兼容性：新包结构更好地支持.NET Core 3.1及更高版本(.NET 5/6/7/8+)，为未来的技术演进做好准备。

技术变更细节

包结构变化

旧版依赖：

• cef.redist.x64
• cef.redist.x86

新版依赖：

• chromiumembeddedframework.runtime.win-x64
• chromiumembeddedframework.runtime.win-x86

虽然包名称发生了变化，但实际包含的二进制文件内容完全相同，只是内部结构进行了优化调整。

兼容性说明

新包的.props和.targets文件设计考虑了向后兼容性，这意味着：

1. 大多数现有项目可以无需修改直接升级
2. 构建系统会自动处理新的依赖结构
3. 运行时行为与之前版本保持一致

迁移步骤指南

对于使用packages.config的项目

1. 首先升级顶层包(CefSharp.Wpf、CefSharp.WinForms或CefSharp.OffScreen)
2. 检查项目引用中是否残留旧版cef.redist.x64或cef.redist.x86包
3. 安全移除这些旧包引用(它们通常版本号较低)

对于使用PackageReference的项目

1. 直接更新顶层CefSharp包
2. 依赖解析器会自动处理底层运行时包的更新

技术影响评估

1. 构建系统：新的.targets文件会确保必要的CEF二进制文件被正确复制到输出目录
2. 部署包大小：由于二进制内容相同，最终应用程序大小不会显著变化
3. 调试体验：调试符号和源文件链接保持不变

常见问题解答

Q: 迁移后需要修改应用程序代码吗？ A: 不需要，公共API接口保持不变，仅底层依赖包发生变化。

Q: 能否混合使用新旧包？ A: 不推荐，应该完全迁移到新包体系以获得最佳支持。

Q: 旧包还会更新吗？ A: 不会，cef.redist系列包将不再接收更新。

最佳实践建议

1. 在开发环境中先测试迁移，再应用到生产项目
2. 更新后运行完整的测试套件验证功能
3. 考虑将项目从packages.config迁移到PackageReference以获得更好的依赖管理
4. 清理解决方案中的旧包缓存以确保使用正确的依赖

结论

此次迁移是CefSharp项目现代化进程中的重要一步，它为未来的功能开发和性能优化奠定了基础。虽然变更涉及底层依赖，但团队已经确保了平滑的过渡路径，大多数开发者只需简单的包更新操作即可完成迁移。