如何在运行时加载不同版本MSBuild工具并实现GAC版本回退

你遇到的注册GAC路径报错是Microsoft.Build.Locator的预期行为，该组件的设计目标就是仅支持定位Visual Studio 2017及以上版本对应的MSBuild 15.0+实例，本身不识别GAC中存储的旧版MSBuild，你的操作没有问题。

实现方案 #

实现你要的「优先加载最新版MSBuild，不存在则回退GAC旧版」的逻辑不需要手动注册GAC路径，按照以下步骤操作即可：

第一步：调整项目引用属性 #

将项目中所有引用的Microsoft.Build相关程序集（包括Microsoft.Build、Microsoft.Build.Framework等关联包）的复制本地属性设置为False，避免本地附带的旧版本dll干扰运行时程序集加载逻辑。

第二步：添加启动时的MSBuild注册逻辑 #

在应用程序入口的最开始位置，也就是任意调用Microsoft.Build API的代码执行之前，运行以下逻辑：

using Microsoft.Build.Locator;
using System.Linq;

try
{
    // 查询所有已安装的15.0+版本MSBuild实例
    var msbuildInstances = MSBuildLocator.QueryVisualStudioInstances().ToList();
    if (msbuildInstances.Any())
    {
        // 选择版本最高的实例注册
        var latestInstance = msbuildInstances.OrderByDescending(i => i.Version).First();
        MSBuildLocator.RegisterInstance(latestInstance);
    }
}
catch
{
    // 定位MSBuild 15+版本出现异常时直接跳过，不抛出
}

// 此处之后再编写调用Microsoft.Build API的业务代码

逻辑说明 #

• 若设备上存在符合要求的15.0+版本MSBuild，Locator会完成注册，后续所有Microsoft.Build相关的API都会自动绑定到你选中的高版本MSBuild对应的程序集上。
• 若设备上不存在高版本MSBuild，Locator不会做任何操作，运行时会按照默认的程序集解析规则自动加载GAC中你项目引用的4.0.0版本MSBuild，自动实现回退逻辑。

注意事项 #

• 必须保证Locator注册逻辑执行在所有Microsoft.Build类型加载之前，一旦有Microsoft.Build的类型被运行时加载，后续再执行Locator注册不会生效。
• 如果业务代码中用到了MSBuild 15.0+版本的特有API，需要在调用前添加MSBuild版本判断逻辑，避免回退到旧版本时出现运行时错误。

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