可编辑模式下的包

使用 Conan 包的常规方式是运行 conan create 或 conan export-pkg 将它们存储在本地缓存中，以便使用者可以使用缓存中存储的包。在某些情况下，当您想在开发这些包的同时使用它们时，每次更改包时都运行 conan create 可能会很繁琐。对于这些情况，您可以将包设置为可编辑模式，使用者将能够在您的本地工作目录中找到头文件和构建产物，从而无需进行打包。

让我们看看如何将包设置为可编辑模式并从本地工作目录中使用它。

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

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/developing_packages/editable_packages

此项目中有两个文件夹：

.
├── hello
│   ├── CMakeLists.txt
│   ├── conanfile.py
│   └── src
│       └── hello.cpp
└── say
    ├── CMakeLists.txt
    ├── conanfile.py
    ├── include
    │   └── say.h
    └── src
        └── say.cpp

• 一个“say”文件夹，其中包含一个完整的包，以及其 conanfile.py 和源代码。

• 一个“hello”文件夹，其中包含一个简单的消费者项目，以及其 conanfile.py 和源代码，它依赖于 say/1.0 依赖项。

我们将把 say/1.0 设置为可编辑模式，并展示 hello 消费者如何在本地工作目录中找到 say/1.0 的头文件和二进制文件。

将 say/1.0 包设置为可编辑模式

为了避免每次更改时都在缓存中创建 say/1.0 包，我们将把该包设置为可编辑模式，从而在缓存中的引用与本地工作目录之间创建一个链接。

$ conan editable add say
$ conan editable list
say/1.0
    Path: /Users/.../examples2/tutorial/developing_packages/editable_packages/say/conanfile.py

从现在起，任何其他 Conan 包或项目对 say/1.0 的使用都将被重定向到用户文件夹 /Users/.../examples2/tutorial/developing_packages/editable_packages/say/conanfile.py，而不是使用 Conan 缓存中的包。

请注意，可编辑包的关键在于正确定义包的 layout() 方法。阅读包布局(layout())部分以了解更多关于此方法的信息。

在本例中，say 的 conanfile.py recipe 使用了预定义的 cmake_layout()，它定义了典型的 CMake 项目布局，该布局可能因所使用的平台和生成器而异。

现在 say/1.0 包已设置为可编辑模式，让我们在本地构建它。

$ cd say

# Windows: we will build two configurations to show multi-config
$ conan install . -s build_type=Release
$ conan install . -s build_type=Debug
$ cmake --preset conan-default
$ cmake --build --preset conan-release
$ cmake --build --preset conan-debug

# Linux, macOS: we will build only one configuration
$ conan install .
$ cmake --preset conan-release
$ cmake --build --preset conan-release

注意

本示例中使用了 CMake preset。这要求 CMake 版本 >= 3.23，因为 CMakeUserPresets.json 到 CMakePresets.json 的“include”功能仅在该版本之后才支持。如果您不想使用 preset，可以使用类似如下的方式：

cmake <path> -G <CMake generator> -DCMAKE_TOOLCHAIN_FILE=<path to
conan_toolchain.cmake> -DCMAKE_BUILD_TYPE=Release

如果您无法使用 preset 功能，Conan 会在每次运行 conan install 时显示确切的 CMake 命令。

在可编辑模式下使用 say/1.0 包

从消费者角度来看，使用可编辑模式的包是透明的。在本例中，我们可以像往常一样构建 hello 应用程序。

$ cd ../hello

# Windows: we will build two configurations to show multi-config
$ conan install . -s build_type=Release
$ conan install . -s build_type=Debug
$ cmake --preset conan-default
$ cmake --build --preset conan-release
$ cmake --build --preset conan-debug
$ build\Release\hello.exe
say/1.0: Hello World Release!
...
$ build\Debug\hello.exe
say/1.0: Hello World Debug!
...

# Linux, macOS: we will only build one configuration
$ conan install .
$ cmake --preset conan-release
$ cmake --build --preset conan-release
$ ./build/Release/hello
say/1.0: Hello World Release!

如您所见，hello 可以成功找到 say/1.0 包的头文件和库文件。

使用可编辑包

完成上述步骤后，您可以使用您的构建系统或 IDE 进行工作，而无需涉及 Conan，并且可以更改可编辑包。任何更改都将直接影响消费者。让我们通过更改 say 源代码来了解其工作原理。

$ cd ../say
# Edit src/say.cpp and change the error message from "Hello" to "Bye"

# Windows: we will build two configurations to show multi-config
$ cmake --build --preset conan-release
$ cmake --build --preset conan-debug

# Linux, macOS: we will only build one configuration
$ cmake --build --preset conan-release

并构建和运行“hello”项目。

$ cd ../hello

# Windows
$ cd build
$ cmake --build --preset conan-release
$ cmake --build --preset conan-debug
$ Release\hello.exe
say/1.0: Bye World Release!
$ Debug\hello.exe
say/1.0: Bye World Debug!

# Linux, macOS
$ cmake --build --preset conan-release
$ ./hello
say/1.0: Bye World Release!

通过这种方式，您可以同时开发 say 库和 hello 应用程序，而无需在两者之间执行任何 Conan 命令。如果两者都在您的 IDE 中打开，您可以简单地依次构建它们。

构建可编辑的依赖项

如果有很多可编辑的依赖项，逐个按照正确顺序构建它们可能会很不方便。可以使用 --build 参数对可编辑的依赖项进行有序构建。

首先清除之前本地的可执行文件。

$ git clean -xdf

使用我们在 hello/conanfile.py recipe 中至今尚未真正使用的 build() 方法（因为我们一直直接调用 cmake 进行构建，而不是调用 conan build 命令），我们可以只通过以下命令进行构建：

$ conan build hello

注意，要完成此项目的完整构建，我们只需执行这两个命令。在一个不同的文件夹中从头开始：

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/developing_packages/editable_packages
$ conan editable add say
$ conan build hello --build=editable

注意，如果我们不将 --build=editable 参数传递给 conan build hello，处于可编辑模式的 say/0.1 的二进制文件将不可用，并且会失败。使用 --build=editable 后，首先会在本地增量构建 say 的二进制文件，然后再次对 hello 进行增量构建。所有操作都仍然在本地进行，不会在缓存中构建任何包。如果存在多个 editable 依赖项，并且包含嵌套的传递性依赖项，Conan 将按正确顺序构建它们。

如果可编辑包在 Conan 缓存中有依赖它的包，可以使用 --build=editable --build=cascade 参数强制从源代码重建缓存中的依赖包。然而，通常应避免这样做。如果需要重建这些依赖项，建议也将它们设置为可编辑模式。

请注意，可以使用包自己的 test_package 文件夹在可编辑模式下构建和测试包。如果一个包被设置为可编辑模式，并且它包含 test_package 文件夹，conan create 命令仍将对当前包进行本地构建。

恢复非可编辑模式

要禁用包的可编辑模式，只需使用以下命令删除链接：

$ conan editable remove --refs=say/1.0

它将删除链接（本地目录不受影响），并且所有使用此依赖项的包将再次从缓存中获取它。

警告

在使用上游的可编辑包时构建的包可能会生成与可编辑包的发布版本不兼容的二进制文件和包。请避免在未重新使用缓存中的所有库版本重新创建这些包的情况下上传它们。