可编辑模式下的包

使用 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()。阅读 包布局() 部分 以了解有关此方法的更多信息。

在此示例中，say 的 conanfile.py 食谱使用了预定义的 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 预设。这需要 CMake >= 3.23，因为从 CMakeUserPresets.json 到 CMakePresets.json 的“include”仅在该版本之后才受支持。如果您不想使用预设，可以使用类似以下的方式

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

每次运行 conan install 时，如果无法使用预设功能，Conan 将显示确切的 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 食谱中的 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

请注意，如果我们在 conan build hello 命令中不传递 --build=editable，则处于可编辑模式的 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

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

警告

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