MSBuildDeps¶

MSBuildDeps 是 Microsoft MSBuild 构建系统的依赖信息生成器。它将为每个包的依赖项生成多个 xxxx.props 属性文件，供使用 MSBuild 或 Visual Studio 的消费者使用，只需将生成的属性文件添加到解决方案和项目中即可。

MSBuildDeps 生成器可以在 conanfiles 中按名称使用。

conanfile.py¶

class Pkg(ConanFile):
    generators = "MSBuildDeps"

conanfile.txt¶

[generators]
MSBuildDeps

它也可以在 conanfile 的 generate() 方法中完全实例化

conanfile.py¶

from conan import ConanFile
from conan.tools.microsoft import MSBuildDeps

class Pkg(ConanFile):
    settings = "os", "compiler", "arch", "build_type"
    requires = "zlib/1.3.1", "bzip2/1.0.8"

    def generate(self):
        ms = MSBuildDeps(self)
        ms.generate()

生成的文件¶

MSBuildDeps 生成器是多配置生成器，为任何不同的 Debug/Release 配置生成不同的文件。例如，运行这些命令

$ conan install .  # default is Release
$ conan install . -s build_type=Debug

它生成以下文件

conan_zlib_vars_release_x64.props：Conanzlibxxxx 变量定义，用于 zlib 依赖项，Release 配置，例如 ConanzlibIncludeDirs、ConanzlibLibs 等。
conan_zlib_vars_debug_x64.props：同 Conanzlib 变量，用于 zlib 依赖项，Debug 配置。
conan_zlib_release_x64.props：在当前构建中激活 Conanzlibxxxx 变量，作为标准的 C/C++ 构建配置，Release 配置。此文件还包含传递性依赖项的定义。
conan_zlib_debug_x64.props：同激活 Conanzlibxxxx 变量，Debug 配置，也包含传递性依赖项。
conan_zlib.props：zlib 的属性文件。它根据配置有条件地包含上面两个 Release/Debug 属性文件之一。
对于图中的每个依赖项都会生成相同的 5 个文件，在本例中还有 conan_bzip.props，它有条件地包含 Release/Debug bzip 属性文件。
conandeps.props：包含所有直接依赖项的属性文件，在本例中是 conan_zlib.props 和 conan_bzip2.props。

将 conandeps.props 添加到您的解决方案项目文件中，如果您想依赖所有声明的依赖项。对于单项目解决方案，这可能是最佳选择。对于多项目解决方案，您可能会更有效地为每个项目添加属性文件。例如，您可以将 conan_zlib.props 属性添加到解决方案中的“project1”，将 conan_bzip2.props 添加到解决方案中的“project2”。

当包没有组件时，会生成上述文件。如果包定义了组件，则会生成以下文件：

conan_pkgname_compname_vars_release_x64.props：定义包 pkgname 的组件 compname 的变量。
conan_pkgname_compname_release_x64.props：将上述变量激活到 VS 的有效变量中，以便在构建中使用。
conan_pkgname_compname.props：包 pkgname 的组件 compname 的属性文件。它根据配置有条件地包含特定的激活属性文件。
conan_pkgname.props：包 pkgname 的属性文件。它包含并聚合了包的所有组件。
conandeps.props：与上面相同，聚合了所有直接依赖项的属性文件（例如 conan_pkgname.props）。

如果您的项目仅依赖于某些组件，则可以将特定的 conan_pkgname_compname.props 文件添加到项目中，而不是全局文件或包文件。

需求特性支持¶

上面生成的文件，特别是包含变量的文件（conan_pkgname_vars_release_x64.props/conan_pkgname_compname_vars_release_x64.props），如果需求特性已排除它们，则不会包含所有信息。例如，默认情况下，传递性依赖项的 includedirs 将为空，因为除非定义了对该包的特定 requires，否则用户不应包含这些头文件。

配置¶

如果您的 Visual Studio 项目定义了自定义配置，例如 ReleaseShared 或 MyCustomConfig，则可以在 MSBuildDeps 生成器中定义它，以便不同的项目配置可以使用不同的一组依赖项。假设我们当前的项目可以构建为共享库，具有自定义配置 ReleaseShared，并且包也通过 shared 选项控制这一点。

from conan import ConanFile
from conan.tools.microsoft import MSBuildDeps

class Pkg(ConanFile):
    settings = "os", "compiler", "arch", "build_type"
    options = {"shared": [True, False]}
    default_options = {"shared": False}
    requires = "zlib/1.3.1"

    def generate(self):
        ms = MSBuildDeps(self)
        # We assume that -o *:shared=True is used to install all shared deps too
        if self.options.shared:
            ms.configuration = str(self.settings.build_type) + "Shared"
        ms.generate()

这会为该自定义配置生成新的属性文件，在 IDE 中切换它允许收集依赖项配置，如 Debug/Release，甚至静态和/或共享库。

平台¶

默认情况下，Platform 从 Conan arch 设置计算如下：

Conan `arch`	MSBuild `Platform`
x86	Win32
x86_64	x64
armv7	ARM
armv8	ARM6

如果需要，可以覆盖此默认平台，例如对于希望使用 Platform=x86 而不是 Win32 的 Wix 项目，通过定义 platform 属性。

def generate(self):
  deps = MSBuildDeps(self)
  if self.settings.arch == "x86":
      deps.platform = "x86"  # Override the "Win32" default value
  deps.generate()

依赖项¶

MSBuildDeps 使用 self.dependencies 来访问依赖项信息。以下依赖项将被转换为属性文件：

所有直接依赖项，即当前 conanfile 声明的依赖项，位于 host 上下文中：所有常规 requires，加上位于 host 上下文中的 tool_requires，例如 gtest 或 catch 等测试框架。
所有直接依赖项的传递性 requires（全部在 host 上下文中）。
构建上下文中的工具 tool_requires，即在构建机器上运行而不考虑目标平台的应用程序和可执行文件，将被独家添加到 <ExecutablePath> 属性中，该属性的值来自 $(Conan{{name}}BinaryDirectories) 定义的属性。这允许使用 <CustomBuild> 和 <Command> 元素定义自定义构建命令，调用代码生成工具。

自定义¶

conf¶

MSBuildDeps 受以下 [conf] 变量的影响：

tools.microsoft.msbuilddeps:exclude_code_analysis：要添加到 Visual Studio CAExcludePath 属性的包名称模式列表。

参考¶

class MSBuildDeps(conanfile)¶

MSBuildDeps 类生成器 conandeps.props：无条件导入所有*直接*依赖项。

参数:: conanfile – < ConanFile 对象 > 当前配方对象。始终使用 self。

configuration¶: 定义构建类型。默认值为 settings.build_type。

configuration_key¶: 定义用于有条件选择导入哪个属性表的配置键（默认为 "Configuration"）。

platform¶: 平台名称，例如，如果 settings.arch == "x86"，则为 Win32。

platform_key¶: 定义用于有条件选择导入哪个属性表的平台键（默认为 "Platform"）。

exclude_code_analysis¶: 包名称模式列表，这些模式将作为其 conan_[DEP]_[CONFIG].props 的一部分添加到 Visual Studio CAExcludePath 属性中。默认情况下，值由 tools.microsoft.msbuilddeps:exclude_code_analysis 配置给出。

generate()¶: 在 conanfile.generators_folder 中生成 conan_<pkg>_<config>_vars.props、conan_<pkg>_<config>.props 和 conan_<pkg>.props 文件。