Visual Studio 2010 DTE：如何使添加的 DLL 引用绝对且不复制

Question

摘要：

当您添加特定 DLL 时，我们需要使用 DTE 复制“添加引用”对话框的行为（它向 CSProj 文件中的引用添加提示路径条目）。

**注意：我这里还有另一篇相关但不重复的帖子：https://stackoverflow.com/ questions/6690655/visual-studio-2010-add-in-how-to-get-a-references-hint-path-property 另请阅读该内容有关此问题的更多信息。我现在已经添加了一笔不错的赏金来获得这个问题的答案，并且很乐意对任何像样的答案进行投票:)*

到目前为止的故事：

我正在使用 DTE 以编程方式将项目引用转换为直接 DLL 引用。

假设我有一个简单的解决方案，其中的 Project2 （父 项目）引用了 Project1 （子 项目） ），我进行如下更改：

project1Reference = FindProjectReference(project2.References, project1);
project1Reference.Remove();
Reference dllReference = project2.References.Add(project1DllPath);

其中 project1DllPath 引用 "c:\somewhere\Project1\Bin\Debug\Project1.dll" 文件。

我还无法解决的问题是新的参考不是 “c:\somewhere\Project1\Bin\Debug\Project1.dll”而是指向 "c:\somewhere\Project2\Bin\Debug\Project1.dll" （文件被复制到那里）。

如果我使用“添加引用”菜单直接/手动添加 DLL，则它不会执行此复制。

如何添加对现有项目 DLL 的 DLL 引用，而不需要复制并引用该 DLL？

我尝试在“添加”之后添加 dllReference.CopyLocal = false;，但是除了设置标志之外没有任何区别。创建后似乎没有修改路径的选项。

更新：我还尝试以编程方式从 Project2 中删除对 Project1 的任何构建依赖项，但这没有效果。

下面是 csproj 文件之间的区别：

作为项目：

  <ItemGroup>
    <ProjectReference Include="..\ClassLibrary1\ClassLibrary1.csproj">
      <Project>{86B3E118-2CD1-49E7-A180-C1346EC223B9}</Project>
      <Name>ClassLibrary1</Name>
    </ProjectReference>
  </ItemGroup>

作为 DLL 引用（路径完全丢失）：

 <ItemGroup>
    <Reference Include="ClassLibrary1, Version=1.0.0.0, Culture=neutral, processorArchitecture=MSIL">
      <Private>False</Private>
    </Reference>
    ...
  </ItemGroup>

作为手动引用的 DLL：

  <ItemGroup>
    <Reference Include="ClassLibrary1, Version=1.0.0.0, Culture=neutral, processorArchitecture=MSIL">
      <HintPath>..\ClassLibrary1\bin\Debug\ClassLibrary1.dll</HintPath>
    </Reference>
    ...
  </ItemGroup>

看来能够为 DLL 引用指定提示路径是关键。 如何在 DLL 引用上设置提示路径（假设您只有 Reference 属性的句柄）？

更多信息（2011 年 7 月 20 日）：

来自 下面的 Muse VSExtensions 不会影响相关 DLL，因为已从 DLL 的项目 BIN 到父项目的 BIN 文件夹。父项目不会费心使用引用路径，因为它的输出文件夹中已包含子 DLL。

此外，项目的参考路径 会保存到project.csproj.user 文件，而不是project.csproj 文件。

Answer 1

我确信这是 VS 2010 中的一个新错误/功能，因为我有一个加载项，在我从 VS 2008 迁移后几天前开始显示类似的行为...基本上，如果您添加对VS 程序集搜索路径中的任何内容，都会在没有路径提示的情况下添加。

我设法找到了其他 VS 插件来解决这个问题（Power Tools、NuGet 等），它们似乎都使用 MsBuild。我不知道 MsBuild 是否会大幅提高资源使用量 - 我自己还没有看到太大的减速，可能是因为 References.Add() 开始时非常慢。但请注意，要获取 MsBuild 项目的实例，需要使用名为“GetLoadedProjects”的方法，这可能意味着它适用于内存中已存在的数据。

下面是我用来修复加载项的代码，它是我在网上找到的代码的简化版本...本质上，想法是照常添加引用，然后使用 MsBuild 设置路径提示。设置提示是一项简单的操作，但找到要添加提示的 MsBuild 项目项的实例却非常复杂。我尝试仅使用 MsBuild 破解一种替代方案，但遇到了其他问题......这个似乎可行。

这里可能感兴趣的另一件事是：代码包含一种优化 - 如果引用的路径等于我们想要添加的路径，它不会向新引用添加提示。这对于所讨论的情况来说已经足够好了，并且当 VS 决定使用输出文件夹中的 dll 而不是我们告诉它的内容时，可以正确检测到。但是，当我尝试添加对输出文件夹中已有的 dll 的引用时（我对许多相关项目使用单个输出文件夹），加载项没有设置提示路径，并且项目似乎切换为使用其他一些 dll在路径中（在我的例子中是来自其 PublicAssemblies 文件夹的路径）...因此，完全删除“if (!newRef.Path.Equals(...”) 行并始终添加提示可能会很有用。我仍在调查此案，因此任何其他 -嗯，欢迎对代码进行提示或改进。

string newFileName = "the path to your.dll";
VSLangProj.VSProject containingProject = yourProject;

VSLangProj.Reference newRef;

newRef = containingProject.References.Add(newFileName);
if (!newRef.Path.Equals(newFileName, StringComparison.OrdinalIgnoreCase))
{
    Microsoft.Build.Evaluation.Project msBuildProj = Microsoft.Build.Evaluation.ProjectCollection.GlobalProjectCollection.GetLoadedProjects(containingProject.Project.FullName).First();
    Microsoft.Build.Evaluation.ProjectItem msBuildRef = null;

    AssemblyName newFileAssemblyName = AssemblyName.GetAssemblyName(newFileName);
    foreach(var item in msBuildProj.GetItems("Reference"))
    {
        AssemblyName refAssemblyName = null;
        try 
        {
            refAssemblyName = new AssemblyName(item.EvaluatedInclude);
        }
        catch {}

        if (refAssemblyName != null)
        {
            var refToken = refAssemblyName.GetPublicKeyToken();
            var newToken = newFileAssemblyName.GetPublicKeyToken();

            if
            (
                refAssemblyName.Name.Equals(newFileAssemblyName.Name, StringComparison.OrdinalIgnoreCase)
                && ((refAssemblyName.Version != null && refAssemblyName.Version.Equals(newFileAssemblyName.Version))
                    || (refAssemblyName.Version == null && newFileAssemblyName.Version == null))
                && (refAssemblyName.CultureInfo != null && (refAssemblyName.CultureInfo.Equals(newFileAssemblyName.CultureInfo))
                    || (refAssemblyName.CultureInfo == null && newFileAssemblyName.CultureInfo == null))
                && ((refToken != null && newToken != null && Enumerable.SequenceEqual(refToken, newToken))
                    || (refToken == null && newToken == null))
            )
            {
                msBuildRef = item;
                break;
            }
        }
    }

    if (msBuildRef != null)
    {
        Uri newFileUri = new Uri(newFileName);
        Uri projectUri = new Uri(Path.GetDirectoryName(containingProject.Project.FullName).TrimEnd(Path.DirectorySeparatorChar) + Path.DirectorySeparatorChar);

        Uri relativeUri = projectUri.MakeRelativeUri(newFileUri);
        msBuildRef.SetMetadataValue("HintPath", relativeUri.ToString());
    }
}

Answer 2

这个问题是否必须仅使用 DTE 来解决？您可以使用 MSBuild 自动化来执行此操作...它具有可以解析 csproj 文件内容的类。

看看：
Microsoft.Build.Evaluation 命名空间，
有一些关于如何加载 csproj 文件以及如何更改它的有用信息。
另请参阅项目类。

Answer 3

要解决此问题，您需要从 DTE 将引用路径添加到项目属性。

要在 Visual Studio 中设置引用路径：

1. 在“解决方案资源管理器”中，选择项目。
2. 在“项目”菜单上，单击“属性”。
3. 单击参考路径。
4. 在“文件夹”文本框中，指定包含程序集的文件夹的路径。要浏览到该文件夹​​，请单击省略号 (...)。
5. 单击添加文件夹。

您必须从自动化对象中执行相同的操作

让我知道是否有帮助

Answer 4

很难拒绝一个好的挑战......
我不在那儿，但我想我有一些不错的提示来推动这一进程。
首先，我创建了一个微型测试插件来重现您的问题，然后..我失败了！

    foreach (Project project in (object[])_applicationObject.ActiveSolutionProjects)
    {
        ((VSProject)project.Object).References.Add(@"c:\temp\test\FromFolder\bin\debug\KmlLib.dll");
    }

这是来自我磁盘上某个位置的随机 dll。该 dll 未签名，最终出现在我的 csproj 中（正是您想要完成的任务）：

   <Reference Include="KmlLib">
      <HintPath>..\..\FromFolder\bin\debug\KmlLib.dll</HintPath>
    </Reference>

然后我注意到您的 dll 已签名。这也没有什么区别。我做的下一个测试是复制一些标准的 MS dll。我从 \Program Files\Microsoft Visual Studio 10.0\Common7\IDE\PublicAssemblies\ 中选择了 VsWebSite.Interop.dll 并将其复制到我的 FromFolder\bin\debug\ 添加作为参考突然重现了您的场景>我得到了包含，但没有得到提示路径。
然后是最终测试：我将 VsWebSite.Interop.dll 重命名为 xxVsWebSite.Interop.dll 并包含该 dll。突然又添加了提示路径！

将所有这些和您的描述结合在一起，我的猜测是，在添加引用时，VS 首先查看是否可以在其当前搜索位置（GAC、项目文件夹、路径（？）、..）中找到引用的 dll，如果是，则没有提示路径额外。如果找不到，则需要并添加提示路径。

要查看这个理论是否成立，您可以做两个测试：

• 将引用的 dll 复制到完全不同的文件夹，然后从那里引用 -->仍然不会包含提示路径，因为具有相同签名的 dll 仍在“路径”中
• 将引用的 dll 复制并重命名到完全不同的文件夹并引用新名称 -->应该添加提示路径

对你的结果感到好奇:)

Answer 5

我最近在 Visual Studio 2010 中添加 dll 引用时遇到了问题，我无法让它添加 HintPath，这导致了 TFS 构建的问题。我注意到几周前安装的 Productivity Power Tools 插件更改了添加参考对话框。我从“工具”菜单中关闭了该附加组件的“可搜索添加引用对话框”，在重新启动 Visual Studio 2010 后，我再次感到高兴 - 我能够添加引用，这次 HintPath 也在那里。