Android NDK 開發之 CMake 必知必會

glumes發表於2018-09-12

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 的基本使用。

clion_cmake_build

CMake 編譯可執行檔案

一個列印 hello world 的 cpp 檔案,通過 CMake 將它編譯成可執行檔案。

在 cpp 的同一目錄下建立 CMakeLists.txt 檔案,內容如下:

# 指定 CMake 使用版本
cmake_minimum_required(VERSION 3.9)
# 工程名
project(HelloCMake)
# 編譯可執行檔案
add_executable(HelloCMake main.cpp )
複製程式碼

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

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

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

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

操作步驟如下:

# 在 cpp 目錄下建立 build 目錄
mkdir build
# 呼叫 cmake 命令生成 makefile 檔案
cmake ..
# 編譯
make
複製程式碼

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

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

CMake 編譯靜態庫和動態庫

同樣還是一個 cpp 檔案和一個 CMake 檔案,cpp 檔案內容為列印字串的函式:

#include <iostream>
void print() {
    std::cout << "hello lib" << std::endl;
}
複製程式碼

同時,CMake 檔案也要做相應更改:

cmake_minimum_required(VERSION 3.12)
# 指定編譯的庫和檔案,SHARED 編譯動態庫
add_library(share_lib SHARED lib.cpp)
# STATIC 編譯靜態庫
# add_library(share_lib STATIC lib.cpp)
複製程式碼

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

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

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

CMake 基本語法

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

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

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

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

註釋與大小寫

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

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

變數定義與訊息列印

通過 set 來定義變數:

# 變數名為 var,值為 hello
set(var hello) 
複製程式碼

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

# 引用 var 變數
${var}
複製程式碼

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

set(var hello) 
message(${var})
複製程式碼

數學和字串操作

數學操作

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

# math 使用,EXPR 為大小
math(EXPR <output-variable> <math-expression>)
複製程式碼
math(EXPR var "1+1")
# 輸出結果為 2
message(${var})
複製程式碼

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

字串操作

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

具體檢視 官方文件

set(var "this is  string")
set(sub "this")
set(sub1 "that")
# 字串的查詢,結果儲存在 result 變數中
string(FIND ${var} ${sub1} result )
# 找到了輸出 0 ,否則為 -1
message(${result})

# 將字串全部大寫
string(TOUPPER ${var} result)
message(${result})

# 求字串的長度
string(LENGTH ${var} num)
message(${num})
複製程式碼

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

set(foo this is a list) // 實際內容為字串序列
message(${foo})
複製程式碼

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

set(foo "this is a list") // 實際內容為一個字串
message(${foo})
複製程式碼

檔案操作

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

具體檢視 官方文件

# 檔案重新命名
file(RENAME "test.txt" "new.txt")

# 檔案下載
# 把檔案 URL 設定為變數
set(var "http://img.zcool.cn/community/0117e2571b8b246ac72538120dd8a4.jpg")

# 使用 DOWNLOAD 下載
file(DOWNLOAD ${var} "/Users/glumes/CLionProjects/HelloCMake/image.jpg")
複製程式碼

在檔案的操作中,還有兩個很重要的指令 GLOBGLOB_RECURSE

# GLOB 的使用
file(GLOB ROOT_SOURCE *.cpp)
# GLOB_RECURSE 的使用
file(GLOB_RECURSE CORE_SOURCE ./detail/*.cpp)
複製程式碼

其中,GLOB 指令會將所有匹配 *.cpp 表示式的檔案組成一個列表,並儲存在 ROOT_SOURCE 變數中。

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

使用 GLOBGLOB_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 相對它的路徑就好了。

# 利用預定義的常量來指定檔案路徑
add_library( # Sets the name of the library.
             openglutil
             # Sets the library as a shared library.
             SHARED
             # Provides a relative path to your source file(s).
             ${CMAKE_CURRENT_SOURCE_DIR}/opengl_util.cpp
             )
複製程式碼

平臺相關的常量

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

具體檢視 官方文件

列舉一些常見的:

  • 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 檔案中編寫不同平臺的編譯選項。

if(WIN32){
    # do something
}elseif(UNIX){
    # do something
}
複製程式碼

函式、巨集、流程控制和選項 等命令

具體參考cmake-commands ,這裡麵包括了很多重要且常見的指令。

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

function(add a b)
    message("this is function call")
    math(EXPR num "${a} + ${b}" )
    message("result is ${aa}")
endfunction()

add(1 2)
複製程式碼

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

在呼叫函式時,引數之間用空格隔開,不要用逗號。

巨集的使用與函式使用有點類似:

macro(del a b)
    message("this is macro call")
    math(EXPR num "${a} - ${b}")
    message("num is ${num}")
endmacro()

del(1 2)
複製程式碼

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

set(num 0)
if (1 AND ${num})
    message("and operation")
elseif (1 OR ${num})
    message("or operation")
else ()
    message("not reach")
endif ()
複製程式碼

其中,CMake 提供了 ANDORNOTLESSEQUAL 等等這樣的操作來對資料進行判斷,比如 AND 就是要求兩邊同為 True 才行。

另外 CMake 還提供了迴圈迭代的操作:

set(stringList this is string list)
foreach (str ${stringList})
    message("str is ${str}")
endforeach ()
複製程式碼

CMake 還提供了一個 option 指令。

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

option(ENABLE_SHARED "Build shared libraries" TRUE)

if(ENABLE_SHARED)
    # do something
else()
    # do something   
endif()
複製程式碼

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

CMake 閱讀實踐

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

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

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

為編譯的庫設定屬性

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

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

set_target_properties(target1 target2 ...
                      PROPERTIES prop1 value1
                      prop2 value2 ...)
複製程式碼

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

set_target_properties(native-lib PROPERTIES OUTPUT_NAME "testlib" )
複製程式碼

更多的屬性內容可以參考 官方文件

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

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

set_target_properties(native-lib PROPERTIES VERSION 1.2 SOVERSION 1 )
複製程式碼

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

比如編譯的 FFmpeg 動態庫,

# 使用 IMPORTED 表示匯入庫
add_library(avcodec-57_lib SHARED IMPORTED)
# 使用 IMPORTED_LOCATION 屬性指定庫的路徑
set_target_properties(avcodec-57_lib PROPERTIES IMPORTED_LOCATION
                        ${CMAKE_CURRENT_SOURCE_DIR}/src/main/jniLibs/armeabi/libavcodec-57.so )
複製程式碼

連結到其他的庫

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

target_link_libraries( native-lib
                       glm
                       turbojpeg
                       log )
複製程式碼

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

如果要連結自己編譯的多個庫檔案,首先要保證每個庫的程式碼都對應一個 CMakeLists.txt 檔案,這個 CMakeLists.txt 檔案指定當前要編譯的庫的資訊。

然後在當前庫的 CMakeLists.txt 檔案中通過 ADD_SUBDIRECTORY 將其他庫的目錄新增進來,這樣才能夠連結到。

ADD_SUBDIRECTORY(src/main/cpp/turbojpeg)
ADD_SUBDIRECTORY(src/main/cpp/glm)
複製程式碼

新增標頭檔案

在使用的時候有一個容易忽略的步驟就是新增標頭檔案,通過 include_directories 指令把標頭檔案目錄包含進來。

這樣就可以直接使用 #include "header.h" 的方式包含標頭檔案,而不用 #include "path/path/header.h" 這樣新增路徑的方式來包含。

小結

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

歡迎關注微信公眾號:【紙上淺談】,獲得最新文章推送~~~

掃碼關注

相關文章