工作区¶

警告

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

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

介绍¶

重要

通过定义环境变量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 super-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。此外，子项目必须定义正确的目标，就像由find_package()脚本定义的那样，例如liba::liba。如果不是这种情况，总是可以定义一些本地的ALIAS目标。

另一个重要部分是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 super-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 super-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中开新工单。