添加依赖项到包中

上一教程部分中,我们为“Hello World” C++ 库创建了一个 Conan 包。我们使用了 conan.tools.scm.Git() 工具从 Git 仓库中检索源码。到目前为止,该包没有任何对其他 Conan 包的依赖。让我们解释如何以与我们在使用包部分中非常相似的方式向我们的包添加依赖项。我们将使用 fmt 库为我们的“Hello World”库添加一些花哨的颜色输出。

请首先克隆源码以重新创建此项目。您可以在 GitHub 上的 examples2 仓库中找到它们

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/creating_packages/add_requires

您会注意到 conanfile.py 文件与之前的 recipe 相比有一些变化。让我们检查相关部分

...
from conan.tools.build import check_max_cppstd, check_min_cppstd
...

class helloRecipe(ConanFile):
    name = "hello"
    version = "1.0"

    ...
    generators = "CMakeDeps"
    ...

    def validate(self):
        check_min_cppstd(self, "11")
        check_max_cppstd(self, "20")

    def requirements(self):
        self.requires("fmt/8.1.1")

    def source(self):
        git = Git(self)
        git.clone(url="https://github.com/conan-io/libhello.git", target=".")
        # Please, be aware that using the head of the branch instead of an immutable tag
        # or commit is not a good practice in general
        git.checkout("require_fmt")
  • 首先,我们设置了 generators 类属性,以便 Conan 调用 CMakeDeps 生成器。在之前的 recipe 中不需要这样做,因为我们没有依赖项。CMakeDeps 将生成 CMake 查找 fmt 库所需的所有配置文件。

  • 接下来,我们使用 requires() 方法将 fmt 依赖项添加到我们的包中。

  • 请注意,我们在 source() 方法中添加了一行。我们使用 Git().checkout() 方法来检出 require_fmt 分支中的源代码。此分支包含源码中为库消息添加颜色的更改,以及 CMakeLists.txt 中声明我们正在使用 fmt 库的更改。

  • 最后,请注意我们在 recipe 中添加了 validate() 方法。我们已经在使用包部分中使用了此方法,以针对不支持的配置引发错误。在这里,我们调用函数 check_min_cppstd()check_max_cppstd() 来验证我们的设置中至少使用了 C++11 标准,最多使用了 C++20 标准。

您可以在 require_fmt 分支中查看使用 fmt 库的新源码。您会看到 hello.cpp 文件为输出消息添加了颜色。

#include <fmt/color.h>

#include "hello.h"

void hello(){
    #ifdef NDEBUG
    fmt::print(fg(fmt::color::crimson) | fmt::emphasis::bold, "hello/1.0: Hello World Release!\n");
    #else
    fmt::print(fg(fmt::color::crimson) | fmt::emphasis::bold, "hello/1.0: Hello World Debug!\n");
    #endif
    ...

让我们使用当前默认配置从源码构建包,然后让 test_package 文件夹测试该包。现在您应该会看到带有颜色的输出消息。

$ conan create . --build=missing
-------- Exporting the recipe ----------
...
-------- Testing the package: Running test() ----------
hello/1.0 (test package): Running test()
hello/1.0 (test package): RUN: ./example
hello/1.0: Hello World Release!
  hello/1.0: __x86_64__ defined
  hello/1.0: __cplusplus 201103
  hello/1.0: __GNUC__ 4
  hello/1.0: __GNUC_MINOR__ 2
  hello/1.0: __clang_major__ 13
  hello/1.0: __clang_minor__ 1
  hello/1.0: __apple_build_version__ 13160021

头文件传递性

默认情况下,Conan 假定所需的依赖项头文件是当前包的实现细节,以促进良好的软件工程实践,例如低耦合和封装。在上面的示例中,fmt 纯粹是 hello/1.0 包的实现细节。hello/1.0 的消费者将不会知道关于 fmt 的任何信息,或者无法访问其头文件,如果 hello/1.0 的消费者尝试添加 #include <fmt/color.h>,它将失败,无法找到这些头文件。

但是,如果 hello/1.0 包的公共头文件包含对 fmt 头文件的 #include,这意味着这些头文件必须向下传播,以允许 hello/1.0 的消费者成功编译。由于这并非默认预期行为,因此 recipe 必须声明为

class helloRecipe(ConanFile):
    name = "hello"
    version = "1.0"

    def requirements(self):
        self.requires("fmt/8.1.1", transitive_headers=True)

这将把必要的编译标志和头文件 includedirs 传播给 hello/1.0 的消费者。

注意

最佳实践

如果 hello/1.0 的消费者直接包含了 fmt 头文件,例如 #include <fmt/color.h>,那么该消费者应该声明自己的 self.requires("fmt/8.1.1") 要求,因为这是一个直接要求。换句话说,即使从该消费者中删除了对 hello/1.0 的依赖,它仍然会依赖 fmt,因此它不能滥用 fmt 头文件从 hello 传递的特性,而必须显式声明它们。