CefSharp项目中解决原生二进制文件被错误复制的问题

背景介绍

CefSharp是一个基于Chromium Embedded Framework(CEF)的.NET封装库，它允许开发者在.NET应用程序中嵌入Chromium浏览器功能。在使用过程中，开发者可能会遇到一个常见问题：CefSharp依赖的chromiumembeddedframework.runtime.win-x86和chromiumembeddedframework.runtime.win-x64包中的原生二进制文件会被错误地复制到项目的bin目录中。

问题现象

当项目引用CefSharp时，以下原生二进制文件会被自动复制到输出目录：

• CefSharp.dll
• chrome_100_percent.pak
• chrome_200_percent.pak
• chrome_elf.dll
• d3dcompiler_47.dll
• icudtl.dat
• libcef.dll
• libEGL.dll
• libGLESv2.dll
• resources.pak
• snapshot_blob.bin
• v8_context_snapshot.bin
• vk_swiftshader_icd.json
• vk_swiftshader.dll
• vulkan-1.dll

这些文件本不应该出现在输出目录中，因为它们已经包含在CefSharp的主程序集中。

解决方案

基本解决方案

最直接的解决方案是在项目文件中显式排除这些原生资产。可以通过修改.csproj文件来实现：

<ItemGroup>
  <PackageReference Include="CefSharp.WinForms" Version="123.0.60"/>
  <PackageReference Include="chromiumembeddedframework.runtime.win-x86" Version="123.0.6">
    <ExcludeAssets>native</ExcludeAssets>
  </PackageReference>
</ItemGroup>

这种方法简单有效，但有一个明显的缺点：它会将chromiumembeddedframework.runtime.win-x86的引用添加到解决方案中的所有项目，即使某些项目并不需要这个引用。

改进方案

为了更精确地控制哪些项目需要排除原生资产，可以采用条件引用的方式。以下是两种改进方法：

1. 使用项目属性标记

   在需要引用CefSharp的项目中定义属性：

   <PropertyGroup>
     <CefSharpReferenced>true</CefSharpReferenced>
   </PropertyGroup>
   

   然后在公共的.props文件中添加条件引用：

   <PackageReference Include="chromiumembeddedframework.runtime.win-x86"
                     Version="132.3.1"
                     Condition="'$(CefSharpReferenced)' == 'true'">
       <ExcludeAssets>native</ExcludeAssets>
   </PackageReference>
   

2. 使用自定义导入

   创建一个单独的.props文件专门处理CefSharp的引用，然后在需要引用CefSharp的项目中导入这个文件：

   <Import Project="CefSharpReferences.props" Condition="Exists('CefSharpReferences.props')"/>
   

技术原理

这个问题的根源在于NuGet包的依赖解析机制。CefSharp依赖于chromiumembeddedframework.runtime.win-x86/win-x64包，这些包包含了原生二进制文件。默认情况下，NuGet会将这些原生资产复制到输出目录。

通过<ExcludeAssets>native</ExcludeAssets>指令，我们告诉NuGet不要处理这些原生资产。这样就能避免不必要的文件被复制到输出目录。

最佳实践

1. 集中管理：对于大型解决方案，建议创建一个共享的.props文件来统一管理CefSharp的引用配置。

2. 版本控制：确保CefSharp主包和运行时包的版本保持一致，避免兼容性问题。

3. 平台考虑：根据目标平台(x86/x64)正确引用对应的运行时包。

4. 清理验证：实施解决方案后，执行清理并重新生成项目，验证输出目录中是否还有多余的原生二进制文件。

总结

处理CefSharp原生二进制文件被错误复制的问题，关键在于理解NuGet的资产排除机制。通过合理配置项目文件，可以精确控制哪些资产应该被包含或排除。对于复杂项目结构，采用条件引用或集中管理的方式能够提高维护性和一致性。