02.29 Android NDK 開發之 CMake 必知必會

Android Studio 從 2.2 版本起開始支持 CMake ,可以通過 CMake 和 NDK 將 C/C++ 代碼編譯成底層的庫,然後再配合 Gradle 的編譯將庫打包到 APK 中。

這意味就不需要再編寫 .mk 文件來編譯 so 動態庫了。

CMake 是一個跨平臺構建系統,在 Android Studio 引入 CMake 之前,它就已經被廣泛運用了。

Google 官方網站上有對 CMake 的使用示範,可以參考 官方指南。

總結官網對 CMake 的使用,其實也就如下的步驟:

  1. add_library 指定要編譯的庫,並將所有的 .c 或 .cpp 文件包含指定。
  2. include_directories 將頭文件添加到搜索路徑中
  3. set_target_properties 設置庫的一些屬性
  4. target_link_libraries 將庫與其他庫相關聯

如果你對上面的步驟還是不瞭解,那麼接下來就更深入瞭解 CMake 相關內容吧~~~

CMake 的基本操作

以 Clion 作為工具來講解 CMake 的基本使用。

Android NDK 開發之 CMake 必知必會

clion_cmake_build

CMake 編譯可執行文件

一個打印 hello world 的 cpp 文件,通過 CMake 將它編譯成可執行文件。

在 cpp 的同一目錄下創建 CMakeLists.txt 文件,內容如下:

<code>1# 指定 CMake 使用版本2cmake_minimum_required(VERSION 3.9)3# 工程名4project(HelloCMake)5# 編譯可執行文件6add_executable(HelloCMake main.cpp )/<code>

其中,通過 cmake_minimum_required 方法指定 CMake 使用版本,通過 project 指定工程名。

而 add_executable 就是指定最後編譯的可執行文件名稱和需要編譯的 cpp 文件,如果工程很大,有多個 cpp 文件,那麼都要把它們添加進來。

定義了 CMake 文件之後,就可以開始編譯構建了。

CMake 在構建工程時會生成許多臨時文件,避免讓這些臨時文件汙染代碼,一般會把它們放到一個單獨的目錄中。

操作步驟如下:

<code>1# 在 cpp 目錄下創建 build 目錄2mkdir build3# 調用 cmake 命令生成 makefile 文件4cmake ..5# 編譯6make/<code>

在 build 目錄中可以找到最終生成的可執行文件。

這就是 CMake 的一個簡單操作,將 cpp 編譯成可執行文件,但在 Android 中,大多數場景都是把 cpp 編譯成庫文件。

CMake 編譯靜態庫和動態庫

同樣還是一個 cpp 文件和一個 CMake 文件,cpp 文件內容為打印字符串的函數:

<code>1#include <iostream>2void print() {3    std::cout </<iostream>/<code>

同時,CMake 文件也要做相應更改:

<code>1cmake_minimum_required(VERSION 3.12)2# 指定編譯的庫和文件,SHARED 編譯動態庫3add_library(share_lib SHARED lib.cpp)4# STATIC 編譯靜態庫5# add_library(share_lib STATIC lib.cpp)/<code>

通過 add_library 指定要編譯的庫的名稱,以及動態庫還是靜態庫,還有要編譯的文件。

最後同樣地執行構建,在 build 目錄下可以看到生成的庫文件。

到這裡,就基本可以使用 CMake 來構建 C/C++ 工程了。

CMake 基本語法

熟悉了上面的基本操作之後,就必然會遇到以下的問題了:

  • 如果要參與編譯的 C/C++ 文件很多,難道每個都要手動添加嘛?
  • 可以把編譯好的可執行文件或者庫自動放到指定位置嘛?
  • 可以把編譯好的庫指定版本號嘛?

帶著這些問題,還是要繼續深入學習 CMake 的相關語法,最好的學習材料就是 官網文檔 了。

為了避免直接看官方文檔時一頭霧水,這裡列舉一些常用的語法命令。

註釋與大小寫

在前面就已經用到了 CMake 註釋了,每一行的開頭 # 代表註釋。

另外,CMake 的所有語法指令是不區分大小寫的。

變量定義與消息打印

通過 set 來定義變量:

<code>1# 變量名為 var,值為 hello2set(var hello) /<code>

當需要引用變量時,在變量名外面加上 ${} 符合來引用變量。

<code>1# 引用 var 變量2${var}/<code>

還可以通過 message 在命令行中輸出打印內容。

<code>1set(var hello) 2message(${var})/<code>

數學和字符串操作

數學操作

CMake 中通過 math 來實現數學操作。

<code>1# math 使用,EXPR 為大小2math(EXPR <output-variable> <math-expression>)/<math-expression>/<output-variable>/<code>
<code>1math(EXPR var "1+1")2# 輸出結果為 23message(${var})/<code>

math 支持 +, -, *, /, %, |, &, ^, ~, <> 等操作,和 C 語言中大致相同。

字符串操作

CMake 通過 string 來實現字符串的操作,這波操作有很多,包括將字符串全部大寫、全部小寫、求字符串長度、查找與替換等操作。

具體查看 官方文檔。

<code> 1set(var "this is  string") 2set(sub "this") 3set(sub1 "that") 4# 字符串的查找,結果保存在 result 變量中 5string(FIND ${var} ${sub1} result ) 6# 找到了輸出 0 ,否則為 -1 7message(${result}) 8 9# 將字符串全部大寫10string(TOUPPER ${var} result)11message(${result})1213# 求字符串的長度14string(LENGTH ${var} num)15message(${num})/<code>

另外,通過空白或者分隔符號可以表示字符串序列。

<code>1set(foo this is a list) // 實際內容為字符串序列2message(${foo})/<code>

當字符串中需要用到空白或者分隔符時,再用雙括號""表示為同一個字符串內容。

<code>1set(foo "this is a list") // 實際內容為一個字符串2message(${foo})/<code>

文件操作

CMake 中通過 file 來實現文件操作,包括文件讀寫、下載文件、文件重命名等。

具體查看 官方文檔

<code>1# 文件重命名2file(RENAME "test.txt" "new.txt")34# 文件下載5# 把文件 URL 設定為變量6set(var "http://img.zcool.cn/community/0117e2571b8b246ac72538120dd8a4.jpg")78# 使用 DOWNLOAD 下載9file(DOWNLOAD ${var} "/Users/glumes/CLionProjects/HelloCMake/image.jpg")/<code>

在文件的操作中,還有兩個很重要的指令 GLOB 和 GLOB_RECURSE 。

<code>1# GLOB 的使用2file(GLOB ROOT_SOURCE *.cpp)3# GLOB_RECURSE 的使用4file(GLOB_RECURSE CORE_SOURCE ./detail/*.cpp)/<code>

其中,GLOB 指令會將所有匹配 *.cpp 表達式的文件組成一個列表,並保存在 ROOT_SOURCE 變量中。

而 GLOB_RECURSE 指令和 GLOB 類似,但是它會遍歷匹配目錄的所有文件以及子目錄下面的文件。

使用 GLOB 和 GLOB_RECURSE 有好處,就是當添加需要編譯的文件時,不用再一個一個手動添加了,同一目錄下的內容都被包含在對應變量中了,但也有弊端,就是新建了文件,但是 CMake 並沒有改變,導致在編譯時也會重新產生構建文件,要解決這個問題,就是動一動 CMake,讓編譯器檢測到它有改變就好了。

預定義的常量

在 CMake 中有許多預定義的常量,使用好這些常量能起到事半功倍的效果。

  • CMAKE_CURRENT_SOURCE_DIR
    • 指當前 CMake 文件所在的文件夾路徑
  • CMAKE_SOURCE_DIR
    • 指當前工程的 CMake 文件所在路徑
  • CMAKE_CURRENT_LIST_FILE
    • 指當前 CMake 文件的完整路徑
  • PROJECT_SOURCE_DIR
    • 指當前工程的路徑

比如,在 add_library 中需要指定 cpp 文件的路徑,以 CMAKE_CURRENT_SOURCE_DIR 為基準,指定 cpp 相對它的路徑就好了。

<code>1# 利用預定義的常量來指定文件路徑2add_library( # Sets the name of the library.3             openglutil4             # Sets the library as a shared library.5             SHARED6             # Provides a relative path to your source file(s).7             ${CMAKE_CURRENT_SOURCE_DIR}/opengl_util.cpp8             )/<code>

平臺相關的常量

CMake 能夠用來在 Window、Linux、Mac 平臺下進行編譯,在它的內部也定義了和這些平臺相關的變量。

具體查看 官方文檔 (https://cmake.org/cmake/help/v3.12/manual/cmake-variables.7.html) 。

列舉一些常見的:

  • WIN32
    • 如果編譯的目標系統是 Window,那麼 WIN32 為 True 。
  • UNIX
    • 如果編譯的目標系統是 Unix 或者類 Unix 也就是 Linux ,那麼 UNIX 為 True 。
  • MSVC
    • 如果編譯器是 Window 上的 Visual C++ 之類的,那麼 MSVC 為 True 。
  • ANDROID
    • 如果目標系統是 Android ,那麼 ANDROID 為 1 。
  • APPLE
    • 如果目標系統是 APPLE ,那麼 APPLE 為 1 。

有了這些常量做區分,就可以在一份 CMake 文件中編寫不同平臺的編譯選項。

<code>1if(WIN32){2    # do something3}elseif(UNIX){4    # do something5}/<code>

函數、宏、流程控制和選項 等命令

具體參考 cmake-commands (https://cmake.org/cmake/help/v3.12/manual/cmake-commands.7.html) ,這裡麵包括了很多重要且常見的指令。

簡單示例 CMake 中的函數操作:

<code>1function(add a b)2    message("this is function call")3    math(EXPR num "${a} + ${b}" )4    message("result is ${aa}")5endfunction()67add(1 2)/<code>

其中,function 為定義函數,第一個參數為函數名稱,後面為函數參數。

在調用函數時,參數之間用空格隔開,不要用逗號。

宏的使用與函數使用有點類似:

<code>1macro(del a b)2    message("this is macro call")3    math(EXPR num "${a} - ${b}")4    message("num is ${num}")5endmacro()67del(1 2)/<code>

在流程控制方面,CMake 也提供了 if、else 這樣的操作:

<code>1set(num 0)2if (1 AND ${num})3    message("and operation")4elseif (1 OR ${num})5    message("or operation")6else ()7    message("not reach")8endif ()/<code>

其中,CMake 提供了 AND、OR、NOT、LESS、EQUAL 等等這樣的操作來對數據進行判斷,比如 AND 就是要求兩邊同為 True 才行。

另外 CMake 還提供了循環迭代的操作:

<code>1set(stringList this is string list)2foreach (str ${stringList})3    message("str is ${str}")4endforeach ()/<code>

CMake 還提供了一個 option 指令。

可以通過它來給 CMake 定義一些全局選項:

<code>1option(ENABLE_SHARED "Build shared libraries" TRUE)23if(ENABLE_SHARED)4    # do something5else()6    # do something   7endif()/<code>

可能會覺得 option 無非就是一個 True or False 的標誌位,可以用變量來代替,但使用變量的話,還得添加 ${} 來表示變量,而使用 option 直接引用名稱就好了。

CMake 閱讀實踐

明白了上述的 CMake 語法以及從官網去查找陌生的指令意思,就基本上可以看懂大部分的 CMake 文件了。

這裡舉兩個開源庫的例子:

  • https://github.com/g-truc/glm
    • glm 是一個用來實現矩陣計算的,在 OpenGL 的開發中會用到。
    • CMakeLists.txt 地址在 https://github.com/g-truc/glm/blob/master/CMakeLists.txt
  • https://github.com/libjpeg-turbo/libjpeg-turbo
    • libjpeg-turbo 是用來進行圖片壓縮的,在 Android 底層就是用的它。
    • CMakeLists.txt 地址在 https://github.com/libjpeg-turbo/libjpeg-turbo/blob/master/CMakeLists.txt

這兩個例子中大量用到了前面所講的內容,可以試著讀一讀增加熟練度。

為編譯的庫設置屬性

接下來再回到用 CMake 編譯動態庫的話題上,畢竟 Android NDK 開發也主要是用來編譯庫了,當編譯完 so 之後,我們可以對它做一些操作。

通過 set_target_properties 來給編譯的庫設定相關屬性內容,函數原型如下:

<code>1set_target_properties(target1 target2 ...2                      PROPERTIES prop1 value13                      prop2 value2 ...)/<code>

比如,要將編譯的庫改個名稱:

<code>1set_target_properties(native-lib PROPERTIES OUTPUT_NAME "testlib" )/<code>

更多的屬性內容可以參考官方文檔 (https://cmake.org/cmake/help/v3.9/manual/cmake-properties.7.html#target-properties)。

不過,這裡面有一些屬性設定無效,在 Android Studio 上試了無效,在 CLion 上反而可以,當然也可能是我使用姿勢不對。

比如,實現動態庫的版本號:

<code>1set_target_properties(native-lib PROPERTIES VERSION 1.2 SOVERSION 1 )/<code>

對於已經編譯好的動態庫,想要把它導入進來,也需要用到一個屬性。

比如編譯的 FFmpeg 動態庫,

<code>1# 使用 IMPORTED 表示導入庫2add_library(avcodec-57_lib SHARED IMPORTED)3# 使用 IMPORTED_LOCATION 屬性指定庫的路徑4set_target_properties(avcodec-57_lib PROPERTIES IMPORTED_LOCATION5                        ${CMAKE_CURRENT_SOURCE_DIR}/src/main/jniLibs/armeabi/libavcodec-57.so )/<code>

鏈接到其他的庫

如果編譯了多個庫,並且想庫與庫之間進行鏈接,那麼就要通過 target_link_libraries 。

<code>1target_link_libraries( native-lib2                       glm3                       turbojpeg4                       log )/<code>

在 Android 底層也提供了一些 so 庫供上層鏈接使用,也要通過上面的方式來鏈接,比如最常見的就是 log 庫打印日誌。

如果要鏈接自己編譯的多個庫文件,首先要保證每個庫的代碼都對應一個 CMakeLists.txt 文件,這個 CMakeLists.txt 文件指定當前要編譯的庫的信息。

然後在當前庫的 CMakeLists.txt 文件中通過 ADD_SUBDIRECTORY 將其他庫的目錄添加進來,這樣才能夠鏈接到。

<code>1ADD_SUBDIRECTORY(src/main/cpp/turbojpeg)2ADD_SUBDIRECTORY(src/main/cpp/glm)/<code>

添加頭文件

在使用的時候有一個容易忽略的步驟就是添加頭文件,通過 include_directories 指令把頭文件目錄包含進來。

這樣就可以直接使用 #include "header.h" 的方式包含頭文件,而不用 #include "path/path/header.h" 這樣添加路徑的方式來包含。

小結

以上,就是關於 CMake 的部分總結內容。


分享到:


相關文章: