分享一個適合【團隊】開發(fā)的cmake【跨平臺】工程模板
之前分享過一篇關(guān)于 cmake 的入門文章:??《使用 cmake 來搭建跨平臺的應(yīng)用程序框架:C語言版本》??,那篇文章重點是描述如何利用 cmake 來編譯或者構(gòu)建跨平臺的工程,并沒有涉及到團隊協(xié)作開發(fā)方面的內(nèi)容。
這篇文章提供了一個簡潔易懂的 cmake 工程模板,可以滿足一個小團隊的合作開發(fā),無論是在代碼安全性,還是開發(fā)效率上,都能滿足基本的開發(fā)需求。
本文詳細描述了文件結(jié)構(gòu)和操作流程,如何在Linux系統(tǒng)使用命令行來編譯,如何在Windows系統(tǒng)中使用VSCode 和Visual Studio 2019來進行開發(fā)和編譯。
使用這個cmake模板之后,代碼的結(jié)構(gòu)非常的清晰,編譯過程中產(chǎn)生的中間文件也不會污染源代碼。
無論是開發(fā)一些個人項目,或者是在一些小團隊中使用是綽綽有余了。
示例代碼中核心的兩個文件就是:app.cmake和lib.cmake,幾乎每一行都有注釋。
文件目錄說明
在團隊開發(fā)工作中,每個人負責(zé)不同的模塊。
從代碼保密的角度看,除了項目負責(zé)人(或者說項目整合人員)有權(quán)限獲取一個項目中的所有代碼之外,每個開發(fā)者通常只擁有自己負責(zé)的模塊。
每個開發(fā)者在編譯自己的模塊時,需要把輸出文件(頭文件、庫文件、文檔)等,匯總到一個中央倉庫中,方便整合人員進行集成編譯。
因此,示例代碼如下圖所示:
CMakeLists.txt:是最外層的 cmake 文件。
install:是所有模塊編譯結(jié)果的安裝目錄,便于項目整合人員集成編譯。
myapp:是一個可執(zhí)行程序的模板。
mymath:是一個動態(tài)鏈接庫的模板。
再來看一下mymath內(nèi)部的文件組織結(jié)構(gòu):
build:存放編譯過程中產(chǎn)生的中間文件,不會污染源代碼。當(dāng)然了,如果使用 git 來進行版本管理,需要把這個目錄添加到 .gitignore 文件中。
lib.cmake:比較重要的 cmake 文件,這個模板的核心價值就在這個文件中。
source:存放源代碼,并且區(qū)分了 linux 和 windows 系統(tǒng),在不同的系統(tǒng)上編譯,會自動編譯對應(yīng)目錄下的 C 文件。
include:存放頭文件。
myapp目錄內(nèi)部結(jié)構(gòu)與mymath幾乎是一樣的,這里就不贅述了。
這兩個模塊的編譯結(jié)果會自動輸出到install目錄,如下圖所示:
在install目錄內(nèi):
include:匯總了所有模塊的頭文件。
library:匯總了所有模塊輸出的庫文件。
bin:匯總了所有的可執(zhí)行程序(一些單元測試程序根據(jù)自己的需要是否輸出此目錄)。
操作:Linux系統(tǒng)下編譯
編譯動態(tài)庫
刪除install下所有文件和目錄,得到一個干凈的目錄。
創(chuàng)建build目錄,存放中間文件:
編譯:
成功編譯后,在install目錄里可以看到編譯的輸出結(jié)果:
編譯可執(zhí)行文件
查看install目錄下的輸出結(jié)果:
運行可執(zhí)行程序
執(zhí)行結(jié)果如下圖:
Windows系統(tǒng)中使用VSCode開發(fā)
創(chuàng)建MSVC工程
在VSCode IDE中,通過菜單【File】-【Open Folder】,打開文件夾demo_cmake。
因為demo_cmake目錄下存在一個頂層CMakeLists.txt文件,所以VSCode偵測到之后會自動進行cmake配置,同時會創(chuàng)建目錄build來存放所有的中間文件。
有些VSCode版本會跳出一個提示窗,讓用戶選擇進行cmake配置,如下一步中所示。
執(zhí)行cmake配置
可以同時按下:【ctrl】 + 【shift】 + 【p】,重新進行cmake配置:
編譯動態(tài)庫
同時按下【shift】+【F7】,(或者按下VSCode最下方 【Build】右側(cè)的編譯目標),彈出窗口:
查看install目錄中的輸出文件:
編譯可執(zhí)行程序
同時按下【shift】+【F7】,選擇編譯myapp。
查看install目錄:
雙擊運行可執(zhí)行程序
Windows只用VS2019來開發(fā)
生成VS2019解決方案
打開命令行窗口: x64 Native Tools Command Prompt for VS 2019。
輸出如圖:
使用VS2019編譯動態(tài)庫
此時,可以看到解決方案:demo_cmake\build\demo_cmake.sln。
使用VS2019打開解決方案文件:
在工程mymath上單擊右鍵,選擇【重新生成】,在輸出信息區(qū)可以看到生成了文件:
編譯可執(zhí)行程序
在工程myapp上單擊右鍵,選擇【重新生成】。
在輸出信息區(qū)可以看到生成了文件:
運行可執(zhí)行程序
我們知道,在Windows平臺上,VS2019只是一個IDE而已,它的底層是調(diào)用MSBuild來執(zhí)行編譯動作的。
MSBuild的角色與cmake非常類似,使用起來也比較方便,以后再總結(jié)一篇關(guān)于MSBuild的模板工程。
本文轉(zhuǎn)載自微信公眾號「IOT物聯(lián)網(wǎng)小鎮(zhèn)」,可以通過以下二維碼關(guān)注。轉(zhuǎn)載本文請聯(lián)系IOT物聯(lián)網(wǎng)小鎮(zhèn)公眾號。