可编辑模式下的软件包¶

与 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()。请阅读 package 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 presets。这需要 CMake >= 3.23，因为 CMakeUserPresets.json 到 CMakePresets.json 的“include”功能自该版本起才受支持。如果您不想使用 presets，可以使用类似以下的方式：

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

如果您无法使用预设功能，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 软件包的头文件和库文件。

处理可编辑软件包¶

完成上述步骤后，您可以在不涉及 Conan 的情况下使用您的构建系统或 IDE 来处理可编辑软件包并对其进行更改。任何更改将直接应用于使用者。让我们通过更改 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

请注意，如果我们不将 --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

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

警告

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