CMake常用指令
時間：2024-10-29 來(lai)源：華清遠(yuan)見
在(zai)嵌(qian)入式開發中，CMake 是一(yi)(yi)個強(qiang)大的(de)(de)構建(jian)工具，它能夠幫助我(wo)們管理項目的(de)(de)編(bian)譯過程，使(shi)得(de)代碼的(de)(de)構建(jian)更加(jia)靈(ling)活和高效。本文(wen)將詳(xiang)細介紹 CMake 的(de)(de)一(yi)(yi)些常用指令，讓你輕松掌握 CMake 在(zai)嵌(qian)入式項目中的(de)(de)應用。
一、基本概念
CMake 使用一種名為CMakeLists.txt的文(wen)(wen)件(jian)(jian)來描述項目(mu)的構建規則。在這個文(wen)(wen)件(jian)(jian)中，我們通(tong)過各(ge)種 CMake 指(zhi)令(ling)來指(zhi)定源文(wen)(wen)件(jian)(jian)、庫、編譯選項等(deng)信(xin)息。CMake 會根據這些指(zhi)令(ling)生成適用于不同平臺(tai)的構建文(wen)(wen)件(jian)(jian)，如 Makefile（在 Linux 等(deng)系(xi)統(tong)中）或(huo) Visual Studio 項目(mu)文(wen)(wen)件(jian)(jian)（在 Windows 系(xi)統(tong)中）。
二、常用指令解析
1. project指令
語法(fa)：project(project_name [CXX] [C] [Java])
作(zuo)用：用于定(ding)義(yi)項(xiang)目的名(ming)稱和(he)支持的語(yu)言。例(li)如，project(MyEmbeddedProject C CXX)表示項(xiang)目名(ming)為(wei)MyEmbeddedProject，支持 C 和(he) C++ 語(yu)言。
示例：在CMakeLists.txt文件的(de)開頭通(tong)常會有這(zhe)樣的(de)語句：
project(EmbeddedDemo C CXX)
2. set指令
語法(fa)：set(VARIABLE VALUE)
作用(yong)：用(yong)于設置變量的值。這個(ge)變量可以是各種(zhong) CMake 相(xiang)關的參(can)數，比(bi)如編譯選項、源文件目錄等。
示例：
設置編譯選項：set(CMAKE_BUILD_TYPE Release)，這里將構建(jian)類型設置為Release，還可以(yi)設置為Debug等其(qi)他(ta)類型。
9設(she)置源文件(jian)目(mu)錄：set(SOURCE_DIR src)，然后(hou)在后(hou)續指令中可以(yi)使用${SOURCE_DIR}來(lai)引用這(zhe)個(ge)目(mu)錄。
3. add_executable指令
語法：add_executable(executable_name source_files)
作用(yong)：用(yong)于創(chuang)建一個可(ke)執(zhi)行文件，并指定(ding)其源文件。
示例：
add_executable(my_app main.cpp other_source.cpp)
這將創建一個名為my_app的可執行文件(jian)，其源文件(jian)包(bao)括(kuo)main.cpp和(he)other_source.cpp。
4. add_library指令
語法：
add_library(library_name STATIC source_files)：創(chuang)建靜態庫。
add_library(library_name SHARED source_files)：創建共享庫（動態庫）。
作(zuo)用(yong)：用(yong)于(yu)創建庫文件(jian)，并指定其(qi)源文件(jian)和(he)類型。
示例：
創建靜態庫：
add_library(my_static_lib STATIC static_source.cpp)
創建共享庫：
add_library(my_shared_lib SHARED shared_source.cpp)
5. target_link_libraries指令
語(yu)法：target_link_libraries(target library1 library2...)
作用：將(jiang)目標(biao)（可執行文件或庫）與其他庫進行鏈接。
示例：
add_executable(my_app main.cpp)
add_library(my_lib SHARED lib_source.cpp)
target_link_libraries(my_app my_lib)
這里將my_app可執行文件與my_lib共(gong)享庫(ku)進行鏈接(jie)
6. include_directories指令
語法：include_directories(directory1 directory2...)
作用(yong)：添加(jia)頭(tou)文(wen)件搜(sou)索路徑，使得編譯(yi)器(qi)能(neng)夠(gou)找到(dao)所需(xu)的(de)頭(tou)文(wen)件。
示例：
include_directories(include src/include third_party/include)
7. find_package指令
語法：find_package(PackageName [version] [REQUIRED])
作用(yong)：用(yong)于查找(zhao)系統中已安裝的庫或軟件包，并獲取(qu)其相關信(xin)息，以便在項目中使用(yong)。
示例：
查找 OpenCV 庫：
find_package(OpenCV REQUIRED)
if(OpenCV_FOUND)
include_directories(${OpenCV_INCLUDE_DIRS}) target_link_libraries(my_app ${OpenCV_LIBS})
endif()
8. message指令
語法：
message(STATUS "Some information")：顯示(shi)狀(zhuang)態信息。
message(WARNING "Some warning")：顯示警(jing)告信息。
message(ERROR "Some error")：顯示(shi)錯誤信息。
作用：用于在 CMake 構建(jian)過程中輸出不同級別(bie)的(de)信息，方便開發者了解(jie)構建(jian)過程中的(de)情況。
示例：
message(STATUS "Building for embedded platform.")
三、實際應用案例
假(jia)設我(wo)們有(you)一(yi)個(ge)簡(jian)單的嵌(qian)入式項(xiang)目，包含一(yi)個(ge)主(zhu)程序main.cpp和(he)一(yi)些功(gong)能模塊(kuai)的源文件，我(wo)們要使(shi)用 CMake 來(lai)構建(jian)這個(ge)項(xiang)目。
1.首先創建CMakeLists.txt文件，內容(rong)如下：
project(EmbeddedProject C CXX)
# 設置源(yuan)文件目錄(lu)
set(SOURCE_DIR src)
# 添加源文件
file(GLOB SOURCE_FILES "${SOURCE_DIR}/*.cpp")
# 創建(jian)可執行文件
add_executable(embedded_app ${SOURCE_FILES})
# 設置(zhi)編(bian)譯(yi)選項為(wei)優化大小
set(CMAKE_BUILD_TYPE Release)
# 添加頭文(wen)件搜索路(lu)徑
include_directories(include ${SOURCE_DIR}/include)
# 查找并(bing)鏈接必(bi)要的庫（假設這里需要一個名為mylib的自定義庫）
find_package(mylib REQUIRED)
if(mylib_FOUND)
target_link_libraries(embedded_app ${mylib_LIBRARIES})
endif()
# 輸出構建信息
message(STATUS "Building EmbeddedProject with CMake.";)
2.在項目目錄(lu)下創(chuang)建src文(wen)件(jian)夾，將main.cpp和其他(ta)源文(wen)件(jian)放入其中，并根(gen)據需要(yao)創(chuang)建include文(wen)件(jian)夾存放頭文(wen)件(jian)。
3.如果有自定義庫mylib，確(que)保其CMakeLists.txt文件正確(que)編寫，并且(qie)已經安裝到系統中(zhong)（或(huo)者在項目的適當位置能(neng)夠被(bei) CMake 找到）。
4.在(zai)項目(mu)(mu)目(mu)(mu)錄下(xia)運行 CMake 命令，根據目(mu)(mu)標平臺生(sheng)成相應的構建文件。例如，在(zai) Linux 系統中，可以在(zai)終端進入項目(mu)(mu)目(mu)(mu)錄，執行：cmake.
然后使用相應的構建工具（如(ru)make）進行構建：make
通過以上步驟(zou)，我們就使用(yong) CMake 成功構(gou)建了一個簡單的(de)(de)嵌(qian)入式(shi)項目。在實際(ji)開發中，根(gen)據項目的(de)(de)復(fu)雜程度(du)和(he)需求，還可以進(jin)一步擴展(zhan)和(he)優化 CMake 的(de)(de)配置(zhi)，比如添加更多的(de)(de)編譯選項、處理不(bu)同平臺的(de)(de)差異等。
四、總結
CMake 為(wei)嵌入(ru)式(shi)開發提供了(le)強大而靈活(huo)的(de)構建(jian)(jian)管理功能(neng)(neng)(neng)。掌握其常用(yong)指令，能(neng)(neng)(neng)夠讓我們(men)更加高效地(di)組(zu)織和(he)(he)構建(jian)(jian)嵌入(ru)式(shi)項目(mu)。通過合理地(di)使用(yong)project、set、add_executable、add_library等指令，我們(men)可以清晰地(di)定義項目(mu)的(de)結構和(he)(he)構建(jian)(jian)規(gui)則(ze)。同時(shi)，find_package指令方(fang)便我們(men)集成第三方(fang)庫(ku)，include_directories和(he)(he)target_link_libraries確保了(le)編譯器能(neng)(neng)(neng)夠正(zheng)確找到(dao)頭(tou)文(wen)件(jian)和(he)(he)鏈(lian)接庫(ku)文(wen)件(jian)。在實際應用(yong)中(zhong)，要(yao)根據(ju)項目(mu)的(de)具體需求(qiu)進行靈活(huo)配(pei)置，不斷積累經驗(yan)，以充分(fen)發揮(hui) CMake 在嵌入(ru)式(shi)開發中(zhong)的(de)優勢，輕松拿捏嵌入(ru)式(shi)項目(mu)的(de)構建(jian)(jian)過程(cheng)。
希望本文對(dui)大家理解(jie)和(he)使用 CMake 的常用指令在(zai)嵌入(ru)式開發(fa)中有所幫助。如(ru)果你有任何問題(ti)或建議，歡迎在(zai)評論區留言交流。
