實際工程中,很多時候需要做到工程的分散,尤其是涉及到保密的源碼模塊。這裡以Qt Quick為例基於cmake演示一遍工程的多項目化。 ...
以下內容為本人的著作,如需要轉載,請聲明原文鏈接 微信公眾號「englyf」https://mp.weixin.qq.com/s/o-_aGqreuQda-ZmKktvxwA
以往在公司開發眾多的項目中,都會出現要求本項目里部分功能模塊代碼需要具備保密性。如果需要對外輸出demo工程,那麼需要做到不會泄密。
舉一下爪子,以前做雷達開發的時候,客戶從公司那兒買了這些雷達模塊,也會需要從作為供應商的廠家這裡拿到這些模塊的開發demo(也就是示範軟體工程)。但是由於demo里可能會用到一些涉及計算的內部演算法函數調用,這些函數的實現屬於公司商業機密是不能對外公開的,於是就提出了對部分代碼保密的需求。
那麼,怎麼引入和管理這些需要保密的代碼模塊呢?一般的做法就是將需要保密的功能模塊以子項目的形式引入到demo工程,這些子項目在編譯時輸出庫文件,而demo工程則通過子項目提供的介面頭文件引用這些庫提供的介面。最後在打包輸出demo工程之前,會把涉及保密功能模塊所屬的子項目源碼從工程目錄樹中刪除掉。被清理掉的子項目只留下生成的庫文件和引用頭文件(如果你的工程用的開發語言是C/C++)。
下麵就繼續用 Qt Quick 的開發示例來展開(果然。。。),這個示例里會實現一個簡單的加法GUI小工具,計算過程所用到的演算法以庫API的形式提供,演算法源碼封裝在庫里。
本示例工程完整代碼見文末鏈接分享!
設計工程目錄
為了方便調用涉密的功能模塊的介面以及打包輸出不包含涉密模塊源碼的demo工程,介面的實現源碼存放在對應模塊的子工程(子項目)目錄內,而介面的聲明所在的頭文件和涉密模塊編譯後輸出的庫文件需要存放在對應模塊子項目的文件夾之外。之所以這樣安排存放位置,是為了方便打包輸出時對demo工程的清理。
看看我的工程目錄:
這裡有兩個項目,一個頂層工程項目,也就是demo工程,命名為 gettingStartWithQtQuickSubProject,存放目錄與工程名一致。另一個是子項目,裡邊代表著涉密模塊的功能源碼,命名為math。每個項目都對應一個CMakeLists.txt配置文件,其他文件視乎項目內容需要而定。
配置子項目
子項目 ./math/src/ 目錄下存放著涉密模塊的實現源碼,這裡只是簡單地演示了加法的計算介面
/* inside file MyMath.cpp */
#include "MyMath.h"
myMath::myMath(QObject *parent) : QObject(parent)
{}
QVariant myMath::sum(QVariant a, QVariant b)
{
return a.toInt() + b.toInt();
}
定義介面源文件
子項目math的所有源文件都存放在 ./math/src/ 目錄下,所以將該目錄指定為源文件搜索目錄,並將搜索結果存到cmake自定義變數DIR_SRCS中,
aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/src DIR_SRCS)
變數CMAKE_CURRENT_SOURCE_DIR是cmake自帶變數,指向當前所屬項目的配置文件所在目錄,也即是 ./math/。
包含介面頭文件
介面聲明所在的頭文件存放在demo項目的./src/include/中,在子項目中包含對應的目錄需要通過demo項目的源碼目錄相對地指定。
include_directories(${CMAKE_SOURCE_DIR}/src/include)
變數CMAKE_SOURCE_DIR指向的內容就是頂層項目的配置文件(CMakeLists.txt)所在目錄,這裡的demo項目就是頂層項目。
配置輸出庫文件
子項目編譯後輸出的庫文件應該自動輸出到demo項目的./src/libs/中,可以通過設置cmake變數LIBRARY_OUTPUT_PATH來實現。
SET(LIBRARY_OUTPUT_PATH "${CMAKE_SOURCE_DIR}/src/libs")
配置頂層項目(demo項目)
我們以demo項目為頂層項目,根據實際項目需要,本來是可以添加各式各樣的子項目,但是這裡根據示例需要僅添加math子項目。
添加子項目
本項目作為頂層項目,配置文件(CMakeLists.txt)中除了要描述清楚本項目的配置內容,還需要指明添加了哪些子項目,而且子項目需要在編譯頂層項目之前被編譯完成。
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/math)
如上,利用指令add_subdirectory添加了子項目math。此語句必須在add_executable語句之前。在完整工程編譯鏈接後,打包輸出demo工程時,需要手動刪除此語句,因為客戶在拿到demo工程後,不需要重新編譯子項目的內容,而是直接使用庫文件即可。
添加介面頭文件
為了簡化添加源文件和頭文件的過程,採用遞歸目錄搜索的方式,將指定目錄下所有需要的文件檢索到cmake自定義變數SRC_FILES中,方便後邊的編譯引用
file(GLOB_RECURSE SRC_FILES
${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp
${CMAKE_CURRENT_SOURCE_DIR}/src/*.h
)
介面頭文件所在的目錄./src/include也包含在上面的檢索過程中了
添加鏈接庫文件
指定鏈接目錄以及鏈接的庫math
link_directories(${CMAKE_CURRENT_SOURCE_DIR}/src/libs)
link_libraries(math)
輸出demo工程包
完整編譯執行一遍demo工程後,庫文件會被自動保存在demo工程目錄下。編譯過程中,各項目是分開按順序編譯鏈接的,先是子項目,然後才是頂層項目demo。
為了之後能單獨編譯鏈接demo項目內容,需要刪除math目錄,並且在demo工程的頂層CMakeLists.txt文件中,把添加子項目math的語句刪除即可。
執行一下上面的工程
點擊=
執行
好了,簡單演示到這裡,歡迎後續交流...
本示例工程完整代碼git倉庫鏈接: [email protected]:ifi-leung/gettingStartWithQtQuickSubProject.git