VS2017中EnvDTE.Project转VCProjectEngine.VCProject返回NULL求助

我之前也踩过这个坑，VS2017对旧版项目系统的兼容性调整确实给遗留项目适配带来了不少麻烦。先明确下你的场景：你维护着一个支持VS2008到VS2015的C++遗留项目适配工具（基于VS2015的C#项目），核心逻辑是把EnvDTE.Project转换为VCProjectEngine.VCProject——这个转换在老版本VS里完全正常，但到了VS2017就直接返回NULL了。

先贴出你提到的VS2015最小可用代码（补全了常规实现）：

// 引用VS2015提供的EnvDTE和VCProjectEngine程序集
using EnvDTE;
using Microsoft.VisualStudio.VCProjectEngine;

public class ProjectConverter
{
    public VCProject ConvertToVCProject(EnvDTE.Project dteProject)
    {
        // VS2015及之前版本正常，VS2017返回NULL
        return dteProject.Object as VCProject;
    }
}

问题根源 #

VS2017开始，微软重构了Visual Studio的项目系统，尤其是C++项目的承载逻辑：

1. 旧版VCProjectEngine组件不再直接通过EnvDTE.Project.Object暴露，因为VS2017引入了SDK-style项目和全新的C++项目系统；
2. 即使是未迁移的遗留C++项目，VS2017对DTE接口的兼容性做了调整，直接访问Object属性会返回NULL。

解决方案 #

下面是几个经过验证的解决思路，按优先级推荐：

1. 改用IVsHierarchy接口获取VCProject（最可靠）

绕过DTE的Object属性，直接通过Visual Studio核心COM服务获取VCProject对象，这个方式在VS2017及后续版本都稳定：

using EnvDTE;
using Microsoft.VisualStudio.Shell;
using Microsoft.VisualStudio.VCProjectEngine;
using Microsoft.VisualStudio.OLE.Interop;
using Microsoft.VisualStudio.Shell.Interop;

public class VS2017ProjectConverter
{
    public VCProject GetVCProjectFromDTEProject(EnvDTE.Project dteProject)
    {
        // VS相关操作必须在UI线程执行
        ThreadHelper.ThrowIfNotOnUIThread();
        
        // 从DTE实例获取服务提供者
        var serviceProvider = new ServiceProvider((IServiceProvider)dteProject.DTE);
        
        // 获取IVsSolution服务实例
        var vsSolution = serviceProvider.GetService(typeof(SVsSolution)) as IVsSolution;
        if (vsSolution == null) return null;
        
        // 通过项目唯一名称获取对应的IVsHierarchy对象
        vsSolution.GetProjectOfUniqueName(dteProject.UniqueName, out IVsHierarchy hierarchy);
        if (hierarchy == null) return null;
        
        // 从Hierarchy中提取VCProject实例
        hierarchy.GetProperty(
            (uint)VSConstants.VSITEMID.Root, 
            (int)__VSHPROPID.VSHPROPID_ExtObject, 
            out object extObj
        );
        
        return extObj as VCProject;
    }
}

2. 确保引用正确的VS2017程序集

不要再使用VS2015版本的EnvDTE和VCProjectEngine程序集：

• 可以从VS2017安装目录（比如C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise\Common7\IDE\PublicAssemblies）引用对应版本的程序集；
• 或者通过NuGet安装Microsoft.VisualStudio.VCProjectEngine适配包，确保版本与VS2017匹配。

3. 先验证项目类型和加载状态

在转换前先确认目标项目是C++项目且已正确加载：

// C++项目的Kind GUID固定为{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}
if (dteProject.Kind == "{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}" && dteProject.IsOpen)
{
    // 执行转换逻辑
}

额外注意事项 #

• 如果你的工具是独立于VS运行的（不是VS插件），需要确保正确初始化DTE实例并附加到VS2017进程，同时注意COM对象的释放，避免内存泄漏；
• 如果后续还要适配VS2019及以后版本，建议逐步迁移到Microsoft.VisualStudio.ProjectSystem API，这是微软主推的现代化项目操作接口。

内容的提问来源于stack exchange，提问作者V.Aggarwal