Android NDK 入門與實踐

NDK 是什麼

NDK 全稱 Native Development Kit，可以讓您在 Android 應用中調用 C 或 C++ 代碼的工具。

NDK 好處

1、NDK 可以生成 .so 文件, 方便代碼共享；

2、增加反編譯的難度；

3、提高性能。

NDK 構建

版本說明

• Android Studio：3.0.1

• Android Plugin for Gradle： com.android.tools.build:gradle:3.0.1

• Gradle：4.1

效果預覽

如圖是使用命令 ndk-build，生成對應的 so 文件。

開始

一開始我們需要在 jni 目錄下新建 Android.mk、Application.mk、HelloCPP.cpp 文件。

Android.mk

必須在 jni 文件夾內創建 Android.mk 配置文件， ndk-build 腳本將查看此文件，其中定義了模塊及其名稱、要編譯的源文件、版本標誌以及要鏈接的庫。

# 構建系統提供的宏函數 my-dir 將返回當前目錄（包含 Android.mk 文件本身的目錄）的路徑，基本上是固定的，不需要去動
LOCAL_PATH := $(call my-dir)
# 會清除很多 LOCAL_XXX 變量，不會清除 LOCAL_PATH，基本上是固定的，不需要去動
include $(CLEAR_VARS)
# 需要構建模塊的名稱，會自動生成相應的 libNDKSample.so 文件，每個模塊名稱必須唯一，且不含任何空格
LOCAL_MODULE := NDKSample
# 包含要構建到模塊中的 C 或 C++ 源文件列表
LOCAL_SRC_FILES := HelloCPP.cpp
# 指定這個模塊裡會用到哪些原生 API，詳見：https://developer.android.google.cn/ndk/guides/stable_apis.html
LOCAL_LDLIBS := -llog
# 幫助系統將所有內容連接到一起，固定的，不需要去動
include $(BUILD_SHARED_LIBRARY)

Application.mk

用於描述應用需要的原生模塊，模塊可以是靜態庫、共享庫或可執行文件。Application.mk 通常也位於 jni 目錄下。

# 選擇不同的 ABI，多個使用空格作為分隔符，全部是all
APP_ABI := all
# 指定要使用的運行時
APP_STL := gnustl_static

調用 C 或 C++

配置好 Android.mk 和 Application.mk，有兩種方法可以調用 C 或 C++ 代碼。現在我們寫個方法，然後演示下 Android 這邊的調用。

HelloCPP.cpp

簡單返回一個字符串，C 或 C++ 這塊我也不是很懂，能看懂大概意思，會調用就好了。

#include <jni.h>
extern "C"
JNIEXPORT jstring JNICALL Java_com_wuxiaolong_ndksample_HelloLibrary_sayHello(JNIEnv *env, jobject instance) {
 //從 C++ 傳字符串到 Java
 return env->NewStringUTF("Hello from C++");
}/<jni.h>

說明：

1、extern "C"：實現 C 和 C++ 的混合編程，用於 C++ 代碼調用 C 的函數；

2、JNIEXPORT 和 JNICALL，用於標識函數用途的兩個宏；

3、jstring，JNI 中的數據類型，對應 Java 中 String 類型，還有 8 種基本數據類型 jbyte、jchar、jshort、jint、jlong、jfloat、jdouble、jboolean，引用數據類型 jintArray、jshortArray、jlongArray 等。

4、函數命名規則：Java類全路徑方法名，這裡的類是那個調用 C 或 C++ 的類，像這裡的 Java_com_wuxiaolong_ndksample_HelloLibrary_sayHello ；

5、函數至少有兩個參數，第一個參數 ：JNIEnv* 是定義任意 native 函數的第一個參數（包括調用 JNI 的 RegisterNatives 函數註冊的函數），指向 JVM 函數表的指針，函數表中的每一個入口指向一個 JNI 函數，每個函數用於訪問 JVM 中特定的數據結構；第二個參數：調用 Java 中 native 方法的實例或 Class 對象，如果這個 native 方法是實例方法，則該參數是 jobject，如果是靜態方法，則是 jclass。

自動編譯

直接調用 C 或 C++ 代碼，也可用於調試。

build.gradle

android {
 compileSdkVersion 27
 defaultConfig {
 //……
 externalNativeBuild {
 ndkBuild {
 //指定 Application.mk 的路徑
 arguments "NDK_APPLICATION_MK:=src/main/jni/Application.mk"
 //指定生成哪些平臺的 so 文件
 //abiFilters "armeabi-v7a", "armeabi"
 //cFlags 和 cppFlags 是用來設置環境變量的, 一般不需要動
 cFlags "-DTEST_C_FLAG1", "-DTEST_C_FLAG2"
 cppFlags "-DTEST_CPP_FLAG2", "-DTEST_CPP_FLAG2"
 }
 }
 }
 externalNativeBuild { 

 ndkBuild {
 //指定 Android.mk 的路徑
 path "src/main/jni/Android.mk"
 }
 }
}

Sync Now，會看見項目多了 .externalNativeBuild 文件夾：

so 文件輸出目錄

app/build/intermediates/ndkBuild/debug/obj/local/arm64-v8a/libNDKSample.so

手動編譯

使用命令 ndk-build，也可以生成對應的 so 文件，然後項目中調用。弊端 C 或 C++ 代碼改動了，需要再次編譯。

下載 NDK

配置環境變量

下載後 NDK 地址：/Users/wuxiaolong/Library/Android/sdk/ndk-bundle，進行 NDK 環境變量配置。

NDK 編譯

進入 jni 目錄，運行命令 ndk-build，如下：

so 文件輸出目錄

會在 jni 同一目錄生成 libs，裡面有對應的 abi。

build.gradle

需要 app/build.gradle 指定 so 文件路徑方可調用。

android {
 //……
 sourceSets.main {
 jni.srcDirs = []
 jniLibs.srcDir 'src/main/libs' 

 }
}

CMake

Android Studio 用於構建原生庫的默認工具是 CMake，由於很多現有項目都使用構建工具包編譯其原生代碼，Android Studio 還支持 ndk-build，如果您在創建新的原生庫，則應使用 CMake。

如果您的原生源文件還沒有 CMake 構建腳本，則您需要自行創建一個幷包含適當的 CMake 命令。CMake 構建腳本是一個純文本文件，您必須將其命名為 CMakeLists.txt。本部分介紹了您應包含到構建腳本中的一些基本命令，用於在創建原生庫時指示 CMake 應使用哪些源文件。

注：如果您的項目使用 ndk-build，則不需要創建 CMake 構建腳本。提供一個指向您的 Android.mk 文件的路徑，將 Gradle 關聯到您的原生庫。

要創建一個可以用作 CMake 構建腳本的純文本文件，請按以下步驟操作：

安裝 CMake；

Tools > Android > SDK Manager，點擊 SDK Tools 標籤，選中 CMake，點擊 Apply 安裝；

新建 CMakeLists.txt

CMakeLists.txt 主要用於聲明CMake使用版本、so庫名稱、C/CPP文件路徑等信息。

1、從 IDE 的左側打開 Project 窗格並從下拉菜單中選擇 Project 視圖；

2、右鍵點擊 您的模塊 的根目錄並選擇 New > File；

3、輸入“CMakeLists.txt”作為文件名並點擊 OK；

CMakeLists.txt 示例：

# 設置構建本地庫所需的最小版本
cmake_minimum_required(VERSION 3.4.1)
# 編譯出一個動態庫 HelloCPP，源文件只有 src/main/cpp/HelloCPP.cpp
add_library( # 設置庫的名稱，即 SO 文件的名稱
 NDKSample
 # STATIC：靜態庫，是目標文件的歸檔文件，在鏈接其它目標的時候使用。
 # SHARED：動態庫，會被動態鏈接，在運行時被加載。
 # MODULE：模塊庫，是不會被鏈接到其它目標中的插件，但是可能會在運行時使用dlopen-系列的函數動態鏈接。
 SHARED
 # 要編譯的源代碼文件
 src/main/cpp/HelloCPP.cpp )
# 指定的是頭文件的目錄
# include_directories(src/main/cpp/include/)
# 添加 NDK API，Android NDK 提供了一套實用的原生 API 和庫，通過將 NDK 庫包含到項目的 CMakeLists.txt 腳本文件中。
find_library( # 定位 Android 特定的日誌支持庫並將其路徑存儲在 log-lib 中
 log-lib
 # Specifies the name of the NDK library that
 # CMake needs to locate.
 log )
# 為了確保您的原生庫可以在 log 庫中調用函數，您需要使用 CMake 構建腳本中的 target_link_libraries() 命令關聯庫。 

target_link_libraries( # Specifies the target library.
 NDKSample
 # Links the log library to the target library.
 ${log-lib} )

C 或 C++ 代碼

main 下面增加了 cpp 目錄，即放置 C 或 C++ 代碼的地方；

HelloCPP.cpp

#include <jni.h>
#include <string>
extern "C"
JNIEXPORT jstring JNICALL
Java_com_wuxiaolong_cmake_HelloLibrary_sayHello(JNIEnv *env, jobject) {
 //從 C++ 傳字符串到 Java
 std::string hello = "Hello from C++ by cmake";
 return env->NewStringUTF(hello.c_str());
}/<string>/<jni.h>

app/build.gradle

android {
 defaultConfig {
 //……
 externalNativeBuild {
 cmake {
 //設置 C++ flag，可選配置，-frtti 表示項目支持RTTI；-fexceptions 表示當前項目支持C++異常處理
 cppFlags "-frtti -fexceptions"
 //arguments 語法：-D + 變量，更多變量：https://developer.android.com/ndk/guides/cmake.html
 arguments "-DANDROID_ARM_NEON=TRUE"
 }
 }
 // 指定 ABI
 ndk {
 // Specifies the ABI configurations of your native
 // libraries Gradle should build and package with your APK.
 abiFilters 'armeabi', 'armeabi-v7a'
 }
 }
 externalNativeBuild {
 cmake {
 //指明 CMakeList.txt 路徑 

 path "CMakeLists.txt"
 }
 }
}

so 文件輸出目錄

app/build/intermediates/cmake/

如果在 New Project 時，勾選 Include C++ support，會自動生成上面這些，有個示例。CMake 沒有 Android.mk、Application.mk 文件了。

HelloLibrary

創建 HelloLibrary 用於調用 C 或 C++ 代碼。

public class HelloLibrary {
 static {
 //ndk-build，這裡對應 Android.mk 裡的 LOCAL_MODULE := NDKSample
 //CMake，這裡對應 CMakeLists.txt 裡的 add_library NDKSample
 System.loadLibrary("NDKSample");
 }
 //使用 native 關鍵字指示以原生代碼形式實現的方法
 public native String sayHello();
}

調用 HelloLibrary

可以在自己的 Activity 調用。

TextView text = findViewById(R.id.text);
text.setText(new HelloLibrary().sayHello());

調試

如果 C 或 C++ 那邊代碼出問題了，調試起來要命的，之前只能 log，現在 Android Studio 提供了打斷點來 debug C 或 C++ 代碼，需要使用 LLDB 來檢測到 C 或 C++ 代碼中的斷點，這裡要使用 externalNativeBuild 方式自動編譯 C/C++ 代碼，才能進入斷點進行調試。

Native 模式

選擇 run 下拉 item，選 Edit Configurations，彈出配置窗體，1、添加；2、命令app-native，專門調試 C/C++；3、Module 還是選擇 app；4、Debugger 選擇 Native，只想使用 LLDB 來調試代碼，忽略 Java 代碼中的斷點。

源碼

如果需要這次 Sample 的源碼，可在我的公眾號「吳小龍同學」回覆 NDKSample 獲取。

參考

NDK 入門指南

Android.mk

Application.mk

ABI 管理

Android NDK 介紹與使用示例

NDK開發（二）JNI傳遞參數和返回值

NDK開發，如何配置 debug環境

向您的項目添加 C 和 C++ 代碼

CMake

CMAKE手冊