1. 前言
在車載應用開發時,NDK其實并不常用。不常用但也不是完全用不到,車載應用開發以下的一些場景會需要使用NDK
- 調用Linxu API。例如:將線程綁定到指定的CPU核心上運行。
- 使用高性能圖形API。例如:使用OpenGL ES或Vulkan繪制圖。
- 復用C/C++庫
- 其他需要使用Native API的情況
不過本文并不是NDK的入門教程,NDK的基礎入門教程,請參考官方的中文教程:NDK 使用入門 | Android NDK | Android Developers。
本文主要講解,在Android使用NDK所必須的構建工具 — CMake。
注意本文是面向Android開發者編寫的Cmake基礎教程,完全不適用于非Android開發者閱讀!
2. CMake 概述
2.1. CMake 簡介
CMake是個一個開源的跨平臺自動化建構系統,用來管理軟件建置的程序,并不依賴于某特定編譯器,并可支持多層目錄、多個應用程序與多個庫。 它用配置文件控制建構過程(build process)的方式和Unix的make相似,只是CMake的配置文件取名為CMakeLists.txt。CMake并不直接建構出最終的軟件,而是產生標準的建構檔(如Unix的Makefile或Windows Visual C++的projects/workspaces),然后再依一般的建構方式使用。這使得熟悉某個集成開發環境(IDE)的開發者可以用標準的方式建構他的軟件,這種可以使用各平臺的原生建構系統的能力是CMake和SCons等其他類似系統的區別之處。
CMake配置文件(CMakeLists.txt)可設置源代碼或目標程序庫的路徑、產生適配器(wrapper)、還可以用任意的順序建構可執行文件。CMake支持in-place建構(二進檔和源代碼在同一個目錄樹中)和out-of-place建構(二進檔在別的目錄里),因此可以很容易從同一個源代碼目錄樹中建構出多個二進檔。CMake也支持靜態與動態程序庫的建構。
“CMake”這個名字是"Cross platform Make"的縮寫。雖然名字中含有"make",但是CMake和Unix上常見的“make”系統是分開的,而且更為高端。 它可與原生建置環境結合使用,例如:make、ninja、蘋果的Xcode與微軟的Visual Studio。
初學者需要注意,Cmake并不是只能構建C/C++語言編寫的程序,CMake默認支持所有語言。
CMake 的官方網站:https://cmake.org/
2.2. CMake 在Android中的作用
Android應用開發時,我們只需要知道,CMake是一個外部構建工具,可與 Gradle 搭配使用來構建原生庫即可。
3. CMake 基礎語法
CMake 構建腳本是一個純文本文件,必須將其命名為 CMakeLists.txt
,并在其中包含 CMake 構建 C/C++ 庫時需要使用的命令CMakeLists.txt都是由一個個指令組成的。
我們來看一個簡單的例子,不需要理解它的含義。
project(HELLO)
if(TRUE)
set(SRC_LIST "main.cpp")
add_executable(hello ${SRC_LIST})
endif()
project()
就是一個指令,而HELLO
就是具體的參數。指令不區分大小寫。在Android中默認推薦小寫。
參數與參數之間,用
空格
或;
分割。引用定義好的變量,使用${}。但是在IF控制語句中直接使用變量名即可。
諸如 while、foreach等語句,在Android開發中不是很常用就不介紹了。
4. CMake 常用常量
在CMake中系統定義的常量極多,不過大多數都能見名知意,所以這里只介紹一些相對常用的。
- CMAKE_VERSION: 當前CMake使用的版本
- CMAKE_BINARY_DIR / PROJECT_BINARY_DIR: 工程編譯發生的路徑
- CMAKE_SOURCE_DIR / PROJECT_SOURCE_DIR: 工程的頂層路徑
- CMAKE_CURRENT_BINARY_DIR: 工程編譯結果存放的路徑
- CMAKE_CURRENT_SOURCE_DIR: 當前處理的CMakeLists.txt所在的路徑
- CMAKE_PROJECT_NAME: 工程的名字
- CMAKE_CURRENT_LIST_FILE: 當前CMakeLists.txt所在的完整路徑
- CMAKE_CURRENT_LIST_LINE: 調用這個變量時,在CMakeList.txt中所在的行數
- CMAKE_ANDROID_ARCH_ABI: 編譯的二進制接口(armeabi-v7a、arm64-v8a、x86、x86_64)
在Cmake中常量的使用方式如下:
5. Cmake 常用指令
-
cmake_minimum_required
設定Cmake所需要的最低版本,一般在CMakeLists.txt的開頭聲明。
cmake_minimum_required(VERSION 3.18.1)
-
project
設定工程名。
project("jnidemo")
該指令還可以配置工程支持的語言,缺省時默認支持所有語言,也是推薦使用的方式。
project("jnidemo" CXX) # 支持C++
project("jnidemo" C CXX) # 支持C 和 C++
-
add_library
使用指定的源文件向工程中添加一個共享庫,主要有一下幾種形式。
add_library(<name>
[STATIC | SHARED]
[<source>...])
<name> :設定共享庫的名字。最終編譯出的共享庫會自動加上lib前綴。例如,如果設定目標庫名為jnidemo,最終編譯出的目標庫的名字會是libjnidemo。
[STATIC | SHARED] :設定共享庫的類型,STATIC是靜態庫(libname.a),SHARED是動態庫(libname.so)
[<source>...] :設定源文件。
使用示例:
add_library(jnidemo
SHARED
native-lib.cpp)
一個工程中可以設定添加多個目標庫,gradle會自動將這些共享庫打包到APK中。
add_library
還有一些其他的用法,不過在Android開發中不常用,就不介紹了,以免增加入門學習的門檻。
-
find_library
在系統中查找共享庫的路徑,并賦值給變量。
find_library(
<Varname>
[<path1> <path2> ...] )
<Varname> :變量名。
[<path1> <path2> ...] :需要查找的NDK共享庫名稱。
使用示例:
find_library(
log-lib
log)
查找Android中的log
庫,并將路徑賦值給變量log-lib
。
-
target_link_libraries
將指定的庫鏈接到另一個目標上,這樣就可以在目標中調用被鏈接庫的函數。
target_link_libraries(
[<name>...]
[${<Varname>}...] )
<name>: 目標庫的名字
${<VarName>}: 需要鏈接的共享庫
使用示例:
target_link_libraries(
jnidemo
${log-lib})
該示例中,將log-lib
變量對應的庫,鏈接到jnidemo
這個目標庫中。
-
set_target_properties
設定目標可以具有影響其構建方式的屬性。
set_target_properties(target1 target2 ...
PROPERTIES prop1 value1
prop2 value2 ...)
-
set
為一個CMake變量賦值。
set(SRC log-lib)
也可以將一個變量設置成多個值
set(SRC_LIST main.cpp test1.cpp test2.cpp)
-
message
用于在終端向用戶輸出消息。
message([<mode>] "message to display" ...)
[<mode>]: 可選的輸出形式(這里介紹幾種常用)
缺省:信息打印到終端。
message("message to display")
WARNING :打印警告信息,但是不中斷構建過程。
message(WARNING "message to display")
FATAL_ERROR :打印錯誤信息,終止構建過程。
message(FATAL_ERROR "message to display")
SEND_ERROR :打印錯誤信息,跳過構建過程。
message(SEND_ERROR "message to display")
-
include_directories
將給定的目錄添加到編譯器用于搜索包含文件的目錄。
在編寫JNI程序導入我們自己編寫的頭文件時,需要使用include "xxx..h",而不能使用include <xxx.h>,這是因為""
是從相對路徑查找,而<>
是從搜索路徑查找。使用include_directories
就可以將我們自己編寫的頭文件導入到搜索路徑,這樣就可以使用<>
導入自定義的頭文件。
include_directories([<path1> <path2> ...])
使用示例:
include_directories(${CMAKE_SOURCE_DIR})
add_executable
使用指定的源文件將可執行文件添加到項目中。include
從文件或模塊加載并運行CMake代碼。
include(${OTHER_DIR}/CMakeLists.txt)
-
target_include_directories
將包含目錄添加到目標。
target_include_directories(<target> [SYSTEM] [BEFORE]
<INTERFACE|PUBLIC|PRIVATE> [items1...]
[<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
-
add_definitions
在源文件的編譯中添加-D define標志。
add_definitions(-DFOO -DBAR ...)
CMake的更多指令以及含義,可以參考官方手冊cmake-commands(7) ? CMake 3.18.6 Documentation
6. 總結
以上就是CMake的基礎教程,CMake本身雖然很復雜但是在Android應用開發中的使用卻相對比較簡單,一般只需要記住幾個常用的指令即可。下一篇我們在繼續介紹JNI的基礎。