使用依赖指南

介绍

项目将经常依赖于其他项目、资产和工件。 CMake 提供了多种方法将这些东西合并到构建中。项目和用户可以灵活地选择最适合他们需要的方法。

将依赖项引入构建的主要方法是:command:find_package 命令和:module:FetchContent 模块。 FindPkgConfig 模块有时也会被使用，尽管它缺少其他两个模块的一些集成并且在本指南中没有进一步讨论。

依赖项也可以通过自定义 dependency provider 提供。这可能是第三方包管理器，也可能是开发人员实现的自定义代码。依赖提供者与上述主要方法合作以扩展其灵活性。

使用带有 find_package() 的预构建包

项目所需的包可能已经在用户系统的某个位置构建并可用。该包也可能由 CMake 构建，或者它可能完全使用不同的构建系统。它甚至可能只是根本不需要构建的文件集合。 CMake 为这些场景提供了 find_package() 命令。它搜索众所周知的位置，以及项目或用户提供的其他提示和路径。它还支持包组件和包是可选的。提供结果变量以允许项目根据是否找到包或特定组件来自定义自己的行为。

在大多数情况下，项目通常应该使用 基本签名 。大多数时候，这将只涉及包名称，可能是版本约束，如果依赖项不是可选的，则还包括 REQUIRED 关键字。也可以指定一组包组件。

find_package() 基本签名的例子
find_package(Catch2)
find_package(GTest REQUIRED)
find_package(Boost 1.79 COMPONENTS date_time)

find_package() 命令支持两种主要的搜索方法：

配置模式

使用此方法，该命令会查找通常由包本身提供的文件。这是两者中更可靠的方法，因为包详细信息应始终与包同步。

模块模式

并非所有包都支持 CMake。许多不提供支持配置模式所需的文件。对于这种情况，可以由项目或 CMake 单独提供 Find 模块文件。 Find 模块通常是一种启发式实现，它知道包通常提供什么以及如何将该包呈现给项目。由于 Find 模块通常与包分开分发，因此它们不那么可靠。它们通常是分开维护的，并且它们可能遵循不同的发布时间表，因此它们很容易变得过时。

根据使用的参数， find_package() 可以使用上述一种或两种方法。通过将选项限制为基本签名，可以使用配置模式和模块模式来满足依赖性。其他选项的存在可能会将调用限制为仅使用两种方法中的一种，从而可能降低命令查找依赖项的能力。有关此复杂主题的完整详细信息，请参阅 find_package() 文档。

对于这两种搜索方法，用户还可以在 cmake(1) 命令行或 ccmake(1) 或 cmake-gui(1) UI 中设置缓存变量影响和覆盖在哪里可以找到包的工具。有关如何设置缓存变量的更多信息，请参阅 User Interaction Guide。

配置文件包

第三方提供可执行文件、库、标头和其他与 CMake 一起使用的文件的首选方法是提供:ref:配置文件 <Config File Packages>。这些是包附带的文本文件，定义了 CMake 目标、变量、命令等。配置文件是一个普通的 CMake 脚本，由 find_package() 命令读取。

配置文件通常可以在名称与模式 lib/cmake/<PackageName> 匹配的目录中找到，尽管它们可能位于其他位置（参见 配置模式搜索过程）。 <PackageName> 通常是 find_package() 命令的第一个参数，它甚至可能是唯一的参数。也可以使用 NAMES 选项指定替代名称：

查找包时提供替代名称
find_package(SomeThing
  NAMES
    SameThingOtherName   # Another name for the package
    SomeThing            # Also still look for its canonical name
)

配置文件必须命名为``<PackageName>Config.cmake`` 或``<LowercasePackageName>-config.cmake``（前者用于本指南的其余部分，但两者都受支持）。此文件是 CMake 包的入口点。名为“<PackageName>ConfigVersion.cmake”或“<LowercasePackageName>-config-version.cmake”的单独可选文件也可能存在于同一目录中。 CMake 使用此文件来确定包的版本是否满足调用 find_package() 时包含的任何版本约束。调用 find_package() 时指定版本是可选的，即使存在 <PackageName>ConfigVersion.cmake 文件。

如果找到 <PackageName>Config.cmake 文件并且满足任何版本约束，则 find_package() 命令认为已找到该包，并且假定整个包已按设计完成。

可能还有其他文件提供 CMake 命令或 进口目标 供您使用。 CMake 不对这些文件强制执行任何命名约定。它们通过使用 CMake:command:include 命令与主要的``<PackageName>Config.cmake`` 文件相关。 <PackageName>Config.cmake 文件通常会为您包含这些，因此除了调用 find_package() 之外，它们通常不需要任何额外的步骤。

如果包的位置在 已知的 CMake 目录 中，则 find_package() 调用应该会成功。 CMake 已知的目录是特定于平台的。例如，使用标准系统包管理器安装在 Linux 上的包将自动在“/usr”前缀中找到。安装在 Windows 上的“Program Files”中的包同样会被自动找到。

如果包位于 CMake 不知道的位置，例如 /opt/mylib 或 $HOME/dev/prefix，则不会在没有帮助的情况下自动找到它们。这是正常情况，CMake 提供了几种方式让用户指定在哪里可以找到这样的库。

CMAKE_PREFIX_PATH 变量可以在 调用 CMake 时设置 。它被视为一个基本路径列表，可在其中搜索 config files 。安装在“/opt/somepackage”中的包通常会安装配置文件，例如“/opt/somepackage/lib/cmake/somePackage/SomePackageConfig.cmake”。在这种情况下， /opt/somepackage 应该添加到 CMAKE_PREFIX_PATH 。

环境变量“CMAKE_PREFIX_PATH”也可以填充前缀以搜索包。与 PATH 环境变量一样，这是一个列表，但它需要使用特定于平台的环境变量列表项分隔符（Unix 上为 : ，Windows 上为 ; ）。

CMAKE_PREFIX_PATH 变量在需要指定多个前缀或同一前缀下有多个包可用的情况下提供便利。包的路径也可以通过设置匹配``<PackageName>_DIR``的变量来指定，例如``SomePackage_DIR``。请注意，这不是前缀，而应该是包含配置样式包文件的目录的完整路径，例如上例中的“/opt/somepackage/lib/cmake/SomePackage”。有关可能影响搜索的其他 CMake 变量和环境变量，请参阅 find_package() 文档。

查找模块文件

如果 FindSomePackage.cmake 文件可用，仍然可以使用 find_package() 命令找到不提供配置文件的包。这些 Find 模块文件与配置文件的不同之处在于：

  1. 包本身不应提供查找模块文件。

  2. Find<PackageName>.cmake 文件的可用性并不表示包或包的任何特定部分的可用性。

  3. CMake 不会在 CMAKE_PREFIX_PATH 变量中指定的位置搜索 Find<PackageName>.cmake 文件。相反，CMake 在 CMAKE_MODULE_PATH 变量给定的位置搜索此类文件。用户通常在运行 CMake 时设置 CMAKE_MODULE_PATH，CMake 项目通常附加到 CMAKE_MODULE_PATH 以允许使用本地查找模块文件。

  4. CMake 为一些第三方包 <cmake-modules(7)> 提供了 Find<PackageName>.cmake 文件。这些文件是 CMake 的维护负担，并且这些文件落后于与其关联的包的最新版本并不罕见。一般来说，新的 Find 模块不再添加到 CMake 中。项目应该鼓励上游包尽可能提供配置文件。如果不成功，项目应该为包提供自己的查找模块。

有关如何编写查找模块文件的详细讨论，请参阅 查找模块。

进口目标

配置文件和查找模块文件都可以定义 进口目标。这些通常具有“SomePrefix::ThingName”形式的名称。在这些可用的地方，项目应该更喜欢使用它们而不是也可能提供的任何 CMake 变量。这些目标通常带有使用要求，并自动将标题搜索路径、编译器定义等应用到链接到它们的其他目标（例如使用 target_link_libraries()）。这比尝试使用变量手动应用相同的东西更健壮也更方便。检查包或查找模块的文档以查看它定义的导入目标（如果有）。

导入的目标还应该封装任何特定于配置的路径。这包括二进制文件（库、可执行文件）的位置、编译器标志和任何其他与配置相关的数量。查找模块在提供这些详细信息方面可能不如配置文件可靠。

查找第三方包并使用其中的库的完整示例可能如下所示：

cmake_minimum_required(VERSION 3.10)
project(MyExeProject VERSION 1.0.0)

# Make project-provided Find modules available
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")

find_package(SomePackage REQUIRED)
add_executable(MyExe main.cpp)
target_link_libraries(MyExe PRIVATE SomePrefix::LibName)

请注意，上面对 find_package() 的调用可以通过配置文件或 Find 模块来解析。它仅使用 基本签名 支持的基本参数。例如，${CMAKE_CURRENT_SOURCE_DIR}/cmake 目录中的 FindSomePackage.cmake 文件将允许 find_package() 命令成功使用模块模式。如果不存在这样的模块文件，系统将搜索配置文件。

使用“FetchContent”从源代码下载和构建

依赖项不一定要预先构建才能与 CMake 一起使用。它们可以作为主项目的一部分从源代码构建。 FetchContent 模块提供下载内容（通常是源代码，但可以是任何内容）并将其添加到主项目（如果依赖项也使用 CMake）的功能。依赖项的源代码将与项目的其余部分一起构建，就好像这些源代码是项目自己的源代码的一部分一样。

一般模式是项目应该首先声明它想要使用的所有依赖项，然后请求它们可用。下面演示原理（更多信息参见:ref:fetch-content-examples）：

include(FetchContent)
FetchContent_Declare(
  googletest
  GIT_REPOSITORY https://github.com/google/googletest.git
  GIT_TAG        703bd9caab50b139428cea1aaff9974ebee5742e # release-1.10.0
)
FetchContent_Declare(
  Catch2
  GIT_REPOSITORY https://github.com/catchorg/Catch2.git
  GIT_TAG        605a34765aa5d5ecbf476b4598a862ada971b0cc # v3.0.1
)
FetchContent_MakeAvailable(googletest Catch2)

支持各种下载方法，包括从 URL 下载和提取存档（支持一系列存档格式），以及多种存储库格式，包括 Git、Subversion 和 Mercurial。自定义下载、更新和补丁命令也可用于支持任意用例。

当使用 FetchContent 将依赖项添加到项目时，项目将链接到依赖项的目标，就像项目中的任何其他目标一样。如果依赖项提供形式为“SomePrefix::ThingName”的命名空间目标，则项目应链接到这些目标而不是任何非命名空间目标。请参阅下一节了解为什么建议这样做。

并不是所有的依赖都可以通过这种方式引入到项目中。一些依赖项定义了名称与项目或其他依赖项中的其他目标冲突的目标。由 add_executable() 和 add_library() 创建的具体可执行文件和库目标是全局的，因此每个目标在整个构建过程中都必须是唯一的。如果依赖项会添加冲突的目标名称，则不能使用此方法将其直接引入构建中。

FetchContent 和 find_package() 集成

在 3.24 版本加入.

一些依赖项支持通过 find_package() 或 FetchContent 添加。此类依赖项必须确保它们在已安装和从源代码构建的场景中定义相同的命名空间目标。一个消费项目然后链接到那些命名空间的目标，并且可以透明地处理这两种情况，只要该项目不使用这两种方法未提供的任何其他内容。

该项目可以使用 FetchContent_Declare() 的 FIND_PACKAGE_ARGS 选项来表明它很乐意通过任一方法接受依赖项。这允许 FetchContent_MakeAvailable() 尝试首先调用 find_package() 来满足依赖关系，使用 FIND_PACKAGE_ARGS 关键字后的参数（如果有的话）。如果没有找到依赖项，它将按照前面所述从源代码构建。

include(FetchContent)
FetchContent_Declare(
  googletest
  GIT_REPOSITORY https://github.com/google/googletest.git
  GIT_TAG        703bd9caab50b139428cea1aaff9974ebee5742e # release-1.10.0
  FIND_PACKAGE_ARGS NAMES GTest
)
FetchContent_MakeAvailable(googletest)

add_executable(ThingUnitTest thing_ut.cpp)
target_link_libraries(ThingUnitTest GTest::gtest_main)

上面的例子首先调用 find_package(googletest NAMES GTest)。 CMake 提供了一个 FindGTest 模块，因此如果它找到安装在某处的 GTest 包，它将使其可用，并且不会从源代码构建依赖项。如果没有找到 GTest 包，它*将*从源代码构建。在任何一种情况下，GTest::gtest_main 目标都应该被定义，所以我们将我们的单元测试可执行文件链接到该目标。

也可以通过 FETCHCONTENT_TRY_FIND_PACKAGE_MODE 变量进行高级控制。这可以设置为 NEVER 以禁用所有重定向到 find_package()。它可以设置为 ALWAYS 来尝试 find_package() 即使没有指定 ``FIND_PACKAGE_ARGS``（这应该谨慎使用）。

该项目还可能决定必须从源代码构建特定的依赖项。如果需要依赖项的补丁版本或未发布版本，或者满足某些要求所有依赖项都从源代码构建的策略，则可能需要这样做。该项目可以通过将“OVERRIDE_FIND_PACKAGE”关键字添加到“FetchContent_Declare”来强制执行此操作。对该依赖项的调用:command:find_package 将被重定向到:command:FetchContent_MakeAvailable。

include(FetchContent)
FetchContent_Declare(
  Catch2
  URL https://intranet.mycomp.com/vendored/Catch2_2.13.4_patched.tgz
  URL_HASH MD5=abc123...
  OVERRIDE_FIND_PACKAGE
)

# The following is automatically redirected to FetchContent_MakeAvailable(Catch2)
find_package(Catch2)

有关更高级的用例，请参阅 CMAKE_FIND_PACKAGE_REDIRECTS_DIR 变量。

依赖提供者

在 3.24 版本加入.

上一节讨论了项目可用于指定其依赖项的技术。理想情况下，项目不应该真正关心依赖项来自何处，只要它提供了它期望的东西（通常只是一些导入的目标）。在没有任何其他细节的情况下，该项目说明了它需要什么，并且还可以指定从哪里获得它，以便它仍然可以开箱即用。

另一方面，开发人员可能对控制*如何*向项目提供依赖项更感兴趣。您可能想要使用您自己构建的包的特定版本。您可能想要使用第三方包管理器。出于安全或性能原因，您可能希望将某些请求重定向到您控制的系统上的不同 URL。 CMake 通过 dependency_providers 支持这些场景。

依赖项提供程序可以设置为拦截 find_package() 和 FetchContent_MakeAvailable() 调用。如果提供者不满足这些请求，则提供者有机会在回退到内置实现之前满足此类请求。

只能设置一个依赖提供者，并且只能在 CMake 运行的早期非常特定的时间点设置。 CMAKE_PROJECT_TOP_LEVEL_INCLUDES 变量列出了在处理第一个 project() 调用（并且只有那个调用）时将被读取的 CMake 文件。这是唯一可以设置依赖项提供程序的时间。在整个项目中最多只能使用一个供应商。

对于某些场景，用户不需要知道依赖提供者的设置细节。第三方可能会提供一个可以添加到 CMAKE_PROJECT_TOP_LEVEL_INCLUDES 的文件，这将代表用户设置依赖项提供程序。这是包管理器推荐的方法。开发人员可以像这样使用这样的文件：

cmake -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=/path/to/package_manager/setup.cmake ...

有关如何实现您自己的自定义依赖项提供程序的详细信息，请参阅 cmake_language(SET_DEPENDENCY_PROVIDER) 命令。