【CMake 系列】（三）ExternalProject 實(shí)踐

上次說了第三方依賴管理封拧，提到了我們團(tuán)隊(duì)在使用 ExternalProject 來管理依賴芜茵，這次來說說具體實(shí)踐夷都，以及一個基于 CMake 的開源依賴管理工具 vcpkg像樊。

ExternalProject 實(shí)踐

來看看它長什么樣：

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

是不是很簡單尤莺，顯然不是，文檔里寫成這樣是因?yàn)閰?shù)太多了生棍，驚不驚喜颤霎？

其實(shí)大部分參數(shù)用不到，我就挑選一些常用的參數(shù)來說說涂滴，從步驟來說友酱，它主要分以下幾步：

目錄配置
- PREFIX：目錄前綴，建議選個自己看得順眼的柔纵；
- DOWNLOAD_DIR：這個重要了缔杉，建議選個編譯目錄同級的，這樣刪掉編譯目錄后搁料，就相當(dāng)于緩存目錄了壮吩，下次再編譯就可以節(jié)約下載時間；
下載
- URL & URL_HASH：包的下載與校驗(yàn)加缘，建議即使有 Git 項(xiàng)目也使用鸭叙，這樣可以進(jìn)一步減少下載時間（就國內(nèi)的網(wǎng)絡(luò)克隆 GitHub 而言 T_T）；
- GIT_REPOSITORY & GIT_TAG：Git 項(xiàng)目克隆拣宏，建議加上 GIT_SHALLOW沈贝，減少克隆項(xiàng)目的體積；
更新
- PATCH_COMMAND 這個可以修改后的源文件勋乾，比如你可以作為臨時 BUG 的修改方案宋下，畢竟項(xiàng)目的維護(hù)者不一定會及時改掉嗡善；
配置
- CONFIGURE_COMMAND：非 CMake 項(xiàng)目的配置參數(shù)，可以執(zhí)行配置命令学歧，如 ./configure --prefix=${CMAKE_INSTALL_PREFIX}罩引，另外需要配置 BUILD_IN_SOURCE true；
- CMAKE_ARGS：CMake 項(xiàng)目的配置參數(shù)枝笨，如 -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}袁铐；
編譯
- 多數(shù)情況下可略過
測試
- TEST_COMMAND：需要測試編譯機(jī)器執(zhí)行情況的可以設(shè)置，多數(shù)情況下可略過横浑，留空即可：TEST_COMMAND ""剔桨；
安裝
- INSTALL_COMMAND：多數(shù)情況下也可以略過，執(zhí)行的標(biāo)準(zhǔn) make install 命令徙融，如果不是這個安裝命令洒缀，可以修改；
其它
- DEPENDS：有其它依賴的欺冀，可以配置這個選項(xiàng)树绩，它會理清這些依賴的關(guān)系，然后依次編譯隐轩；

在配置的時候饺饭，正如你看到的，我會通過設(shè)置 prefix 為 ${CMAKE_INSTALL_PREFIX} 將所有的第三方依賴安裝在一個可配置的統(tǒng)一目錄龙助，這樣就很方便一起打包砰奕。另外，這樣有另一個好處提鸟，如果有依賴關(guān)系军援，大部分情況就能自動解決。

至于 ExternalProject_Add_Step 跟其它兩個就略過了称勋，不怎么用到胸哥，但是你想要編譯文檔的話，還是可以用的赡鲜。而 ExternalProject_Get_Property 對于在你將 ExternalProject 作為主項(xiàng)目編譯步驟時使用有些用處空厌，只是考慮到它不是在配置時下載編譯，畢竟如 target_link_libraies 這類方法需要求你已經(jīng)有編譯產(chǎn)物了银酬，因此不怎么會用到嘲更。

當(dāng)你編譯完成后，可以將所有的編譯產(chǎn)物打包上傳至公共存儲空間揩瞪，然后再在主目錄下的 CMakeLists.txt 中寫個下載步驟即可赋朦，這樣，你的所有團(tuán)隊(duì)成員們都可以省去第三方代碼的編譯時間了。

具體代碼當(dāng)做課后作業(yè)了宠哄，提示如下：

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

或許你會覺得壹将，這么做著實(shí)有點(diǎn)鬧騰，不怕毛嫉，接下來就介紹一個很方便的工具诽俯。

vcpkg

這里必須狠狠夸夸微軟，今年來給開源界貢獻(xiàn)了非常多的產(chǎn)品以及工具承粤，vcpkg 就是其中的一個暴区。

簡單來說，它就是基于 CMake 的一個包管理工具密任，在安裝完成后颜启，一條命令就能安裝絕大多數(shù)的依賴偷俭，也有越來越多的第三方包也開始接受并提供 vcpkg 的支持浪讳。雖然還沒有囊括所有的第三方包唱捣，交叉編譯也存在一定的問題滑凉，但是我相信如果接下來能有包管理工具統(tǒng)一 C/C++ 的話，vcpkg 就是候選之一遂跟。

它的安裝很簡單：

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

如果需要安裝包：

vcpkg install opencv

然后在你的項(xiàng)目中负溪，使用 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 這類有著系統(tǒng)支持的包川抡，或許沒有提升太多的效率辐真，但是對于一些沒有多少系統(tǒng)支持的包，比如 GoogleTest崖堤、nlohmann-json侍咱、prometheus-cpp 等，再也不需要費(fèi)勁去自己下載編譯了密幔。

之后楔脯，為了方便隨時運(yùn)行 vcpkg，可以將它加到系統(tǒng) PATH：

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

是不是很簡單胯甩？只是昧廷，目前它還是不完善，我之所以不在現(xiàn)有的團(tuán)隊(duì)項(xiàng)目中使用它偎箫，就是因?yàn)榻徊婢幾g的問題沒解決木柬，它目前支持的交叉編譯不多，比如面對 Android 還有 iOS 的交叉編譯淹办，它就基本上成了廢物一般眉枕，打算等日后它完善了再用。

另外，它相對于我上面的方案來說齐遵，編譯時間還是不能省去的寂玲。

感謝閱讀，本文首發(fā)于 Github issues: https://github.com/xizhibei/blog/issues/135 (Star 以及 Watch 強(qiáng)烈暗示 ??)梗摇；另外這篇文章也能在本人博客內(nèi)閱讀：https://blog.xizhibei.me/2020/03/23/cmake-3-external-project-practise/ 拓哟。

本文采用署名-非商業(yè)性使用-相同方式共享（BY-NC-SA）進(jìn)行許可。