CMakeToolchain: 在包中使用 xxx-config.cmake 文件¶

通常情况下，Conan 依赖于 package_info() 抽象，以允许使用任何构建系统构建的包可被使用任何其他构建系统构建的其他包使用。在 CMake 的情况下，Conan 依赖于 CMakeDeps 生成器为每个依赖项生成 xxxx-config.cmake 文件，即使这些依赖项没有生成文件或根本不是用 CMake 构建的。

ConanCenter 使用这种抽象，不打包 xxx-config.cmake 文件，而是使用 package_info() 中的信息。这对于提供尽可能与构建系统无关的包，并公平对待不同的构建系统、供应商和用户来说非常重要。例如，许多 Conan 用户乐于使用不包含任何 CMake 的原生 MSBuild (VS) 项目。如果 ConanCenter 包仅使用包内的 config.cmake 文件构建，这将是不可能实现的。

但 ConanCenter 这样做，并不意味着这是不可能的或强制性的。完全可以使用包内的 xxx-config.cmake 文件，放弃使用 CMakeDeps 生成器。

您可以在 GitHub 上的 examples2 仓库中找到重现此示例的源代码

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/examples/tools/cmake/pkg_config_files

如果我们查看 conanfile.py

class pkgRecipe(ConanFile):
    name = "pkg"
    version = "0.1"
    ...

    def package_info(self):
        # No information provided, only the in-package .cmake is used here
        # Other build systems or CMake via CMakeDeps will fail
        self.cpp_info.builddirs = ["pkg/cmake"]
        self.cpp_info.set_property("cmake_find_mode", "none")

这是一个非常典型的 recipe，主要区别在于 package_info() 方法。有三点需要注意

它不定义诸如 self.cpp_info.libs = ["mypkg"] 这样的字段。Conan 不会将此信息传播给消费者，此信息唯一存在的地方是包内的 xxx-config.cmake 文件中。
以防有些用户仍在使用 CMakeDeps，它通过 set_property("cmake_find_mode", "none") 禁用了 xxx-config.cmake 文件的客户端生成。
它定义了将把构建脚本（例如 xxx-config.cmake 包）包含在该文件夹中，以便消费者查找。

因此，定义包详情的责任已转移到包含以下内容的 CMakeLists.txt 中

add_library(mylib src/pkg.cpp)  # Use a different name than the package, to make sure

set_target_properties(mylib PROPERTIES PUBLIC_HEADER "include/pkg.h")
target_include_directories(mylib PUBLIC
        $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
    )

# Use non default mypkgConfig name
install(TARGETS mylib EXPORT mypkgConfig)
export(TARGETS mylib
    NAMESPACE mypkg::  # to simulate a different name and see it works
    FILE "${CMAKE_CURRENT_BINARY_DIR}/mypkgConfig.cmake"
)
install(EXPORT mypkgConfig
    DESTINATION "${CMAKE_INSTALL_PREFIX}/pkg/cmake"
    NAMESPACE mypkg::
)

有了这些信息，当执行 conan create 时

build() 方法将构建包
package() 方法将调用 cmake install，这将创建 mypkgConfig.cmake 文件
它将在包文件夹 pkg/cmake/mypkgConfig.cmake 中创建
它将包含足够的头文件信息，并创建一个 mypkg::mylib 目标。

请注意，配置文件名、命名空间和目标的详细信息也未被 Conan 所知，因此这也是消费者构建脚本应该了解的内容。

这足以使包内包含一个可供消费者使用的 mypkgConfig.cmake 文件。在此示例代码中，消费者只是 test_package/conanfile.py，但同样适用于任何任意消费者。

消费者 conanfile.py 完全不需要使用 CMakeDeps，只需使用 generators = "CMakeToolchain"。请注意，CMakeToolchain 生成器仍然是必需的，因为 mypkgConfig.cmake 需要在 Conan 缓存中找到。CMakeToolchain 生成的 conan_toolchain.cmake 文件中定义了这些路径。

消费者的 CMakeLists.txt 将是标准的

find_package(mypkg CONFIG REQUIRED)

add_executable(example src/example.cpp)
target_link_libraries(example mypkg::mylib)

您可以通过以下方式验证它是否有效

$ conan create .

======== Testing the package: Executing test ========
pkg/0.1 (test package): Running test()
pkg/0.1 (test package): RUN: Release\example
pkg/0.1: Hello World Release!
pkg/0.1: _M_X64 defined
pkg/0.1: MSVC runtime: MultiThreadedDLL
pkg/0.1: _MSC_VER1939
pkg/0.1: _MSVC_LANG201402
pkg/0.1: __cplusplus199711
pkg/0.1 test_package

重要考量¶

所提出的方法有一个限制，它不适用于多配置 IDE。实施此方法将不允许开发人员直接在 Visual Studio 等 IDE 中从 Release 切换到 Debug，反之亦然，并且需要通过 conan install 进行更改。对于单配置设置来说这完全不是问题，但对于 VS 开发人员来说可能会有些不便。团队正在开发可能有助于缓解此问题的 VS 插件。原因是 CMake 的一个限制，find_package() 只能找到一种配置，并且由于此处放弃了 CMakeDeps，Conan 无法做任何事情来避免此限制。

重要的是，正确管理对其他依赖项的传递性也是包作者和包的 CMakeLists.txt 的责任，在某些情况下这并非易事。存在风险，如果操作不正确，包内的 xxx-config.cmake 文件可能会在其他地方（例如在系统内部）找到其传递性依赖项，而不是在传递性的 Conan 包依赖项中找到。

最后，请记住，这些包除了 CMake 之外，将无法被其他构建系统使用。