C#自定义MSBuild任务依赖项目后跨解决方案使用时加载失败求助

你的问题核心是：带同解决方案内项目依赖的自定义MSBuild任务，打包成NuGet后，在外部解决方案运行时无法加载依赖程序集——这通常是打包过程中未将依赖程序集包含进NuGet包，或者运行时MSBuild无法找到依赖集的加载路径导致的。以下是具体的排查和解决步骤：

1. 确保依赖程序集被打包进NuGet包 #

自定义任务项目默认不会自动将同解决方案的依赖项目dll打包进去，需要手动配置：

• 在自定义任务的.csproj文件中，添加对依赖项目的文件引用并设置打包属性：

  <ItemGroup>
    <!-- 替换为你的依赖项目输出路径和dll名称 -->
    <None Include="..\YourDependencyProject\bin\$(Configuration)\netstandard2.0\YourDependency.dll" 
          Pack="true" 
          PackagePath="tools" />
  </ItemGroup>
  

• 或者如果依赖项目也打包为NuGet包，直接在自定义任务项目中添加对该NuGet包的PackageReference，确保自定义任务的NuGet包会自动带上这个依赖。

2. 验证NuGet包的目录结构 #

MSBuild自定义任务通常放在NuGet包的tools目录下，解压你生成的NuGet包，检查tools目录是否同时存在自定义任务dll和依赖dll。如果依赖dll不在该目录，MSBuild运行任务时会找不到它。

3. 配置MSBuild任务的加载路径 #

如果依赖dll确实在包内，但仍找不到，可以在自定义任务代码中手动指定加载路径：

using System.IO;
using System.Reflection;
using System.Runtime.Loader;

// 获取当前任务程序集所在目录
var taskDir = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
// 注册程序集解析回调
AssemblyLoadContext.Default.Resolving += (ctx, assemblyName) =>
{
    var targetPath = Path.Combine(taskDir, $"{assemblyName.Name}.dll");
    return File.Exists(targetPath) ? ctx.LoadFromAssemblyPath(targetPath) : null;
};

4. 检查.targets文件的UsingTask配置 #

确保NuGet包中的.targets文件里，UsingTask的路径配置正确：

<!-- 使用相对路径指向tools目录下的任务dll -->
<UsingTask TaskName="YourCustomTaskName" 
           AssemblyFile="$(MSBuildThisFileDirectory)YourCustomTask.dll" />

你的复现仓库中，大概率是遗漏了将依赖项目的dll包含进NuGet包的配置，按上述步骤检查并调整即可解决问题。

内容的提问来源于stack exchange，提问作者Martin