添加包的依赖

上一节教程中,我们为“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文件与之前的配方相比有一些变化。让我们检查相关的部分

...
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生成器。这在之前的配方中是不需要的,因为我们没有依赖。 CMakeDeps将生成 CMake 找到fmt库所需的所有配置文件。

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

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

  • 最后,请注意我们将validate()方法添加到了配方中。我们已经在消耗包一节中使用过此方法来为不支持的配置引发错误。在这里,我们调用函数check_min_cppstd()check_max_cppstd()来验证我们在设置中使用的 C++ 标准至少为 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 假定必需的依赖头文件是当前包的实现细节,以促进良好的软件工程实践,例如低耦合和封装。在上面的示例中,fmthello/1.0包中的纯粹实现细节。 hello/1.0的消费者将不知道任何关于fmt的信息,或者无法访问其头文件。如果hello/1.0的消费者尝试添加#include <fmt/color.h>,它将失败,无法找到该头文件。

但是,如果hello/1.0包的公共头文件包含对fmt头文件的#include,那么这些头文件必须向下传递,以便hello/1.0的消费者能够成功编译。由于这不是默认的预期行为,配方必须声明它,如下所示:

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,因此它不能滥用hellofmt头文件的传递性,而是显式声明它们。