Azure云服务中Microsoft.Data.SqlClient 5.1.2引用程序集引发空引用异常

1. 本地与Pipeline发布的.cspkg内容差异原因及排查方向 #

• NuGet还原不完整：Pipeline环境可能未正确执行NuGet还原，比如msbuild命令未包含/t:Restore步骤，或还原时仅下载了引用程序集而非完整包。检查Pipeline的msbuild命令是否先执行还原，且NuGet源配置与本地一致。
• 发布配置/参数差异：本地和Pipeline使用的构建配置（Debug/Release）不同，或Pipeline的msbuild传递了特殊参数（如/p:GenerateReferenceAssemblies=true），导致仅生成引用程序集。查看项目文件的条件配置，或Pipeline中msbuild的参数设置。
• 项目引用复制规则：项目中Microsoft.Data.SqlClient的<Private>属性（即Copy Local）可能在Pipeline环境中未生效，导致实程序集未被复制到输出目录。检查项目文件的引用节点，确认<Private>True</Private>是否存在。
• 云服务发布任务配置：Pipeline中的Azure云服务发布任务可能有程序集筛选规则，误将实程序集排除在外。检查发布任务的参数，确保没有排除Microsoft.Data.SqlClient.dll的设置。

2. 运行时加载引用程序集的原因 #

• 程序集查找逻辑：运行时优先从应用程序目录加载程序集，如果目录中只有引用程序集（72KB的空壳程序集），就会加载它。引用程序集仅包含元数据，没有实际执行代码，调用方法时必然触发System.NullReferenceException。
• 部署时文件覆盖：云服务部署过程中，旧的引用程序集可能覆盖了新的实程序集，比如部署脚本的文件替换逻辑出错，导致实程序集未被正确部署。
• 版本匹配问题：如果Pipeline发布的包中缺少正确的绑定重定向，或程序集版本与项目引用不匹配，运行时无法找到对应的实程序集，只能 fallback到引用程序集。

3. 修复建议 #

• 强制完整NuGet还原与发布：在Pipeline的msbuild命令中使用msbuild /t:Restore;Publish /p:Configuration=Release，确保先完整还原所有依赖包，再执行发布，避免跳过还原步骤。
• 禁用引用程序集生成：在项目文件的<PropertyGroup>中添加<GenerateReferenceAssemblies>false</GenerateReferenceAssemblies>，或在msbuild参数中传递/p:GenerateReferenceAssemblies=false，确保输出目录仅包含实程序集。
• 确认Copy Local设置：在项目的NuGet引用中，确保Microsoft.Data.SqlClient的“Copy Local”属性设为True，对应项目文件中的<Private>True</Private>，保证程序集被复制到输出目录。
• 清理Pipeline缓存：添加Pipeline步骤清理NuGet缓存和构建缓存，比如执行nuget locals all -clear，避免旧的引用程序集被重复使用。
• 验证Pipeline输出：在Pipeline中添加步骤，检查构建输出目录中Microsoft.Data.SqlClient.dll的大小，或打包输出到Artifact供人工验证，提前发现异常。
• 检查云服务部署脚本：如果使用自定义部署脚本，确认脚本没有误删或替换实程序集，确保所有必要文件都被打包到.cspkg中。

内容的提问来源于stack exchange，提问作者Tadas Šukys