1. 项目概述为什么C开发者需要Conan2如果你是一名C开发者无论你是刚入行的新人还是摸爬滚打多年的老手我相信你都经历过“依赖地狱”的折磨。项目启动第一件事不是写代码而是花上半天甚至几天时间去网上四处寻找一个能用的第三方库。找到了源码还得自己编译面对各种平台Windows、Linux、macOS和编译器MSVC、GCC、Clang的组合一个配置不对就是满屏的编译错误。好不容易编译通过了怎么把它集成到你的CMakeLists.txt或者Visual Studio项目里又是一道坎。更别提团队协作了你本地跑得好好的同事一拉代码就报错原因可能是他电脑上装的库版本和你不一样或者干脆没装。这种体验让C开发的门槛无形中拔高了许多也严重拖慢了开发效率。反观隔壁的Python、JavaScript、Go等语言pip、npm、go mod等包管理工具早已是标配一行命令就能安装、更新、管理依赖版本清晰环境隔离协作无忧。C世界长期以来缺少这样一个“官方钦定”的、生态统一的解决方案直到Conan的出现。Conan是一个开源、去中心化的C/C包管理器。简单来说它就像C世界的pip或npm。你不再需要手动下载、编译、配置第三方库。你只需要在一个名为conanfile.txt或conanfile.py的文件里声明你的项目需要什么库比如OpenSSL/1.1.1w然后运行conan install命令。Conan会自动从远程仓库可以是官方的conancenter也可以是你们公司搭建的私有仓库下载对应平台和编译器配置的、已经预编译好的二进制包并生成对应的构建系统文件如CMake的FindXXX.cmake或xxx-config.cmake让你的项目能无缝链接。Conan2是Conan的重大版本升级它在性能、稳定性、用户体验和功能上都有了质的飞跃。最直观的感受是命令更简洁了依赖解析速度更快了对现代C项目如使用CMake的target模式的支持更友好了。对于任何希望提升C项目工程化水平、实现高效依赖管理和团队协作的开发者来说掌握Conan2都是一项必备技能。本教程将带你从零开始彻底搞懂Conan2的核心概念、工作流程和实战技巧让你告别手动管理依赖的原始时代。2. Conan2核心概念与工作流全解析在动手之前我们必须先理解Conan2的几个核心概念这能帮你从根本上理解它如何工作而不是死记硬背命令。2.1 核心四要素理解Conan如何描述一个“包”一个Conan包不仅仅是一堆头文件和库文件。它被精确定义为以下四个要素的组合这确保了包的唯一性和可复现性名称/版本 (Name/Version) 这是最直观的比如zlib/1.2.13。它标识了库本身。用户/频道 (User/Channel) 这是一个可选但非常重要的命名空间。格式通常是user/channel例如conan/stable或mycompany/stable。它允许同一个库的不同变体如稳定版、测试版、内部定制版共存。在Conan2中官方推荐将包上传到中心仓库时使用_下划线作为用户例如_/表示这是一个无用户的公共包。配置 (Settings) 这描述了目标平台的硬性约束。一旦确定在同一个依赖图中就不能改变。主要包括os: 操作系统如 Windows、Linux、Macos。arch: 架构如 x86_64、armv8。compiler: 编译器如 gcc、Visual Studio、apple-clang。compiler.version: 编译器版本。build_type: 构建类型如 Release、Debug。这一点尤其关键Debug和Release的库通常不兼容。选项 (Options) 这描述了包本身的可定制化编译选项。同一个包在不同的选项下会产生不同的二进制。例如shared:True/False决定编译成动态库还是静态库。fPIC:True/False是否生成位置无关代码对Linux/macOS的静态库重要。库特定的选项如OpenSSL的no_asm、no_openssl_threads等。一个包的完整引用可能长这样zlib/1.2.13_/stable#c6a0f5e...最后是包的ID哈希。Conan通过计算所有这些信息的哈希值来唯一确定一个二进制包。这意味着只要这些要素相同在任何机器上Conan都能获取到完全一致的二进制文件完美解决了“在我机器上能跑”的难题。2.2 工作流从消费到创建Conan的工作流可以清晰地分为两个视角消费者和创建者。作为消费者最常用场景定义依赖在你的项目根目录创建一个conanfile.txt或conanfile.py文件列出所需依赖。安装依赖在项目目录下运行conan install . --output-folderbuild --buildmissing。这条命令做了几件事conan install . 读取当前目录的conanfile。--output-folderbuild 将所有生成的文件如conanbuildinfo.cmake在Conan2中更推荐使用CMakeDeps和CMakeToolchain生成器输出到build子目录保持项目根目录清洁。--buildmissing 如果远程仓库没有找到完全匹配的预编译二进制包则自动从源码编译。集成到构建系统Conan会生成对应的文件。以CMake为例传统方式是include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)和conan_basic_setup()。而在Conan2的现代方式中更推荐使用CMakeDeps生成器来生成FindXXX.cmake使用CMakeToolchain生成器来生成conan_toolchain.cmake然后在CMake中通过-DCMAKE_TOOLCHAIN_FILE引入这种方式对CMake的target模式支持更好更干净。构建项目像往常一样使用CMake、MSBuild等构建你的项目现在链接器就能找到所有依赖库了。作为创建者为团队提供私有包创建配方 (conanfile.py)编写一个conanfile.py文件详细描述如何从源码构建这个包指定源码地址、配置编译选项、执行编译命令、定义打包哪些文件。在本地创建包运行conan create . mypkg/1.0mycompany/stableConan会根据配方在本地执行“下载源码-编译-打包”的全流程并存储到本地缓存。上传到远程仓库运行conan upload mypkg/1.0mycompany/stable -rmy-remote --all将包包括所有不同配置的二进制变体上传到团队私有的Conan远程仓库。团队消费团队其他成员在他们的conanfile.txt中引用mypkg/1.0mycompany/stable即可直接安装使用。2.3 本地缓存与远程仓库这是Conan高效运作的核心机制。本地缓存 (~/.conan2) 所有下载的包和本地创建的包都会存储在这里。当你再次安装相同配置的包时Conan会直接使用缓存无需重复下载或编译。你可以通过conan cache path查看其位置通过conan remove * -c来清理缓存慎用。远程仓库 (Remotes) 包的来源。默认会有一个指向https://center.conan.io的conancenter远程。你可以添加多个远程比如公司的私有仓库。Conan会按顺序从远程仓库查找包。使用conan remote list查看conan add remote my-remote http://mycompany.com:9300添加。实操心得 对于公司内部开发搭建私有远程仓库如使用Artifactory Community Edition for C/C是必选项。这不仅能加速内部库的共享也能作为conancenter的缓存代理避免因网络问题影响团队开发。永远不要指望开发者每次都从源码编译Boost或OpenSSL这种大型库。3. 从零开始Conan2安装与基础环境配置3.1 安装Conan2Conan2的安装极其简单因为它本身就是一个Python包。强烈建议使用Python的pip包管理工具进行安装这能确保你安装的是最新版本并且管理升级非常方便。前提确保你的系统已经安装了Python建议3.8以上版本。你可以在终端输入python --version或python3 --version来检查。安装命令 打开你的终端Windows下可以是CMD、PowerShell或Git Bash执行以下命令pip install conan安装完成后通过以下命令验证安装和版本conan --version你应该能看到类似Conan version 2.x.x的输出确认是Conan 2。注意事项权限问题 在Linux/macOS上如果遇到权限错误可以尝试使用pip install --user conan安装到用户目录或者使用虚拟环境venv。虚拟环境推荐 对于Python项目混杂的环境我强烈建议使用Python虚拟环境来安装Conan避免影响系统级的Python包。创建并激活虚拟环境后再执行pip install conan。升级 未来升级Conan只需运行pip install --upgrade conan。Windows PATH 如果你在Windows上使用pip安装请确保在安装Python时勾选了“Add Python to PATH”选项或者手动将Python的Scripts目录如C:\Users\YourName\AppData\Local\Programs\Python\Python39\Scripts添加到系统的PATH环境变量中这样才能在任意位置运行conan命令。3.2 基础配置与常用命令速览安装后Conan会生成一个用户级别的配置文件通常在~/.conan2/profiles目录。我们先进行一些基础配置并熟悉核心命令。1. 配置默认的配置集 (Profile)Profile是Settings和Options的集合它定义了你通常的构建环境。列出默认的profileconan profile listConan2安装后通常会有一个名为default的profile。查看其内容conan profile show default你会看到类似以下的输出这描述了你的当前主机环境Configuration for profile default: [settings] archx86_64 arch_buildx86_64 build_typeRelease compilergcc compiler.libcxxlibstdc11 compiler.version11 osLinux os_buildLinux ...这个defaultprofile在本地创建包时非常有用。对于交叉编译等复杂场景你需要创建新的profile文件。2. 搜索包在安装之前你可以先到conancenter仓库搜索是否有你需要的包及其可用版本。conan search zlib -rconancenter或者使用更友好的网页端直接访问 https://conan.io/center/ 。3. 核心命令结构Conan2的命令设计非常清晰遵循conan command subcommand [arguments]的模式。最常用的几个命令是conan install: 安装依赖。conan create: 从conanfile.py创建包。conan upload: 上传包到远程。conan remove: 从本地缓存删除包。conan remote: 管理远程仓库。conan profile: 管理配置集。你可以随时使用conan --help或conan command --help查看详细帮助。4. 实战演练在真实C项目中消费Conan包理论说得再多不如动手一试。我们以一个简单的、依赖spdlog一个流行的C日志库和zlib的控制台程序为例演示完整的消费流程。我们将使用CMake作为构建系统并采用Conan2推荐的现代集成方式。4.1 项目结构准备首先创建一个干净的项目目录并初始化文件结构my_conan_project/ ├── CMakeLists.txt ├── conanfile.txt # 或 conanfile.py └── src/ └── main.cpp4.2 编写依赖声明文件 (conanfile.txt)对于简单的消费场景conanfile.txt就足够了。在项目根目录创建conanfile.txt内容如下[requires] spdlog/1.14.1 zlib/1.2.13 [generators] CMakeDeps CMakeToolchain[requires] 在这个部分声明项目所需的所有依赖项。我们指定了spdlog的1.14.1版本和zlib的1.2.13版本。注意这里没有指定用户/频道user/channelConan会默认从conancenter查找名为_用户的包。[generators] 指定Conan要为何种构建系统生成集成文件。CMakeDeps: 这是Conan2的新核心生成器。它会为每一个依赖包生成对应的xxx-config.cmake文件这样在CMake中就可以使用现代find_package()语法来定位依赖。CMakeToolchain: 它会生成一个conan_toolchain.cmake文件其中包含了所有依赖的路径、编译定义等通过CMake的toolchain机制传入非常干净不污染你的CMake变量作用域。为什么选择CMakeDepsCMakeToolchain旧版的cmake生成器会生成一个conanbuildinfo.cmake需要你include并调用conan_basic_setup()它会全局设置CMAKE_PREFIX_PATH、CMAKE_MODULE_PATH等变量并添加所有依赖的包含目录和库目录。这种方式虽然简单但不够模块化有时会与项目自身的CMake脚本产生冲突。CMakeDeps和CMakeToolchain是更现代、更推荐的方式它们更好地支持了CMake的target概念和find_package机制。4.3 编写CMakeLists.txt接下来编写项目的CMakeLists.txt。注意我们是如何集成Conan的cmake_minimum_required(VERSION 3.15) project(MyConanProject LANGUAGES CXX) # 设置C标准 set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED ON) # 关键步骤引入Conan生成的toolchain文件。 # 我们假设在构建目录如./build下运行conan install所以toolchain文件在那里。 # 在命令行中我们会通过 -DCMAKE_TOOLCHAIN_FILE../build/conan_toolchain.cmake 来指定它。 # 这里我们用一个变量方便在命令行覆盖。 if(DEFINED CMAKE_TOOLCHAIN_FILE) message(STATUS Using toolchain file: ${CMAKE_TOOLCHAIN_FILE}) else() # 你也可以在这里设置一个相对路径的默认值但更推荐在命令行指定。 # set(CMAKE_TOOLCHAIN_FILE ${CMAKE_BINARY_DIR}/conan_toolchain.cmake) endif() # 添加可执行文件 add_executable(${PROJECT_NAME} src/main.cpp) # 使用 CMakeDeps 生成器后我们可以用 find_package 来查找依赖。 # CMakeDeps 为 spdlog 和 zlib 生成了对应的 Config 文件。 # 注意spdlog 是 header-only 库但它的 Conan 包仍然提供了 CMake 目标。 find_package(spdlog CONFIG REQUIRED) find_package(ZLIB CONFIG REQUIRED) # ZLIB 是 CMake 自带的 find module但 Conan 提供了 Config 模式 # 链接库 target_link_libraries(${PROJECT_NAME} PRIVATE spdlog::spdlog # 链接 spdlog 的 CMake 目标 ZLIB::ZLIB # 链接 ZLIB 的 CMake 目标 )4.4 编写示例源代码在src/main.cpp中我们简单地使用spdlog并调用一个zlib的函数来验证链接是否成功。#include spdlog/spdlog.h #include zlib.h #include iostream #include string int main() { // 使用 spdlog 打印日志 spdlog::set_level(spdlog::level::debug); spdlog::info(Welcome to Conan2 CMake project!); spdlog::debug(This is a debug message.); // 简单使用 zlib 的版本函数验证链接 std::string zlib_version zlibVersion(); spdlog::info(Linked with zlib version: {}, zlib_version); // 尝试一个简单的压缩示例仅演示不处理错误 std::string source Hello, Conan! This is a test string for zlib compression.; uLong sourceLen source.length() 1; // 1 for null terminator uLong destLen compressBound(sourceLen); Bytef* dest new Bytef[destLen]; int compress_result compress(dest, destLen, reinterpret_castconst Bytef*(source.c_str()), sourceLen); if (compress_result Z_OK) { spdlog::info(Compression successful. Original size: {}, Compressed size: {}, sourceLen, destLen); } else { spdlog::error(Compression failed with code: {}, compress_result); } delete[] dest; spdlog::info(Program finished successfully.); return 0; }4.5 执行Conan安装与项目构建现在让我们一步步构建这个项目。所有命令都在项目根目录my_conan_project/下执行。步骤1创建构建目录并安装依赖# 创建并进入构建目录保持源码目录清洁 mkdir build cd build # 运行conan install安装依赖。 # .. 指向包含conanfile.txt的上一级目录。 # --output-folder. 将生成的文件输出到当前目录即build目录。 # --buildmissing 如果预编译包缺失则从源码构建。 conan install .. --output-folder. --buildmissing执行这个命令后Conan会读取../conanfile.txt。检查本地缓存是否有匹配的spdlog和zlib二进制包针对你的系统配置如Windows MSVC Release x64。如果没有会从conancenter下载源码并自动编译因为指定了--buildmissing。在build目录下生成conan_deps.cmake、spdlog-config.cmake、zlib-config.cmake、conan_toolchain.cmake等文件。步骤2使用CMake配置项目在build目录下运行CMake并指定Conan生成的toolchain文件# 假设你使用的是单配置生成器如Unix Makefiles, Ninja cmake .. -DCMAKE_TOOLCHAIN_FILEconan_toolchain.cmake -DCMAKE_BUILD_TYPERelease # 如果你在Windows上使用Visual Studio多配置生成器命令略有不同 # cmake .. -DCMAKE_TOOLCHAIN_FILEconan_toolchain.cmake -G Visual Studio 17 2022CMake会读取conan_toolchain.cmake从而找到所有依赖项的头文件路径、库路径等。CMakeDeps生成的文件会让find_package(spdlog)和find_package(ZLIB)成功定位到Conan管理的库。步骤3编译项目# 使用MakeLinux/macOS或Ninja cmake --build . --config Release # 对于单配置生成器--config可选多配置生成器必须指定 # 或者在Windows上直接打开生成的sln文件用VS编译步骤4运行程序编译成功后在build目录或build/Release等子目录下找到生成的可执行文件MyConanProject并运行# Linux/macOS ./MyConanProject # Windows .\Release\MyConanProject.exe如果一切顺利你将看到spdlog输出的彩色日志信息以及zlib的版本号和压缩成功的信息。5. 进阶创建你自己的Conan包当你有一个内部库需要在团队内共享或者你想为某个开源库定制Conan包时就需要学习如何创建包。这需要编写一个conanfile.py文件它被称为“配方”(recipe)。5.1 conanfile.py 配方结构解析一个最基本的conanfile.py包含以下几个核心部分。我们以为一个简单的“数学工具库mymath”创建包为例。from conan import ConanFile from conan.tools.cmake import CMake, CMakeDeps, CMakeToolchain, cmake_layout from conan.tools.files import copy class MymathConan(ConanFile): # 1. 包元信息 name mymath version 1.0.0 license MIT author Your Name your.emailexample.com url https://github.com/yourusername/mymath description A simple math utility library topics (math, utility) # 2. 包配置二进制兼容性模式。现代包通常使用“CMakeDeps”和“CMakeToolchain”。 # compatibility 模式可以确保不同配置的包不会错误混用。 generators CMakeDeps, CMakeToolchain settings os, compiler, build_type, arch options {shared: [True, False], fPIC: [True, False]} default_options {shared: False, fPIC: True} exports_sources CMakeLists.txt, src/*, include/* # 3. 布局方法定义源码和构建目录结构。Conan2推荐使用 cmake_layout 辅助函数。 def layout(self): cmake_layout(self) # 4. 生成方法配置构建系统。这里我们生成CMake的toolchain文件。 def generate(self): tc CMakeToolchain(self) tc.generate() deps CMakeDeps(self) deps.generate() # 5. 构建方法执行实际的编译命令。 def build(self): cmake CMake(self) cmake.configure() cmake.build() # 6. 打包方法定义哪些文件应该被打包到最终的Conan包中。 def package(self): cmake CMake(self) cmake.install() # 通常依赖CMake install命令来收集文件 # 如果CMake install不完善可以手动复制文件 # copy(self, *.h, srcself.source_folder, dstos.path.join(self.package_folder, include)) # copy(self, *.lib, srcself.build_folder, dstos.path.join(self.package_folder, lib), keep_pathFalse) # copy(self, *.dll, srcself.build_folder, dstos.path.join(self.package_folder, bin), keep_pathFalse) # copy(self, *.so, srcself.build_folder, dstos.path.join(self.package_folder, lib), keep_pathFalse) # copy(self, *.dylib, srcself.build_folder, dstos.path.join(self.package_folder, lib), keep_pathFalse) # copy(self, *.a, srcself.build_folder, dstos.path.join(self.package_folder, lib), keep_pathFalse) # 7. 包信息方法向消费者提供如何链接这个包的信息。 def package_info(self): self.cpp_info.libs [mymath] # 告诉消费者需要链接 mymath 这个库 # 如果头文件不在标准位置可以设置 # self.cpp_info.includedirs [include] # self.cpp_info.libdirs [lib]5.2 本地创建与测试包假设你的mymath库的源码目录结构如下mymath-recipe/ ├── conanfile.py ├── CMakeLists.txt ├── include/ │ └── mymath.h └── src/ └── mymath.cpp在mymath-recipe目录下运行创建命令conan create . --usermyteam --channelstable --buildmissing这条命令会将当前目录.视为配方目录。使用myteam/stable作为用户/频道。根据你主机的默认profile如Linux GCC Release x86_64执行source()如果有、build()、package()、package_info()所有步骤。最终在本地缓存中生成一个名为mymath/1.0.0myteam/stable的包。你可以立即在另一个测试项目中引用这个本地包进行测试无需上传到远程仓库。5.3 上传包到远程仓库首先你需要添加一个远程仓库以Artifactory为例conan remote add my-remote http://artifactory.mycompany.com/artifactory/api/conan/conan-local然后上传你刚刚创建的包conan upload mymath/1.0.0myteam/stable -rmy-remote --all --confirm-rmy-remote: 指定远程仓库名称。--all: 上传所有二进制配置例如如果你在多个profile下创建了包。--confirm: 无需确认直接上传。上传后团队其他成员只要添加了这个远程就可以在他们的conanfile.txt中通过mymath/1.0.0myteam/stable来依赖这个库了。6. 避坑指南与高级技巧在实际使用中你肯定会遇到各种问题。这里分享一些常见的坑和解决技巧。6.1 依赖冲突与版本锁定当你的项目间接依赖了同一个库的不同版本时就会发生冲突。例如A依赖zlib/1.2.12而B依赖zlib/1.2.13。Conan的依赖解析器会尝试解决如果无法解决会报错。解决方案版本范围 在conanfile.txt或conanfile.py的[requires]中可以使用版本范围如zlib/[1.2.12 1.3.0]给予解析器更多灵活性。覆盖依赖 在消费者的conanfile.txt中使用[overrides]部分强制指定某个依赖的版本。[requires] A/1.0 B/2.0 [overrides] zlib/1.2.13使用conan graph info 这个命令可以可视化你的依赖图帮助你理解冲突的来源。6.2 交叉编译与多配置构建你需要为不同的目标平台如Android ARM、iOS创建包。这需要自定义Profile。创建目标平台的Profile文件例如android_armv8:# ~/.conan2/profiles/android_armv8 [settings] osAndroid os.api_level21 archarmv8 compilerclang compiler.version14 compiler.libcxxc_shared build_typeRelease [conf] tools.android:ndk_path/path/to/your/android-ndk-r25c使用该Profile创建或安装包conan create . mymath/1.0_/stable --profile:hostandroid_armv8 --profile:builddefault --buildmissing这里--profile:host指定目标环境--profile:build指定构建机环境。6.3 调试与问题排查查看依赖图conan graph info . --formathtml graph.html可以生成一个可视化的HTML依赖图非常直观。查看包信息conan list zlib/1.2.13:*可以列出本地缓存中所有zlib/1.2.13的二进制变体。清理缓存如果遇到奇怪的编译或链接错误可能是本地缓存损坏。可以尝试conan remove * -c清理所有缓存慎用或者只删除特定包conan remove zlib/1.2.13 -c。详细输出在任何命令后添加-v或-vv可以获得更详细的输出对于调试至关重要。检查生成的文件到build目录下查看Conan生成的conan_toolchain.cmake、xxx-config.cmake等文件确认路径和定义是否正确。6.4 性能优化重用二进制包确保团队使用相同的编译器版本、编译标志如-stdc17和基础库如glibc版本这样Conan才能命中相同的二进制包ID避免重复编译。可以在公司内部规范开发环境。搭建私有仓库并开启二进制包缓存像Artifactory这样的仓库可以缓存从conancenter下载的包极大加速内部团队的首次下载速度。并行下载Conan2支持并行下载默认已开启。可以通过配置调整线程数。6.5 与CI/CD集成在CI流水线中通常的步骤是安装Conan。配置远程仓库添加私仓。运行conan install安装依赖。可以利用CI缓存机制缓存~/.conan2目录避免每次重复下载。运行conan create或conan build来构建你的库如果是库项目。运行conan upload将构建好的包上传到私有仓库仅针对标签构建或发布构建。一个简单的GitHub Actions步骤示例- name: Install Conan run: pip install conan - name: Add Remote run: conan remote add my-remote ${{ secrets.CONAN_REMOTE_URL }} - name: Install Dependencies run: conan install . --output-folder${{ github.workspace }}/build --buildmissing - name: Configure and Build run: | cd ${{ github.workspace }}/build cmake .. -DCMAKE_TOOLCHAIN_FILEconan_toolchain.cmake -DCMAKE_BUILD_TYPERelease cmake --build . --config Release掌握Conan2本质上是在掌握一种现代C项目的依赖管理哲学。它初学时有少许门槛但一旦融入工作流带来的效率提升和团队协作的顺畅度是巨大的。从今天开始尝试在你的下一个C项目中引入Conan2亲自感受它如何将你从“依赖地狱”中解放出来。 C++依赖管理革命：Conan2核心概念与实战指南
1. 项目概述为什么C开发者需要Conan2如果你是一名C开发者无论你是刚入行的新人还是摸爬滚打多年的老手我相信你都经历过“依赖地狱”的折磨。项目启动第一件事不是写代码而是花上半天甚至几天时间去网上四处寻找一个能用的第三方库。找到了源码还得自己编译面对各种平台Windows、Linux、macOS和编译器MSVC、GCC、Clang的组合一个配置不对就是满屏的编译错误。好不容易编译通过了怎么把它集成到你的CMakeLists.txt或者Visual Studio项目里又是一道坎。更别提团队协作了你本地跑得好好的同事一拉代码就报错原因可能是他电脑上装的库版本和你不一样或者干脆没装。这种体验让C开发的门槛无形中拔高了许多也严重拖慢了开发效率。反观隔壁的Python、JavaScript、Go等语言pip、npm、go mod等包管理工具早已是标配一行命令就能安装、更新、管理依赖版本清晰环境隔离协作无忧。C世界长期以来缺少这样一个“官方钦定”的、生态统一的解决方案直到Conan的出现。Conan是一个开源、去中心化的C/C包管理器。简单来说它就像C世界的pip或npm。你不再需要手动下载、编译、配置第三方库。你只需要在一个名为conanfile.txt或conanfile.py的文件里声明你的项目需要什么库比如OpenSSL/1.1.1w然后运行conan install命令。Conan会自动从远程仓库可以是官方的conancenter也可以是你们公司搭建的私有仓库下载对应平台和编译器配置的、已经预编译好的二进制包并生成对应的构建系统文件如CMake的FindXXX.cmake或xxx-config.cmake让你的项目能无缝链接。Conan2是Conan的重大版本升级它在性能、稳定性、用户体验和功能上都有了质的飞跃。最直观的感受是命令更简洁了依赖解析速度更快了对现代C项目如使用CMake的target模式的支持更友好了。对于任何希望提升C项目工程化水平、实现高效依赖管理和团队协作的开发者来说掌握Conan2都是一项必备技能。本教程将带你从零开始彻底搞懂Conan2的核心概念、工作流程和实战技巧让你告别手动管理依赖的原始时代。2. Conan2核心概念与工作流全解析在动手之前我们必须先理解Conan2的几个核心概念这能帮你从根本上理解它如何工作而不是死记硬背命令。2.1 核心四要素理解Conan如何描述一个“包”一个Conan包不仅仅是一堆头文件和库文件。它被精确定义为以下四个要素的组合这确保了包的唯一性和可复现性名称/版本 (Name/Version) 这是最直观的比如zlib/1.2.13。它标识了库本身。用户/频道 (User/Channel) 这是一个可选但非常重要的命名空间。格式通常是user/channel例如conan/stable或mycompany/stable。它允许同一个库的不同变体如稳定版、测试版、内部定制版共存。在Conan2中官方推荐将包上传到中心仓库时使用_下划线作为用户例如_/表示这是一个无用户的公共包。配置 (Settings) 这描述了目标平台的硬性约束。一旦确定在同一个依赖图中就不能改变。主要包括os: 操作系统如 Windows、Linux、Macos。arch: 架构如 x86_64、armv8。compiler: 编译器如 gcc、Visual Studio、apple-clang。compiler.version: 编译器版本。build_type: 构建类型如 Release、Debug。这一点尤其关键Debug和Release的库通常不兼容。选项 (Options) 这描述了包本身的可定制化编译选项。同一个包在不同的选项下会产生不同的二进制。例如shared:True/False决定编译成动态库还是静态库。fPIC:True/False是否生成位置无关代码对Linux/macOS的静态库重要。库特定的选项如OpenSSL的no_asm、no_openssl_threads等。一个包的完整引用可能长这样zlib/1.2.13_/stable#c6a0f5e...最后是包的ID哈希。Conan通过计算所有这些信息的哈希值来唯一确定一个二进制包。这意味着只要这些要素相同在任何机器上Conan都能获取到完全一致的二进制文件完美解决了“在我机器上能跑”的难题。2.2 工作流从消费到创建Conan的工作流可以清晰地分为两个视角消费者和创建者。作为消费者最常用场景定义依赖在你的项目根目录创建一个conanfile.txt或conanfile.py文件列出所需依赖。安装依赖在项目目录下运行conan install . --output-folderbuild --buildmissing。这条命令做了几件事conan install . 读取当前目录的conanfile。--output-folderbuild 将所有生成的文件如conanbuildinfo.cmake在Conan2中更推荐使用CMakeDeps和CMakeToolchain生成器输出到build子目录保持项目根目录清洁。--buildmissing 如果远程仓库没有找到完全匹配的预编译二进制包则自动从源码编译。集成到构建系统Conan会生成对应的文件。以CMake为例传统方式是include(${CMAKE_BINARY_DIR}/conanbuildinfo.cmake)和conan_basic_setup()。而在Conan2的现代方式中更推荐使用CMakeDeps生成器来生成FindXXX.cmake使用CMakeToolchain生成器来生成conan_toolchain.cmake然后在CMake中通过-DCMAKE_TOOLCHAIN_FILE引入这种方式对CMake的target模式支持更好更干净。构建项目像往常一样使用CMake、MSBuild等构建你的项目现在链接器就能找到所有依赖库了。作为创建者为团队提供私有包创建配方 (conanfile.py)编写一个conanfile.py文件详细描述如何从源码构建这个包指定源码地址、配置编译选项、执行编译命令、定义打包哪些文件。在本地创建包运行conan create . mypkg/1.0mycompany/stableConan会根据配方在本地执行“下载源码-编译-打包”的全流程并存储到本地缓存。上传到远程仓库运行conan upload mypkg/1.0mycompany/stable -rmy-remote --all将包包括所有不同配置的二进制变体上传到团队私有的Conan远程仓库。团队消费团队其他成员在他们的conanfile.txt中引用mypkg/1.0mycompany/stable即可直接安装使用。2.3 本地缓存与远程仓库这是Conan高效运作的核心机制。本地缓存 (~/.conan2) 所有下载的包和本地创建的包都会存储在这里。当你再次安装相同配置的包时Conan会直接使用缓存无需重复下载或编译。你可以通过conan cache path查看其位置通过conan remove * -c来清理缓存慎用。远程仓库 (Remotes) 包的来源。默认会有一个指向https://center.conan.io的conancenter远程。你可以添加多个远程比如公司的私有仓库。Conan会按顺序从远程仓库查找包。使用conan remote list查看conan add remote my-remote http://mycompany.com:9300添加。实操心得 对于公司内部开发搭建私有远程仓库如使用Artifactory Community Edition for C/C是必选项。这不仅能加速内部库的共享也能作为conancenter的缓存代理避免因网络问题影响团队开发。永远不要指望开发者每次都从源码编译Boost或OpenSSL这种大型库。3. 从零开始Conan2安装与基础环境配置3.1 安装Conan2Conan2的安装极其简单因为它本身就是一个Python包。强烈建议使用Python的pip包管理工具进行安装这能确保你安装的是最新版本并且管理升级非常方便。前提确保你的系统已经安装了Python建议3.8以上版本。你可以在终端输入python --version或python3 --version来检查。安装命令 打开你的终端Windows下可以是CMD、PowerShell或Git Bash执行以下命令pip install conan安装完成后通过以下命令验证安装和版本conan --version你应该能看到类似Conan version 2.x.x的输出确认是Conan 2。注意事项权限问题 在Linux/macOS上如果遇到权限错误可以尝试使用pip install --user conan安装到用户目录或者使用虚拟环境venv。虚拟环境推荐 对于Python项目混杂的环境我强烈建议使用Python虚拟环境来安装Conan避免影响系统级的Python包。创建并激活虚拟环境后再执行pip install conan。升级 未来升级Conan只需运行pip install --upgrade conan。Windows PATH 如果你在Windows上使用pip安装请确保在安装Python时勾选了“Add Python to PATH”选项或者手动将Python的Scripts目录如C:\Users\YourName\AppData\Local\Programs\Python\Python39\Scripts添加到系统的PATH环境变量中这样才能在任意位置运行conan命令。3.2 基础配置与常用命令速览安装后Conan会生成一个用户级别的配置文件通常在~/.conan2/profiles目录。我们先进行一些基础配置并熟悉核心命令。1. 配置默认的配置集 (Profile)Profile是Settings和Options的集合它定义了你通常的构建环境。列出默认的profileconan profile listConan2安装后通常会有一个名为default的profile。查看其内容conan profile show default你会看到类似以下的输出这描述了你的当前主机环境Configuration for profile default: [settings] archx86_64 arch_buildx86_64 build_typeRelease compilergcc compiler.libcxxlibstdc11 compiler.version11 osLinux os_buildLinux ...这个defaultprofile在本地创建包时非常有用。对于交叉编译等复杂场景你需要创建新的profile文件。2. 搜索包在安装之前你可以先到conancenter仓库搜索是否有你需要的包及其可用版本。conan search zlib -rconancenter或者使用更友好的网页端直接访问 https://conan.io/center/ 。3. 核心命令结构Conan2的命令设计非常清晰遵循conan command subcommand [arguments]的模式。最常用的几个命令是conan install: 安装依赖。conan create: 从conanfile.py创建包。conan upload: 上传包到远程。conan remove: 从本地缓存删除包。conan remote: 管理远程仓库。conan profile: 管理配置集。你可以随时使用conan --help或conan command --help查看详细帮助。4. 实战演练在真实C项目中消费Conan包理论说得再多不如动手一试。我们以一个简单的、依赖spdlog一个流行的C日志库和zlib的控制台程序为例演示完整的消费流程。我们将使用CMake作为构建系统并采用Conan2推荐的现代集成方式。4.1 项目结构准备首先创建一个干净的项目目录并初始化文件结构my_conan_project/ ├── CMakeLists.txt ├── conanfile.txt # 或 conanfile.py └── src/ └── main.cpp4.2 编写依赖声明文件 (conanfile.txt)对于简单的消费场景conanfile.txt就足够了。在项目根目录创建conanfile.txt内容如下[requires] spdlog/1.14.1 zlib/1.2.13 [generators] CMakeDeps CMakeToolchain[requires] 在这个部分声明项目所需的所有依赖项。我们指定了spdlog的1.14.1版本和zlib的1.2.13版本。注意这里没有指定用户/频道user/channelConan会默认从conancenter查找名为_用户的包。[generators] 指定Conan要为何种构建系统生成集成文件。CMakeDeps: 这是Conan2的新核心生成器。它会为每一个依赖包生成对应的xxx-config.cmake文件这样在CMake中就可以使用现代find_package()语法来定位依赖。CMakeToolchain: 它会生成一个conan_toolchain.cmake文件其中包含了所有依赖的路径、编译定义等通过CMake的toolchain机制传入非常干净不污染你的CMake变量作用域。为什么选择CMakeDepsCMakeToolchain旧版的cmake生成器会生成一个conanbuildinfo.cmake需要你include并调用conan_basic_setup()它会全局设置CMAKE_PREFIX_PATH、CMAKE_MODULE_PATH等变量并添加所有依赖的包含目录和库目录。这种方式虽然简单但不够模块化有时会与项目自身的CMake脚本产生冲突。CMakeDeps和CMakeToolchain是更现代、更推荐的方式它们更好地支持了CMake的target概念和find_package机制。4.3 编写CMakeLists.txt接下来编写项目的CMakeLists.txt。注意我们是如何集成Conan的cmake_minimum_required(VERSION 3.15) project(MyConanProject LANGUAGES CXX) # 设置C标准 set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED ON) # 关键步骤引入Conan生成的toolchain文件。 # 我们假设在构建目录如./build下运行conan install所以toolchain文件在那里。 # 在命令行中我们会通过 -DCMAKE_TOOLCHAIN_FILE../build/conan_toolchain.cmake 来指定它。 # 这里我们用一个变量方便在命令行覆盖。 if(DEFINED CMAKE_TOOLCHAIN_FILE) message(STATUS Using toolchain file: ${CMAKE_TOOLCHAIN_FILE}) else() # 你也可以在这里设置一个相对路径的默认值但更推荐在命令行指定。 # set(CMAKE_TOOLCHAIN_FILE ${CMAKE_BINARY_DIR}/conan_toolchain.cmake) endif() # 添加可执行文件 add_executable(${PROJECT_NAME} src/main.cpp) # 使用 CMakeDeps 生成器后我们可以用 find_package 来查找依赖。 # CMakeDeps 为 spdlog 和 zlib 生成了对应的 Config 文件。 # 注意spdlog 是 header-only 库但它的 Conan 包仍然提供了 CMake 目标。 find_package(spdlog CONFIG REQUIRED) find_package(ZLIB CONFIG REQUIRED) # ZLIB 是 CMake 自带的 find module但 Conan 提供了 Config 模式 # 链接库 target_link_libraries(${PROJECT_NAME} PRIVATE spdlog::spdlog # 链接 spdlog 的 CMake 目标 ZLIB::ZLIB # 链接 ZLIB 的 CMake 目标 )4.4 编写示例源代码在src/main.cpp中我们简单地使用spdlog并调用一个zlib的函数来验证链接是否成功。#include spdlog/spdlog.h #include zlib.h #include iostream #include string int main() { // 使用 spdlog 打印日志 spdlog::set_level(spdlog::level::debug); spdlog::info(Welcome to Conan2 CMake project!); spdlog::debug(This is a debug message.); // 简单使用 zlib 的版本函数验证链接 std::string zlib_version zlibVersion(); spdlog::info(Linked with zlib version: {}, zlib_version); // 尝试一个简单的压缩示例仅演示不处理错误 std::string source Hello, Conan! This is a test string for zlib compression.; uLong sourceLen source.length() 1; // 1 for null terminator uLong destLen compressBound(sourceLen); Bytef* dest new Bytef[destLen]; int compress_result compress(dest, destLen, reinterpret_castconst Bytef*(source.c_str()), sourceLen); if (compress_result Z_OK) { spdlog::info(Compression successful. Original size: {}, Compressed size: {}, sourceLen, destLen); } else { spdlog::error(Compression failed with code: {}, compress_result); } delete[] dest; spdlog::info(Program finished successfully.); return 0; }4.5 执行Conan安装与项目构建现在让我们一步步构建这个项目。所有命令都在项目根目录my_conan_project/下执行。步骤1创建构建目录并安装依赖# 创建并进入构建目录保持源码目录清洁 mkdir build cd build # 运行conan install安装依赖。 # .. 指向包含conanfile.txt的上一级目录。 # --output-folder. 将生成的文件输出到当前目录即build目录。 # --buildmissing 如果预编译包缺失则从源码构建。 conan install .. --output-folder. --buildmissing执行这个命令后Conan会读取../conanfile.txt。检查本地缓存是否有匹配的spdlog和zlib二进制包针对你的系统配置如Windows MSVC Release x64。如果没有会从conancenter下载源码并自动编译因为指定了--buildmissing。在build目录下生成conan_deps.cmake、spdlog-config.cmake、zlib-config.cmake、conan_toolchain.cmake等文件。步骤2使用CMake配置项目在build目录下运行CMake并指定Conan生成的toolchain文件# 假设你使用的是单配置生成器如Unix Makefiles, Ninja cmake .. -DCMAKE_TOOLCHAIN_FILEconan_toolchain.cmake -DCMAKE_BUILD_TYPERelease # 如果你在Windows上使用Visual Studio多配置生成器命令略有不同 # cmake .. -DCMAKE_TOOLCHAIN_FILEconan_toolchain.cmake -G Visual Studio 17 2022CMake会读取conan_toolchain.cmake从而找到所有依赖项的头文件路径、库路径等。CMakeDeps生成的文件会让find_package(spdlog)和find_package(ZLIB)成功定位到Conan管理的库。步骤3编译项目# 使用MakeLinux/macOS或Ninja cmake --build . --config Release # 对于单配置生成器--config可选多配置生成器必须指定 # 或者在Windows上直接打开生成的sln文件用VS编译步骤4运行程序编译成功后在build目录或build/Release等子目录下找到生成的可执行文件MyConanProject并运行# Linux/macOS ./MyConanProject # Windows .\Release\MyConanProject.exe如果一切顺利你将看到spdlog输出的彩色日志信息以及zlib的版本号和压缩成功的信息。5. 进阶创建你自己的Conan包当你有一个内部库需要在团队内共享或者你想为某个开源库定制Conan包时就需要学习如何创建包。这需要编写一个conanfile.py文件它被称为“配方”(recipe)。5.1 conanfile.py 配方结构解析一个最基本的conanfile.py包含以下几个核心部分。我们以为一个简单的“数学工具库mymath”创建包为例。from conan import ConanFile from conan.tools.cmake import CMake, CMakeDeps, CMakeToolchain, cmake_layout from conan.tools.files import copy class MymathConan(ConanFile): # 1. 包元信息 name mymath version 1.0.0 license MIT author Your Name your.emailexample.com url https://github.com/yourusername/mymath description A simple math utility library topics (math, utility) # 2. 包配置二进制兼容性模式。现代包通常使用“CMakeDeps”和“CMakeToolchain”。 # compatibility 模式可以确保不同配置的包不会错误混用。 generators CMakeDeps, CMakeToolchain settings os, compiler, build_type, arch options {shared: [True, False], fPIC: [True, False]} default_options {shared: False, fPIC: True} exports_sources CMakeLists.txt, src/*, include/* # 3. 布局方法定义源码和构建目录结构。Conan2推荐使用 cmake_layout 辅助函数。 def layout(self): cmake_layout(self) # 4. 生成方法配置构建系统。这里我们生成CMake的toolchain文件。 def generate(self): tc CMakeToolchain(self) tc.generate() deps CMakeDeps(self) deps.generate() # 5. 构建方法执行实际的编译命令。 def build(self): cmake CMake(self) cmake.configure() cmake.build() # 6. 打包方法定义哪些文件应该被打包到最终的Conan包中。 def package(self): cmake CMake(self) cmake.install() # 通常依赖CMake install命令来收集文件 # 如果CMake install不完善可以手动复制文件 # copy(self, *.h, srcself.source_folder, dstos.path.join(self.package_folder, include)) # copy(self, *.lib, srcself.build_folder, dstos.path.join(self.package_folder, lib), keep_pathFalse) # copy(self, *.dll, srcself.build_folder, dstos.path.join(self.package_folder, bin), keep_pathFalse) # copy(self, *.so, srcself.build_folder, dstos.path.join(self.package_folder, lib), keep_pathFalse) # copy(self, *.dylib, srcself.build_folder, dstos.path.join(self.package_folder, lib), keep_pathFalse) # copy(self, *.a, srcself.build_folder, dstos.path.join(self.package_folder, lib), keep_pathFalse) # 7. 包信息方法向消费者提供如何链接这个包的信息。 def package_info(self): self.cpp_info.libs [mymath] # 告诉消费者需要链接 mymath 这个库 # 如果头文件不在标准位置可以设置 # self.cpp_info.includedirs [include] # self.cpp_info.libdirs [lib]5.2 本地创建与测试包假设你的mymath库的源码目录结构如下mymath-recipe/ ├── conanfile.py ├── CMakeLists.txt ├── include/ │ └── mymath.h └── src/ └── mymath.cpp在mymath-recipe目录下运行创建命令conan create . --usermyteam --channelstable --buildmissing这条命令会将当前目录.视为配方目录。使用myteam/stable作为用户/频道。根据你主机的默认profile如Linux GCC Release x86_64执行source()如果有、build()、package()、package_info()所有步骤。最终在本地缓存中生成一个名为mymath/1.0.0myteam/stable的包。你可以立即在另一个测试项目中引用这个本地包进行测试无需上传到远程仓库。5.3 上传包到远程仓库首先你需要添加一个远程仓库以Artifactory为例conan remote add my-remote http://artifactory.mycompany.com/artifactory/api/conan/conan-local然后上传你刚刚创建的包conan upload mymath/1.0.0myteam/stable -rmy-remote --all --confirm-rmy-remote: 指定远程仓库名称。--all: 上传所有二进制配置例如如果你在多个profile下创建了包。--confirm: 无需确认直接上传。上传后团队其他成员只要添加了这个远程就可以在他们的conanfile.txt中通过mymath/1.0.0myteam/stable来依赖这个库了。6. 避坑指南与高级技巧在实际使用中你肯定会遇到各种问题。这里分享一些常见的坑和解决技巧。6.1 依赖冲突与版本锁定当你的项目间接依赖了同一个库的不同版本时就会发生冲突。例如A依赖zlib/1.2.12而B依赖zlib/1.2.13。Conan的依赖解析器会尝试解决如果无法解决会报错。解决方案版本范围 在conanfile.txt或conanfile.py的[requires]中可以使用版本范围如zlib/[1.2.12 1.3.0]给予解析器更多灵活性。覆盖依赖 在消费者的conanfile.txt中使用[overrides]部分强制指定某个依赖的版本。[requires] A/1.0 B/2.0 [overrides] zlib/1.2.13使用conan graph info 这个命令可以可视化你的依赖图帮助你理解冲突的来源。6.2 交叉编译与多配置构建你需要为不同的目标平台如Android ARM、iOS创建包。这需要自定义Profile。创建目标平台的Profile文件例如android_armv8:# ~/.conan2/profiles/android_armv8 [settings] osAndroid os.api_level21 archarmv8 compilerclang compiler.version14 compiler.libcxxc_shared build_typeRelease [conf] tools.android:ndk_path/path/to/your/android-ndk-r25c使用该Profile创建或安装包conan create . mymath/1.0_/stable --profile:hostandroid_armv8 --profile:builddefault --buildmissing这里--profile:host指定目标环境--profile:build指定构建机环境。6.3 调试与问题排查查看依赖图conan graph info . --formathtml graph.html可以生成一个可视化的HTML依赖图非常直观。查看包信息conan list zlib/1.2.13:*可以列出本地缓存中所有zlib/1.2.13的二进制变体。清理缓存如果遇到奇怪的编译或链接错误可能是本地缓存损坏。可以尝试conan remove * -c清理所有缓存慎用或者只删除特定包conan remove zlib/1.2.13 -c。详细输出在任何命令后添加-v或-vv可以获得更详细的输出对于调试至关重要。检查生成的文件到build目录下查看Conan生成的conan_toolchain.cmake、xxx-config.cmake等文件确认路径和定义是否正确。6.4 性能优化重用二进制包确保团队使用相同的编译器版本、编译标志如-stdc17和基础库如glibc版本这样Conan才能命中相同的二进制包ID避免重复编译。可以在公司内部规范开发环境。搭建私有仓库并开启二进制包缓存像Artifactory这样的仓库可以缓存从conancenter下载的包极大加速内部团队的首次下载速度。并行下载Conan2支持并行下载默认已开启。可以通过配置调整线程数。6.5 与CI/CD集成在CI流水线中通常的步骤是安装Conan。配置远程仓库添加私仓。运行conan install安装依赖。可以利用CI缓存机制缓存~/.conan2目录避免每次重复下载。运行conan create或conan build来构建你的库如果是库项目。运行conan upload将构建好的包上传到私有仓库仅针对标签构建或发布构建。一个简单的GitHub Actions步骤示例- name: Install Conan run: pip install conan - name: Add Remote run: conan remote add my-remote ${{ secrets.CONAN_REMOTE_URL }} - name: Install Dependencies run: conan install . --output-folder${{ github.workspace }}/build --buildmissing - name: Configure and Build run: | cd ${{ github.workspace }}/build cmake .. -DCMAKE_TOOLCHAIN_FILEconan_toolchain.cmake -DCMAKE_BUILD_TYPERelease cmake --build . --config Release掌握Conan2本质上是在掌握一种现代C项目的依赖管理哲学。它初学时有少许门槛但一旦融入工作流带来的效率提升和团队协作的顺畅度是巨大的。从今天开始尝试在你的下一个C项目中引入Conan2亲自感受它如何将你从“依赖地狱”中解放出来。