ソリューションでプロジェクト依存関係を使用している場合、MSBuild は参照 (DLL ファイル) をコピーしません質問する

Question

Visual Studio と MsBuild の間でビルドするときになぜ異なるのかはわかりませんが、MsBuild と Visual Studio でこの問題に遭遇したときに私が見つけたことは次のとおりです。

説明

サンプルシナリオとして、プロジェクト X、アセンブリ A、アセンブリ B があるとします。アセンブリ A はアセンブリ B を参照するため、プロジェクト X には A と B の両方への参照が含まれます。また、プロジェクト X にはアセンブリ A を参照するコード (例: A.SomeFunction()) が含まれます。ここで、プロジェクト X を参照する新しいプロジェクト Y を作成します。

依存関係のチェーンは次のようになります: Y => X => A => B

Visual Studio / MSBuild は、プロジェクト X で必要であると検出された参照のみをプロジェクト Y に持ち込むようスマートに動作します。これは、プロジェクト Y での参照汚染を回避するためです。問題は、プロジェクト X にはアセンブリ B を明示的に使用するコード (例: B.SomeFunction()) が実際には含まれていないため、VS/MSBuild は B が X で必要であることを検出せず、プロジェクト Y の bin ディレクトリにコピーしないことです。コピーされるのは、X アセンブリと A アセンブリのみです。

解決

この問題を解決するには 2 つのオプションがあり、どちらの場合もアセンブリ B がプロジェクト Y の bin ディレクトリにコピーされます。

プロジェクト Y のアセンブリ B への参照を追加します。
アセンブリ B を使用するプロジェクト X のファイルにダミーコードを追加します。

個人的には、いくつかの理由からオプション 2 を好みます。

将来、プロジェクト X を参照する別のプロジェクトを追加する場合、アセンブリ B への参照も含める必要があることを覚えておく必要はありません (オプション 1 の場合のように)。
ダミーコードがなぜ必要で、削除してはいけないのかを明示的なコメントで説明できます。そのため、誰かが誤ってコードを削除した場合でも (未使用のコードを探すリファクタリングツールなどを使用して)、ソース管理からそのコードが必要であることが簡単にわかり、復元できます。オプション 1 を使用し、誰かがリファクタリングツールを使用して未使用の参照をクリーンアップした場合、コメントは表示されず、.csproj ファイルから参照が削除されたことだけが表示されます。

以下は、このような状況に遭遇したときに私が通常追加する「ダミーコード」のサンプルです。

    // DO NOT DELETE THIS CODE UNLESS WE NO LONGER REQUIRE ASSEMBLY A!!!
    private void DummyFunctionToMakeSureReferencesGetCopiedProperly_DO_NOT_DELETE_THIS_CODE()
    {
        // Assembly A is used by this file, and that assembly depends on assembly B,
        // but this project does not have any code that explicitly references assembly B. Therefore, when another project references
        // this project, this project's assembly and the assembly A get copied to the project's bin directory, but not
        // assembly B. So in order to get the required assembly B copied over, we add some dummy code here (that never
        // gets called) that references assembly B; this will flag VS/MSBuild to copy the required assembly B over as well.
        var dummyType = typeof(B.SomeClass);
        Console.WriteLine(dummyType.FullName);
    }

Answer 1