使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

sewain 發表於 2021-05-11

一、前言

我們在寫應用程式的過程中,經常需要面對一個開發場景:編寫跨平臺的應用程式。

這種要求對於 Linux 系列的平臺來說,還是比較好處理的,大部分情況下只需要換一個交叉編譯工具鏈即可,涉及到硬體平臺相關部分再嵌入幾個內聯彙編。

但是,對於 Windows 平臺來說,就稍微麻煩一些。你可能會說,在 Windows 平臺上用 cygwin, minGW 也可以統一編譯啊,但是你能指望客戶在安裝你的程式時,還需要去部署相容 Linux 的環境嗎?最好的解決方式,還是使用微軟自家的開發環境,比如VS等等。

這篇文章,我們以一個最簡單的程式,來描述如何使用 cmake 這個構建工具,來組織一個跨平臺的應用程式框架。

閱讀這篇文章,您可以收穫下面幾個知識點:

> 1. cmake 在編譯庫檔案、應用程式中的相關指令;
>
> 2. Windows 系統中的動態庫匯出、匯入寫法;
>
> 3. 如何利用巨集定義來進行跨平臺程式設計;

在公眾號後臺留言【430】,可以收到示例程式碼。在 Linux/Windows 系統中可以直接編譯、執行,拿來即用。

二、示例程式碼說明

1. 功能描述

示例程式碼的主要目的,是用來描述如何組織一個跨平臺的應用程式結構。它的功能比較簡單,如下圖所示:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

2. 檔案結構

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

> 1. Common:放置一些開源的第三方庫,例如:網路處理,json 格式解析等等;
>
> 2. Application: 應用程式,使用 Utils生成的庫;
>
> 3. Uitls:放置一些工具、助手函式,例如:檔案處理、字串處理、平臺相關的助手函式等等,最後會編譯得到庫檔案(動態庫 libUtils.so、靜態庫 libUtils.a);
>
> 4. 如果擴充套件其他模組,可以按照 Utils 的檔案結構複製一個即可。

3. cmake 構建步驟

在示例程式碼根目錄下,有一個“總領” CMakeLists.txt 檔案,主要用來設定編譯器、編譯選項,然後去 include 其他資料夾中的 CMakeLists.txt 檔案,如下:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

4. Utils 目錄說明

這個目錄的編譯輸出是庫檔案

> Linux 系統:libUtils.so, libUtils.a;
>
> Windows 系統:libUtils.dll, libUtils.lib, libUtils.a;

其中的 CMakeLists.txt 檔案內容如下:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

目前,程式碼中只寫了一個最簡單的函式 getSystemTimestamp(),在可執行應用程式中,將會呼叫這個函式。

5. Application 目錄說明

這個目錄的編譯輸出是:一個可執行程式,其中呼叫了 libUtils 庫中的函式。

CMakeLists.txt 檔案內容如下:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

三、Linux 系統下操作步驟

1. 建立構建目錄 build

$ mkdir build

在一個獨立的 build 目錄中編譯,生成的中間程式碼不會汙染原始碼,這樣對於使用 git 等版本管控工具來說非常的方便,在提交的時候只需要 ignore build 目錄即可,強烈推薦按照這樣的方式來處理。

2. 執行 cmake,生成 Makefile

$ cd build
$ cmake ..

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

3. 編譯 Utils 庫

$ cd Utils/src
$ make

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

在 CMakeLists.txt 中的最後部分是安裝指令,把產生的庫檔案和標頭檔案,安裝到原始碼中的 install 目錄下。

$ make install

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

4. 編譯可執行程式 Application

Application 使用到了 libUtils.so 庫,因此需要手動把 libUtils.so 和標頭檔案,複製到 Application 下面對應的 lib/linux 和 include 目錄下。

當然,也可以把這個操作寫在 Utils 的安裝命令裡。

$ cd build/Application/src
$ make

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

執行生成的可執行程式 main,即可看到輸出結果。

四、Widnows 系統下操作步驟

1. 通過 cmake 指令生成 VS 工程

同樣的道理,新建一個 build 目錄,然後在其中執行 cmake .. 指令,生成 VS 解決方案,我使用的是 VS2019:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

2. 編譯 Utils 庫檔案

使用 VS2019 開啟工程檔案 DemoApp.sln,在右側的解決方案中,可以看到:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

libUtils_shared 單擊右鍵,選擇【生成】:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

此時,在目錄 build\Utils\src\Debug 下面,可以看到生成的檔案:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

3. 編譯可執行程式 Application

因為Application需要使用 Utils 生成的庫,因此,需要手動把庫和標頭檔案複製到 Application 下面的 lib/win32 和 include 目錄下。

在 VS 解決方案視窗中,在 main 目標上,單擊右鍵,選擇【生成】:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

此時,在目錄 build\Application\src\Debug 下可以看到生成的可執行程式:

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

直接單擊 main.exe 執行,報錯

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

需要把 libUtils.dll 動態庫檔案複製到 main.exe 所在的目錄下,然後再執行,即可成功。

使用 cmake 來搭建跨平臺的應用程式框架:C語言版本

五、總結

這篇文章的操作過程主要以動態庫為主,如果編譯、使用靜態庫,執行過程是一樣一樣的。

如果操作過程有什麼問題,歡迎留言、討論,謝謝!

在公眾號後臺留言【430】,可以收到示例程式碼。在 Linux/Windows 系統中可以直接編譯、執行,拿來即用。

祝您好運!



---------- End ----------

讓知識流動起來,越分享,越幸運!

星標公眾號,能更快找到我!
Hi~你好,我是道哥,一枚嵌入式開發老兵。

推薦閱讀

1. C語言指標-從底層原理到花式技巧,用圖文和程式碼幫你講解透徹
2. 原來gdb的底層除錯原理這麼簡單
3. 一步步分析-如何用C實現物件導向程式設計
4. 圖文分析:如何利用Google的protobuf,來思考、設計、實現自己的RPC框架
5. 都說軟體架構要分層、分模組,具體應該怎麼做(一)
6. 都說軟體架構要分層、分模組,具體應該怎麼做(二)