为多个配置构建：Release、Debug、静态和共享

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

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/consuming_packages/different_configurations

到目前为止，我们构建了一个依赖于 **zlib** 库的简单 CMake 项目，并了解了 tool_requires，这是一种用于 CMake 等构建工具的特殊类型的 requirements。在这两种情况下，我们都没有在任何地方指定我们希望以 *Release* 或 *Debug* 模式构建应用程序，或者我们是否希望链接到 *静态* 或 *共享* 库。这是因为 Conan 如果没有得到其他指示，将使用在“默认配置文件”中声明的默认配置。此默认配置文件是在我们运行 conan profile detect 命令时在第一个示例中创建的。Conan 将此文件存储在 **/profiles** 文件夹中，该文件夹位于 Conan 用户主目录中。您可以通过运行 conan config home 命令来获取 Conan 用户主目录的位置，然后显示 **/profiles** 文件夹中默认配置文件的内容来检查默认配置文件的内容。

$ conan config home
Current Conan home: /Users/tutorial_user/.conan2

# output the file contents
$ cat /Users/tutorial_user/.conan2/profiles/default
[settings]
os=Macos
arch=x86_64
compiler=apple-clang
compiler.version=14.0
compiler.libcxx=libc++
compiler.cppstd=gnu11
build_type=Release
[options]
[tool_requires]
[env]

# The default profile can also be checked with the command "conan profile show"

如您所见，配置文件具有不同的部分。 [settings] 部分包含有关操作系统、体系结构、编译器和构建配置等信息。

当您调用 Conan 命令并设置 --profile 参数时，Conan 将获取配置文件中的所有信息并将其应用于您要构建或安装的包。如果您没有指定该参数，则等同于使用 --profile=default 调用它。这两个命令的行为相同。

$ conan install . --build=missing
$ conan install . --build=missing --profile=default

您可以存储不同的配置文件并使用它们来构建不同的设置。例如，要使用 build_type=Debug，或向使用该配置文件构建的所有包添加 tool_requires。我们将创建一个 *debug* 配置文件以尝试使用不同的配置进行构建。

<conan home>/profiles/debug

[settings]
os=Macos
arch=x86_64
compiler=apple-clang
compiler.version=14.0
compiler.libcxx=libc++
compiler.cppstd=gnu11
build_type=Debug

修改设置：对应用程序及其依赖项使用 Debug 配置

使用配置文件不是设置要使用的配置的唯一方法。您还可以使用 --settings 参数在 Conan 命令中覆盖配置文件设置。例如，您可以从前面的示例中构建项目，使用 *Debug* 配置而不是 *Release* 配置。

在构建之前，请检查我们是否修改了前面示例中的源代码，以显示构建源代码时使用的构建配置。

#include <stdlib.h>
...

int main(void) {
    ...
    #ifdef NDEBUG
    printf("Release configuration!\n");
    #else
    printf("Debug configuration!\n");
    #endif

    return EXIT_SUCCESS;
}

现在让我们为 *Debug* 配置构建我们的项目。

$ conan install . --output-folder=build --build=missing --settings=build_type=Debug

如上所述，这等同于拥有 *debug* 配置文件并使用 --profile=debug 参数而不是 --settings=build_type=Debug 参数运行这些命令。

此 conan install 命令将检查我们是否已经在本地缓存 (Zlib) 中拥有 Debug 配置所需的库，如果没有则获取它们。它还将在 conan_toolchain.cmake 和 CMakePresets.json 文件中更新构建配置，这些文件由 CMakeToolchain 生成器创建，以便在构建应用程序时以 *Debug* 配置进行构建。现在像在前面的示例中一样构建您的项目，并在输出中检查它是如何以 *Debug* 配置构建的。

Windows

# assuming Visual Studio 15 2017 is your VS version and that it matches your default profile
$ cd build
$ cmake .. -G "Visual Studio 15 2017" -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake
$ cmake --build . --config Debug
$ Debug\compressor.exe
Uncompressed size is: 233
Compressed size is: 147
ZLIB VERSION: 1.2.11
Debug configuration!

Linux、macOS

$ cd build
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Debug
$ cmake --build .
$ ./compressor
Uncompressed size is: 233
Compressed size is: 147
ZLIB VERSION: 1.2.11
Debug configuration!

修改选项：将应用程序依赖项链接为共享库

到目前为止，我们一直在应用程序中静态链接 *Zlib*。这是因为在 Zlib 的 Conan 包中，有一个属性设置为默认以该模式构建。我们可以通过使用 --options 参数将 shared 选项设置为 True 来将链接从 **static** 更改为 **shared**。为此，请运行

$ conan install . --output-folder=build --build=missing --options=zlib/1.2.11:shared=True

这样做，Conan 将安装 *Zlib* 共享库，生成使用它们构建的文件，以及在运行应用程序时找到这些动态库所需的文件。

注意

选项是针对每个包定义的。在这种情况下，我们定义了我们希望将特定版本的 zlib/1.2.11 作为共享库。如果我们有其他依赖项，并且希望所有依赖项（只要可能）都作为共享库，我们将使用 -o *:shared=True，其中 * 模式匹配所有包引用。

在配置为将 *Zlib* 链接为共享库后，让我们再次构建应用程序。

Windows

$ cd build
# assuming Visual Studio 15 2017 is your VS version and that it matches your default profile
$ cmake .. -G "Visual Studio 15 2017" -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake
$ cmake --build . --config Release
...
[100%] Built target compressor

Linux、Macos

$ cd build
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release
$ cmake --build .
...
[100%] Built target compressor

现在，如果您尝试运行编译后的可执行文件，您将看到一个错误，因为可执行文件找不到我们刚刚安装的 *Zlib* 的共享库。

Windows

$ Release\compressor.exe
(on a pop-up window) The code execution cannot proceed because zlib1.dll was not found. Reinstalling the program may fix this problem.
# This error depends on the console being used and may not always pop up.
# It could run correctly if the console gets the zlib dll from a different path.

Linux

$ ./compressor
./compressor: error while loading shared libraries: libz.so.1: cannot open shared object file: No such file or directory

Macos

$ ./compressor
./compressor: dyld[41259]: Library not loaded: @rpath/libz.1.dylib

这是因为共享库（Windows 中的 *。dll*，OSX 中的 *。dylib* 和 Linux 中的 *。so*）是在运行时加载的。这意味着应用程序可执行文件需要知道在运行时所需的共享库在哪里。在 Windows 上，动态链接器将搜索同一目录，然后搜索 *PATH* 目录。在 OSX 上，它将搜索在 *DYLD_LIBRARY_PATH* 中声明的目录，就像 Linux 使用 *LD_LIBRARY_PATH* 一样。

Conan 提供了一种定义这些变量并使其成为可能，以便可执行文件可以找到并加载这些共享库的机制。这种机制是 VirtualRunEnv 生成器。如果您检查输出文件夹，您将看到 Conan 生成一个名为 conanrun.sh/bat 的新文件。这是在我们在执行 conan install 时激活 shared 选项时自动调用该 VirtualRunEnv 生成器的结果。此生成的脚本将设置 **PATH**、**LD_LIBRARY_PATH**、**DYLD_LIBRARY_PATH** 和 **DYLD_FRAMEWORK_PATH** 环境变量，以便可执行文件可以找到共享库。

激活虚拟环境，然后再次运行可执行文件。

Windows

$ conanrun.bat
$ Release\compressor.exe
Uncompressed size is: 233
Compressed size is: 147
...

Linux、macOS

$ source conanrun.sh
$ ./compressor
Uncompressed size is: 233
Compressed size is: 147
...

就像前面使用 VirtualBuildEnv 生成器的示例一样，当我们运行 conanrun.sh/bat 脚本时，将创建一个名为 deactivate_conanrun.sh/bat 的停用脚本以恢复环境。源或运行它来做到这一点。

Windows

$ deactivate_conanrun.bat

Linux、macOS

$ source deactivate_conanrun.sh

设置和选项之间的区别

您可能已经注意到，对于在 *Debug* 和 *Release* 配置之间切换，我们使用了 Conan **设置**，但是当我们为可执行文件设置 *shared* 模式时，我们使用了 Conan **选项**。请注意 **设置** 和 **选项** 之间的区别。

• **设置** 通常是客户端机器定义的项目范围的配置。例如操作系统、编译器或构建配置，这些配置将对多个 Conan 包通用，并且仅为其中一个定义一个默认值是没有意义的。例如，对于 Conan 包声明“Visual Studio”作为默认编译器是没有意义的，因为这是最终用户定义的，并且如果他们在 Linux 中工作则不太可能说得通。

• **选项** 用于包特定的配置，可以在配方中将其设置为默认值。例如，一个包可以定义其默认链接是静态的，如果使用者没有另行指定，则应使用此链接。

介绍包 ID 的概念

当使用具有不同 *settings* 和 *options* 的包（如 Zlib）时，您可能想知道 Conan 如何确定要从远程获取哪个二进制文件。答案在于 *package_id* 的概念。

*package_id* 是 Conan 用于确定包的二进制兼容性的标识符。它是根据几个因素计算出来的，包括包的 *settings*、*options* 和依赖项。当您修改任何这些因素时，Conan 会计算一个新的 *package_id* 来引用相应的二进制文件。

以下是该过程的细分。

1. **确定设置和选项**：Conan 首先检索用户的输入设置和选项。这些可以来自命令行或配置文件，例如 *–settings=build_type=Debug* 或 *–profile=debug*。

2. **计算包 ID**：使用 *settings*、*options* 和依赖项的当前值，Conan 计算一个哈希值。此哈希值用作 *package_id*，表示二进制包的唯一标识。

3. **获取二进制文件**：然后，Conan 检查其缓存或指定的远程存储库中是否存在具有计算出的 *package_id* 的二进制包。如果找到匹配项，它将检索该二进制文件。如果没有，Conan 可以从源代码构建包或指示二进制文件丢失。

在我们的教程的上下文中，当我们使用具有不同 *settings* 和 *options* 的 Zlib 时，Conan 使用 *package_id* 来确保它获取与我们指定的配置匹配的正确二进制文件。

另请参阅

• VirtualRunEnv 参考

• 使用 –profile:build 和 –profile:host 进行交叉编译

• Conan 包的二进制兼容性：包 ID

• 使用 conan config install 安装配置

• VS 多配置

• 设置和选项如何影响包 ID

• 使用模式设置选项