使用Conan Workspace实现CMake多项目仓库的依赖管理

前言

在现代C++开发中，多项目仓库(Monorepo)的组织方式越来越受到欢迎，特别是对于包含多个相互依赖的库和可执行项目的大型代码库。本文将详细介绍如何使用Conan的Workspace功能来管理这种复杂场景下的依赖关系。

Conan Workspace简介

Conan Workspace是Conan包管理器提供的一个孵化阶段功能，专门用于解决多项目仓库中的依赖管理问题。它允许开发者：

1. 将多个本地项目声明为"可编辑"状态
2. 建立项目间的依赖关系
3. 支持从根目录构建整个项目集合
4. 保持与单独打包发布的能力

典型项目结构分析

一个典型的多项目仓库可能包含以下组件：

• 多个核心库(lib_core, lib_fleet等)
• 若干应用程序(app1, app2等)
• 共享的第三方依赖

传统的CMake通过add_subdirectory可以方便地组织这种结构，但当需要独立版本控制和发布时，就需要更精细的依赖管理。

配置Conan Workspace

基础配置

创建一个conanws.yml文件定义工作区：

editables:
 lib_core/0.0.1:
    path: Core
 lib_fleet/0.0.1:
    path: fleet
 app1/0.0.1:
    path: apps/app1

products:
  - apps/app1

workspace_generators: cmake

各项目的conanfile.py

每个子项目需要自己的conanfile.py，例如：

from conan import ConanFile
from conan.tools.cmake import CMake, cmake_layout

class LibCoreConan(ConanFile):
    name = "lib_core"
    version = "0.0.1"
    
    settings = "os", "arch", "compiler", "build_type"
    options = {"shared": [True, False]}
    default_options = {"shared": False}
    
    exports_sources = "CMakeLists.txt", "src/*", "include/*"
    
    requires = ("boost/1.87.0", "openssl/3.4.1")
    
    def layout(self):
        cmake_layout(self)
        
    def build(self):
        cmake = CMake(self)
        cmake.configure()
        cmake.build()
        
    def package(self):
        cmake = CMake(self)
        cmake.install()
        
    def package_info(self):
        self.cpp_info.libs = ["lib_core"]

构建流程

初始化工作区

conan workspace install

此命令会：

1. 解析所有依赖关系
2. 生成必要的构建文件
3. 创建CMake预设配置

构建整个项目

cmake --preset conan-release
cmake --build build/Release -j4

构建特定目标

cmake --build build/Release --target lib_core

高级用法

多配置构建

Workspace支持同时管理多个构建配置(Release/Debug等)，CMake预设文件会自动包含所有配置的生成器。

独立打包

虽然Workspace提供了整体构建能力，但每个库仍可独立打包发布：

cd Core
conan create .

最佳实践建议

1. 保持简单：开始时只配置必要的editables和products
2. 逐步迁移：从单个库开始，逐步添加其他组件
3. 版本一致：确保工作区中各项目的版本号协调一致
4. CI集成：在CI中同时测试整体构建和独立打包
5. 文档记录：为团队维护清晰的Workspace配置说明

常见问题解决

1. 缺少CMake预设文件：确保使用了正确的workspace_generators配置
2. 依赖解析失败：检查各conanfile.py中的requires是否一致
3. 构建类型不匹配：确认所有项目使用相同的settings配置

总结

Conan Workspace为C++多项目仓库提供了强大的依赖管理能力，既保持了整体构建的便利性，又不失独立组件的灵活性。虽然目前仍处于孵化阶段，但其设计理念和功能已经能够满足大多数复杂项目的需求。对于正在考虑如何组织大型C++代码库的团队，Conan Workspace无疑是一个值得认真评估的解决方案。