可编辑模式的包¶

使用 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

此项目中有 2 个文件夹

.
├── 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 包处于可编辑模式，让我们在本地构建它

注意

在此示例中，我们使用 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 将在每次运行 conan install 时显示确切的 CMake 命令。

$ cd say

# Windows: we will build 2 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 only build 1 configuration
$ conan install .
$ cmake --preset conan-release
$ cmake --build --preset conan-release

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

从消费者的角度来看，使用可编辑模式的包是透明的。在这种情况下，我们可以照常构建 hello 应用程序

$ cd ../hello

# Windows: we will build 2 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 1 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 2 configurations to show multi-config
$ cmake --build --preset conan-release
$ cmake --build --preset conan-debug

# Linux, MacOS: we will only build 1 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

请注意，如果我们不将 --build=editable 传递给 conan build hello，则处于可编辑模式的 say/0.1 的二进制文件将不可用，并且会失败。使用 --build=editable，首先在本地增量完成 say 二进制文件的构建，然后将增量完成 hello 的另一个构建。一切仍将在本地发生，而不会在缓存中构建任何包。如果有多个 editable 依赖项，以及嵌套的传递依赖项，Conan 将按正确的顺序构建它们。

如果可编辑包在 Conan 缓存中具有依赖项，则可以使用 --build=editable --build=cascade 强制从源代码重建缓存依赖项。通常应避免这种情况，如果需要重建这些依赖项，建议也将它们置于可编辑模式。

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

恢复可编辑模式¶

为了恢复可编辑模式，只需使用以下命令删除链接

$ conan editable remove --refs=say/1.0

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

警告

在上游使用可编辑包构建的包可能会生成与可编辑包的发布版本不兼容的二进制文件和包。避免上传这些包，而无需使用所有库的缓存内版本重新创建它们。