Skip to content

门泊吴船亦已谋

C++ 依赖包管理解决方案对比

刚刚有个朋友问我加老师发生甚么事了,我说两个年轻人,一个 C#,一个 Java。

他们说,哎,我在加包依赖的时候冲突了,加老师你能不能教教我 CMake 功法,帮助治疗一下,我的依赖包。 我说可以。

我说你们在构建工具里练死劲不好用,他不服气。 我说小朋友,你用两行的 dependency,折我一行的 find_package,他折不动。 他说你这没用我说我这有用,这用了系统包管理,是化劲。 传统编程是讲化劲的四两拨千斤,两百多斤的 pip install 再 import,都折不动我这一行从系统里拿包的 find_package。

啊,他非和我试手。 我说可以,啪就站起来了,很快啊! 然后上来就是一个 import,一个 using,我全都防出去了,防出去了啊。 防出去以后自然是传统编程以点到为止我用 #include 加宏手放键盘上没有用 CMake 构建。 我笑一下准备关掉 VS Code。 由于这时间,按照传统编程点到为止他已经输了。 如果这一构建下去,编译完链接立刻运行当场就能直接把他的 Runtime 打骨折了。 他也承认我先导入的依赖库。 啊,我关掉 VS Code 的时候不构建了,他突然袭击连续导了几个包来编译。 我大意了啊,没有闪,当时就流眼泪了。 我说小伙子你不讲武德你懂不懂,他说加老师对不起,对不起,我不懂规矩。

他说他的库是乱导的。 他可不是乱导的啊,构建工具与包依赖集成、中央仓库、依赖包多版本管理、命令行工具,训练有素。 后来他说他在甲骨文和微软练过三四年。 啊,看来是有备而来! 这两个年轻人不讲武德! 来骗!! 来偷袭!! 我 69 岁的老同志。 这好吗,这不好。 我劝,这两位年轻人耗子尾汁,好好反思,以后不要再犯,这样的聪明,小聪明啊。

现代语言基本上都有很舒适的依赖管理,比如 Java 的 Maven 和 Gradle、.NET 的 NuGet、node.js 的 npm、Rust 的 Cargo。 目前可以称为成熟且主流的 C++ 构建工具只有 CMake。~~VS 给我滚。~~然而 CMake 的依赖管理非常弱鸡。 一般来说更好的方法是使用一些集成到 CMake 上的包管理工具;也可以抛弃这个又陈旧又臃肿的 CMake,直接使用更先进的构建工具。

接下来介绍几种解决方案。

配合系统包管理器使用 find_package

find_package 是 CMake 的一个指令,重度依赖 apt、pacman、brew 这些能把类库直接安装到系统里的包管理器,而且不能控制依赖包的多个版本。

如果是 macOS,那还好。 起码有 brew,而且还是类 UNIX,装好的类库也都能找到在哪,勉强算能用。

如果是 Windows,那就很操蛋了。 系统包管理确实也算有几个,但是都奇奇怪怪。 我用过的 MSYS2 其实还算可以,但是会有一些兼容性问题。 总体来说还是太折磨了,建议直接用 WSL。

非常易用
不支持版本管理
只能导入支持 CMake 的用系统包管理器安装的包

直接把外部库源码扔进项目里

其实也是最常见的解决方法,把外部库源码都扔进一个例如 external 文件夹里。 单论 add_subdirectory 的话,学习成本很低。 但是如果要这样引库,首先要先学会这个库怎么编译,然后要简化编译的流程。 有些该死的库的构建甚至会用到 Python。 很有可能会需要对这些库进行一顿乱七八糟的魔改,或者在外面写一堆该死的脚本。 更新外部库时还要重新下载源码,然后再一通爆改。 如果外部库的构建产生了变动,那真的就是世界末日。 而且外部库还会占用远程仓库额外的空间。

非常原始,比较麻烦
支持版本管理
可以导入所有项目

Git Submodules

跟手动扔进项目里差不多,但是这样基本不允许魔改。 通常情况下只能在外面搞些小动作,比如设一些 CMake 变量来控制依赖的构建啥的。 不过这样外部库就不会占用空间了。 而且更新外部库版本很方便。

比较麻烦
支持版本管理
可以导入一部分托管项目

FetchContent

FetchContent 是 CMake 自带的功能,可以在构建之前下载外部库的源代码。 这种方法跟 Git Submodules 几乎没有区别。

比较麻烦
支持版本管理
可以导入一部分托管项目

Vcpkg

微软写的,需要安装,没有构建功能,可以配合 CMake。 有一点类似 apt、pacman 这些东西,但是不支持版本控制。 开发的初衷应该就是要解决 Windows 上没有系统包管理器的问题。 不过值得一提的是它支持的包的数量非常多,不愧是微软爸爸啊。 而且版本管理功能受到重视且正在被实现,估计很快就能用了。

有趣的是,安装多个 vcpkg 可以使得不同 vcpkg 持有不同版本的依赖包。 这样对于每个项目都安装一个 vcpkg 就能实现版本管理。 这是一种非常蛇皮而且折磨的解决方法,但是它竟然被写到了微软的官方文档里。

还算易用
对于依赖的版本管理有非常脑瘫的支持,截止到发文,它还在试图真正实现版本管理
支持的依赖包较多

Conan

跟 vcpkg 差不多,也是依赖 CMake。 但是会好一点,因为具有版本管理功能,就是支持的包的数量少一点。

还算易用
支持版本管理
支持的依赖包较少

Hunter

看起来像是正统的 CMake 上包管理解决方法。 它不需要安装,直接在 CMakeLists.txt 里添加代码就可以了。 我其实已经使用过一段时间,但是发现它支持的包比较少,而且版本更新不够及时,但是交 PR 的回复还挺快。

非常易用
支持版本管理
支持的包也比较少

Xmake

国人大佬写的,不依赖 CMake,能够独立构建项目。 它使用内嵌的 Lua 来配置项目。 具有依赖包多版本管理功能。 在 VS Code、IDEA 等 IDE 上有插件支持。 安装方便,Homebrew 和 AUR 的仓库里都有。 开源社区目前正在活跃。

牛逼的是可以导 vcpkg 和 conan 的包,这使得还在发展初期的 xmake 已经具备了应用于实际项目的能力。

不过有一些小问题。 虽然作者表示了反对态度,但是 issue 和 pull request 里还是出现了大量中文,可能会影响老外参与贡献的程度。且目前原生支持的包还比较少。目前 xmake 的 API 变化还比较剧烈。使用 Lua 语法配置项目可能会导致配置比较冗长,传参用的是字符串也不好做语法检查。

比较易用
比较高雅
多种 IDE 插件支持
支持版本管理
支持的包非常多,但是原生包很少
发展初期,前景未知

Build2

似乎是唯一正统的全新的 C++ 构建工具,未来之星,明日之子,人类最后的希望。
项目组里的人都是神仙级大佬。 文档也写的看起来非常牛逼。 但是使用独立的语法学习成本高。 似乎作者比较刚且还要规定统一的项目规范(可能算优点也可能算缺点)。 同样在开发初期。

需要注意,C++ 开源项目的结构通常都乱七八糟,而 build2 对于依赖包的项目结构有明确的非强制性但强烈建议的要求,大量遗留的开源项目可能难以修改项目结构就导致不便于加入 build2 的包仓库中,并且这有一点强制施加个人观点的意味在里面。 难道这就是篡改信仰吗。 最关键是它生成的项目结构是真的有够丑,需要较长时间磨合或者说妥协。 可能正是因为这样,现在支持的包非常非常少,增速也非常缓慢。
但其实统一 C++的项目结构是一件喜闻乐见的事情,而且 build2 默认生成的项目结构其实非常符合 C++20 的 Modules。 另外有个好消息是它虽然限制很多,但是允许驼峰。 虽然可能它是不乐意的。

勉强算易用吧
比较高雅
支持版本管理
支持的包太少了
还在发展初期,前景未知

Spack

集成了多版本包管理的独立构建工具,似乎是为了超算设计的。 支持 macOS,Linux,但是不支持 Windows,没想到吧。 包也挺多,还支持把用 C / C++ / Fortran 写的类库链接到用 Python / R 写的应用上。 社区目前非常非常活跃。
Windows 的支持似乎受到了重视,现在有个好心人在试图添加 MinGW,估计快了吧。
有个问题是它依赖 Python,而且用户需要手动安装,这可能会导致一些 Python 版本的兼容性问题。

比较易用
比较高雅
支持版本管理
支持的包很多
暂不支持 Windows

个人建议

目前新的构建工具还没有能够广泛使用, 所以 CMake 估计还能坚挺很长时间。

所以使用 Git Submodules、FetchContent 又或者直接把源码扔项目里再配合 CMake 是比较稳妥的方法。 这个解决方案可以很好的保持包的版本依赖。 并且可以在未来很长一段时间内不用改动。

不嫌麻烦的可以用 Conan。 Vcpkg 也跟 Conan 一样麻烦,如果多版本包管理的 feature 加好了那就比 Conan 好一点吧。 Hunter 也是一个比较好的选择,使用起来很简单,但是包还是少,而且包的版本更新缓慢。

激进一点可以试试 XMake 和 Spack。
反正 XMake 可以偷 vcpkg 和 Conan 的包来用,如果想用原生包还能自己提 PR,作者都会很快回复,而且有中文文档上手非常简单。
Spack 的话,如果主力开发环境不在 Windows 的话也可以先试试,因为原生包真的非常多,Windows 的支持估计也快了。

Build2 暂时还不建议用,因为支持的包太少了,而且包的增加也很缓慢。 如果要自己提交包的话,虽然非常麻烦,但最好还是遵守 build2 对包的项目结构的建议性要求。