工作区¶

警告

此功能是新的孵化中功能的一部分。这意味着它正在开发中，并正在寻求用户测试和反馈。更多信息请参阅孵化部分。

在上一节中，我们学习了*可编辑包*以及如何定义自定义布局。现在我们来介绍*工作区*的概念以及如何使用它。

简介¶

重要

可以通过定义环境变量 CONAN_WORKSPACE_ENABLE=will_break_next 来启用工作区功能。值 will_break_next 用于强调它将在后续版本中更改，并且此功能仅用于测试，不能用于生产。

Conan *工作区* 使您有机会以*编排式*或*单体式*（也称为*超级项目*）方式将多个包作为 editable 模式进行管理

*编排式*，我们指 Conan 在应用程序/消费者存在的情况下，逐个构建可编辑包。
*单体式*，我们指将可编辑包作为一个整体构建，为整个工作区生成单个结果（生成器等）。

请注意，添加到工作区的包会自动解析为 editable 包。这些可编辑包被称为工作区的 packages。

如何定义工作区¶

工作区由 conanws.yml 和/或 conanws.py 文件定义。任何 Conan 工作区命令将从当前工作目录向上遍历文件系统直到文件系统根目录，直到找到其中一个文件。这将定义“根”工作区文件夹。conanws 文件中的路径旨在是相对的，以便在必要时可重定位，或者可以提交到类似 Monorepo 的 Git 项目中。

通过 conan workspace 命令，我们可以打开、添加和/或从当前工作区中移除 packages。

另请参阅

阅读工作区文件部分。阅读 conan workspace 命令部分。

单体构建¶

Conan 工作区可以构建为单个单体项目（超级项目），这非常方便。让我们通过一个例子来看看。

$ conan new workspace
$ conan workspace install
$ cmake --preset conan-release # use conan-default in Win
$ cmake --build --preset conan-release

让我们稍微解释一下发生了什么。首先，conan new workspace 创建了一个模板项目，其中包含一些相关文件和以下结构：

.
├── CMakeLists.txt
├── app1
│    ├── CMakeLists.txt
│    ├── conanfile.py
│    ├── src
│    │    ├── app1.cpp
│    │    ├── app1.h
│    │    └── main.cpp
│    └── test_package
│        └── conanfile.py
├── conanws.py
├── conanws.yml
├── liba
│    ├── CMakeLists.txt
│    ├── conanfile.py
│    ├── include
│    │    └── liba.h
│    ├── src
│    │    └── liba.cpp
│    └── test_package
│        ├── CMakeLists.txt
│        ├── conanfile.py
│        └── src
│            └── example.cpp
└── libb
    ├── CMakeLists.txt
    ├── conanfile.py
    ├── include
    │    └── libb.h
    ├── src
    │    └── libb.cpp
    └── test_package
        ├── CMakeLists.txt
        ├── conanfile.py
        └── src
            └── example.cpp

根 CMakeLists.txt 定义了超级项目：

CMakeLists.txt¶

cmake_minimum_required(VERSION 3.25)
project(monorepo CXX)

include(FetchContent)

function(add_project SUBFOLDER)
   FetchContent_Declare(
      ${SUBFOLDER}
      SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/${SUBFOLDER}
      SYSTEM
      OVERRIDE_FIND_PACKAGE
   )
   FetchContent_MakeAvailable(${SUBFOLDER})
endfunction()

add_project(liba)
# They should be defined in the liba/CMakeLists.txt, but we can fix it here
add_library(liba::liba ALIAS liba)
add_project(libb)
add_library(libb::libb ALIAS libb)
add_project(app1)

因此，超级项目基本上使用 FetchContent 来添加子文件夹的子项目。为了使其正常工作，子项目必须是基于 CMake 的子项目，并包含 CMakeLists.txt。此外，子项目必须定义正确的Target，就像 find_package() 脚本所定义的那样，例如 liba::liba。如果不是这种情况，总是可以定义一些本地 ALIAS Target。

另一个重要的部分是 conanws.py 文件：

conanws.py¶

from conan import Workspace
from conan import ConanFile
from conan.tools.cmake import CMakeDeps, CMakeToolchain, cmake_layout

class MyWs(ConanFile):
   """ This is a special conanfile, used only for workspace definition of layout
   and generators. It shouldn't have requirements, tool_requirements. It shouldn't have
   build() or package() methods
   """
   settings = "os", "compiler", "build_type", "arch"

   def generate(self):
      deps = CMakeDeps(self)
      deps.generate()
      tc = CMakeToolchain(self)
      tc.generate()

   def layout(self):
      cmake_layout(self)

class Ws(Workspace):
   def root_conanfile(self):
      return MyWs  # Note this is the class name

class MyWs(ConanFile) 内嵌的 conanfile 的作用很重要，它定义了超级项目所需的生成器和布局。

conan workspace install 命令不会单独安装不同的可编辑项，对于此命令，可编辑项不存在，它们在依赖图表中被视为单个“节点”，因为它们将成为超级项目构建的一部分。因此，所有超级项目外部依赖项都只有一个生成的 conan_toolchain.cmake 和一组公共的 xxx-config.cmake 依赖文件。

上述模板在没有外部依赖项的情况下工作正常，但当存在外部依赖项时，一切都将以相同的方式工作。这可以通过以下方式测试：

$ conan new cmake_lib -d name=mymath
$ conan create .
$ conan new workspace -d requires=mymath/0.1
$ conan workspace install
$ cmake ...

注意

当前的 conan new workspace 命令会生成一个基于 CMake 的超级项目。但是，也可以使用其他构建系统来定义超级项目，例如添加不同 .vcxproj 子项目的 MSBuild 解决方案文件。只要超级项目知道如何聚合和管理子项目，这是可能的。

如果存在某种结构，conanws.py 中的 add() 方法也可能管理子项目到超级项目的添加。

编排式构建¶

Conan 工作区还可以单独构建不同的 packages，并考虑是否存在定义为其他包消费者的包。

让我们使用另一种结构来更好地理解它是如何工作的。现在，让我们从头开始创建它，使用 conan workspace init . 命令创建一个几乎空的 conanws.py/conanws.yml，并使用 conan new cmake_lib/cmake_exe 基本模板，这些模板创建常规的基于 CMake 的 Conan 包：

$ mkdir myproject && cd myproject
$ conan workspace init .
$ conan new cmake_lib -d name=hello -d version=1.0 -o hello
$ conan new cmake_exe -d name=app -d version=1.0 -d requires=hello/1.0 -o app

这些命令创建的文件结构如下：

.
├── conanws.py
├── conanws.yml
├── app
│    ├── CMakeLists.txt
│    ├── conanfile.py
│    ├── src
│    │    ├── app.cpp
│    │    ├── app.h
│    │    └── main.cpp
│    └── test_package
│        └── conanfile.py
└── hello
     ├── CMakeLists.txt
     ├── conanfile.py
     ├── include
     │    └── hello.h
     ├── src
     │    └── hello.cpp
     └── test_package
         ├── CMakeLists.txt
         ├── conanfile.py
         └── src
             └── example.cpp

现在，conanws.yml 是空的，conanws.py 也有一个非常简单的定义。让我们将 app 应用程序（消费 hello）和 hello 库作为新的 packages 添加到工作区。

$ conan workspace add hello
Reference 'hello/1.0' added to workspace
$ conan workspace add app
Reference 'app/1.0' added to workspace

定义了工作区的 packages 后，我们可以构建它们并执行应用程序。

$ conan workspace build
$ app/build/Release/app
hello/1.0: Hello World Release!
...
app/1.0: Hello World Release!
...

如有任何反馈，请在 https://github.com/conan-io/conan/issues 中提交新工单。