【CMake 系列】（三）ExternalProject 实践

上次 说了第三方依赖管理，提到了咱们团队在使用 ExternalProject 来管理依赖，此次来讲说具体实践，以及一个基于 CMake 的开源依赖管理工具 vcpkg。

ExternalProject 实践

来看看它长什么样：

ExternalProject_Add(<name> [<option>...])
ExternalProject_Add_Step(<name> <step> [<option>...])
ExternalProject_Get_Property
ExternalProject_Add_StepTargets(<name> [NO_DEPENDS] <step1> [<step2>...])

是否是很简单，显然不是，文档里写成这样是由于参数太多了，惊不惊喜？

其实大部分参数用不到，我就挑选一些经常使用的参数来讲说，从步骤来讲，它主要分如下几步：

• 目录配置

  • PREFIX：目录前缀，建议选个本身看得顺眼的；
  • DOWNLOAD_DIR：这个重要了，建议选个编译目录同级的，这样删掉编译目录后，就至关于缓存目录了，下次再编译就能够节约下载时间；

• 下载

  • URL & URL_HASH：包的下载与校验，建议即便有 Git 项目也使用，这样能够进一步减小下载时间（就国内的网络克隆 GitHub 而言 T_T）；
  • GIT_REPOSITORY & GIT_TAG：Git 项目克隆，建议加上 GIT_SHALLOW，减小克隆项目的体积；

• 更新

  • PATCH_COMMAND 这个能够修改后的源文件，好比你能够做为临时 BUG 的修改方案，毕竟项目的维护者不必定会及时改掉；

• 配置

  • CONFIGURE_COMMAND：非 CMake 项目的配置参数，能够执行配置命令，如 ./configure --prefix=${CMAKE_INSTALL_PREFIX}，另外须要配置 BUILD_IN_SOURCE true；
  • CMAKE_ARGS：CMake 项目的配置参数，如 -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}；

• 编译

  • 多数状况下可略过

• 测试

  • TEST_COMMAND： 须要测试编译机器执行状况的能够设置，多数状况下可略过，留空便可：TEST_COMMAND ""；

• 安装

  • INSTALL_COMMAND：多数状况下也能够略过，执行的标准 make install 命令，若是不是这个安装命令，能够修改；

• 其它

  • DEPENDS：有其它依赖的，能够配置这个选项，它会理清这些依赖的关系，而后依次编译；

在配置的时候，正如你看到的，我会经过设置 prefix 为 ${CMAKE_INSTALL_PREFIX} 将全部的第三方依赖安装在一个可配置的统一目录，这样就很方便一块儿打包。另外，这样有另外一个好处，若是有依赖关系，大部分状况就能自动解决。

至于 ExternalProject_Add_Step 跟其它两个就略过了，不怎么用到，可是你想要编译文档的话，仍是能够用的。而 ExternalProject_Get_Property 对于在你将 ExternalProject 做为主项目编译步骤时使用有些用处，只是考虑到它不是在配置时下载编译，毕竟如 target_link_libraies 这类方法须要求你已经有编译产物了，所以不怎么会用到。

当你编译完成后，能够将全部的编译产物打包上传至公共存储空间，而后再在主目录下的 CMakeLists.txt 中写个下载步骤便可，这样，你的全部团队成员们均可以省去第三方代码的编译时间了。

具体代码当作课后做业了，提示以下：

file(DOWNLOAD <url> <file> [...])
file(UPLOAD <file> <url> [...])

或许你会以为，这么作着实有点闹腾，不怕，接下来就介绍一个很方便的工具。

vcpkg

这里必须狠狠夸夸微软，今年来给开源界贡献了很是多的产品以及工具，vcpkg 就是其中的一个。

简单来讲，它就是基于 CMake 的一个包管理工具，在安装完成后，一条命令就能安装绝大多数的依赖，也有愈来愈多的第三方包也开始接受并提供 vcpkg 的支持。虽然尚未囊括全部的第三方包，交叉编译也存在必定的问题，可是我相信若是接下来能有包管理工具统一 C/C++ 的话，vcpkg 就是候选之一。

它的安装很简单：

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh

若是须要安装包：

vcpkg install opencv

而后在你的项目中，使用 find_package 便可：

find_package(OpenCV REQUIRED)
target_link_libraries(target ${OpenCV_LIBS})

最后，在 CMake 配置阶段：

cmake .. -DCMAKE_TOOLCHAIN_FILE=path/to/vcpkg/scripts/buildsystems/vcpkg.cmake

就能够了，对于 OpenCV 这类有着系统支持的包，或许没有提高太多的效率，可是对于一些没有多少系统支持的包，好比 GoogleTest、nlohmann-json、prometheus-cpp 等，不再须要费劲去本身下载编译了。

以后，为了方便随时运行 vcpkg，能够将它加到系统 PATH：

export PATH="path/to/vcpkg/:$PATH"

是否是很简单？只是，目前它仍是不完善，我之因此不在现有的团队项目中使用它，就是由于交叉编译的问题没解决，它目前支持的交叉编译很少，好比面对 Android 还有 iOS 的交叉编译，它就基本上成了废物通常，打算等往后它完善了再用。

另外，它相对于我上面的方案来讲，编译时间仍是不能省去的。

---

感谢阅读，本文首发于 Github issues: https://github.com/xizhibei/b... (Star 以及 Watch 强烈暗示 🙈)；另外这篇文章也能在本人博客内阅读：https://blog.xizhibei.me/2020... 。

本文采用 署名-非商业性使用-相同方式共享（BY-NC-SA）进行许可。