CMakeで.NETプロジェクトをビルドする際のVS_DOTNET_REFERENCES_COPY_LOCALプロパティの役割

CMake の VS_DOTNET_REFERENCES_COPY_LOCAL プロパティ

VS_DOTNET_REFERENCES_COPY_LOCAL は、CMake で .NET プロジェクトをビルドする際に、参照されているアセンブリを出力ディレクトリにコピーするかどうかを制御するプロパティです。

デフォルトでは ON に設定されており、参照されているアセンブリは出力ディレクトリにコピーされます。

設定方法

set_target_properties() コマンドを使用して、このプロパティを設定できます。

set_target_properties(my_target PROPERTIES VS_DOTNET_REFERENCES_COPY_LOCAL OFF)

この例では、my_target ターゲットの VS_DOTNET_REFERENCES_COPY_LOCAL プロパティを OFF に設定しています。

使用例

• アプリケーションが .NET Framework に含まれているアセンブリのみを参照する場合、このプロパティを OFF に設定して、ビルド時間を短縮できます。
• アプリケーションが .NET Framework に含まれていないアセンブリを参照する場合、このプロパティを ON に設定する必要があります。

注意事項

• このプロパティは、Visual Studio ソリューションファイル (.sln) を生成する場合にのみ使用されます。
• .NET プロジェクトをビルドする際は、常に target_link_libraries() コマンドを使用して、参照されているアセンブリを指定する必要があります。

補足

• .NET アセンブリには、ヒントパス と呼ばれるファイルパス情報が含まれている場合があります。ヒントパスは、アセンブリの場所を指定するために使用されます。
• VS_DOTNET_REFERENCES_COPY_LOCAL プロパティは、ヒントパスを持つアセンブリのみを対象にしています。ヒントパスを持たないアセンブリは、常にシステムパスから読み込まれます。
• Visual Studio では、プロジェクト参照 と呼ばれる機能を使用して、別の .NET プロジェクトを参照することができます。プロジェクト参照は、target_link_libraries() コマンドを使用して設定できます。
• VS_DOTNET_REFERENCES_COPY_LOCAL プロパティは、プロジェクト参照には適用されません。プロジェクト参照で参照されているアセンブリは、常に出力ディレクトリにコピーされます。

VS_DOTNET_REFERENCES_COPY_LOCAL プロパティのサンプルコード

すべての参照アセンブリを出力ディレクトリにコピーする

set(CMAKE_PROJECT_NAME MyProject)

add_executable(my_exe
  main.cpp)

target_link_libraries(my_exe
  System.dll)

set_target_properties(my_exe PROPERTIES VS_DOTNET_REFERENCES_COPY_LOCAL ON)

特定のアセンブリのみを出力ディレクトリにコピーする

set(CMAKE_PROJECT_NAME MyProject)

add_executable(my_exe
  main.cpp)

target_link_libraries(my_exe
  System.dll
  MyCustomAssembly.dll)

set_target_properties(my_exe PROPERTIES VS_DOTNET_REFERENCES_COPY_LOCAL ON)

# MyCustomAssembly.dll をのみ出力ディレクトリにコピーする
set_target_properties(my_exe PROPERTIES VS_DOTNET_REFERENCE_COPY_LOCAL_LIST
  MyCustomAssembly.dll)

この例では、System.dll アセンブリはコピーされませんが、MyCustomAssembly.dll アセンブリは my_exe 実行可能ファイルと同じディレクトリにコピーされます。

.NET Framework に含まれているアセンブリをコピーしない

set(CMAKE_PROJECT_NAME MyProject)

add_executable(my_exe
  main.cpp)

target_link_libraries(my_exe
  System.dll)

set_target_properties(my_exe PROPERTIES VS_DOTNET_REFERENCES_COPY_LOCAL OFF)

この例では、System.dll アセンブリは .NET Framework に含まれているため、コピーされません。

プロジェクト参照を使用する

set(CMAKE_PROJECT_NAME MyProject)

add_subdirectory(MyCustomProject)

add_executable(my_exe
  main.cpp)

target_link_libraries(my_exe
  MyCustomProject)

set_target_properties(my_exe PROPERTIES VS_DOTNET_REFERENCES_COPY_LOCAL ON)

この例では、MyCustomProject プロジェクトは my_exe プロジェクトによって参照されます。MyCustomProject プロジェクトによって出力されたすべてのアセンブリは、my_exe 実行可能ファイルと同じディレクトリにコピーされます。

VS_DOTNET_REFERENCES_COPY_LOCAL プロパティの代替方法

アセンブリを GAC にインストールする

概要

GAC (Global Assembly Cache) は、.NET アセンブリを共有するために使用できるシステムレベルのキャッシュです。GAC にインストールされたアセンブリは、すべての .NET アプリケーションから参照できます。

方法

• gacutil コマンドを使用して、アセンブリを GAC にインストールできます。

gacutil /i MyCustomAssembly.dll

• Visual Studio では、プロジェクトのプロパティを使用して、アセンブリを GAC にインストールすることができます。

注意事項

• GAC にインストールされたアセンブリは、すべての .NET アプリケーションで使用できるため、注意が必要です。
• GAC にインストールされたアセンブリをアンインストールするには、gacutil コマンドを使用する必要があります。

アセンブリをアプリケーションの出力ディレクトリに配置する

概要

VS_DOTNET_REFERENCES_COPY_LOCAL プロパティを OFF に設定し、target_link_libraries() コマンドを使用して、アセンブリの場所を指定することができます。

方法

• target_link_libraries() コマンドの PRIVATE オプションを使用して、アセンブリの場所を指定できます。

set(CMAKE_PROJECT_NAME MyProject)

add_executable(my_exe
  main.cpp)

target_link_libraries(my_exe
  PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/MyCustomAssembly.dll)

この例では、MyCustomAssembly.dll アセンブリは my_exe 実行可能ファイルと同じディレクトリに配置されます。

注意事項

• この方法を使用する場合は、アセンブリの場所をアプリケーションのコードにハードコーディングする必要があります。
• アセンブリの場所を変更する場合は、アプリケーションのコードも変更する必要があります。

NuGet を使用する

概要

NuGet は、.NET アセンブリを管理するために使用できるオープンソースのパッケージマネージャーです。NuGet を使用すると、アセンブリを簡単にダウンロード、インストール、更新することができます。

方法

• NuGet パッケージマネージャーを使用して、プロジェクトに NuGet パッケージを追加できます。
• NuGet パッケージには、.NET アセンブリだけでなく、その他のファイル (設定ファイル、ドキュメントなど) も含まれている場合があります。

注意事項

• NuGet を使用するには、インターネット接続が必要です。
• NuGet パッケージは、公式の NuGet ギャラリーからダウンロードするか、独自の NuGet ソースからダウンロードすることができます。

VS_DOTNET_REFERENCES_COPY_LOCAL プロパティは、.NET アセンブリを配置するための最も簡単な方法ですが、他の方法も存在します。どの方法を使用するかは、プロジェクトの要件によって異なります。