Android NDK 入門與實踐

01-29

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 文件本身的目錄）的路徑，基本上是固定的，不需要去動nLOCAL_PATH := $(call my-dir)nn# 會清除很多 LOCAL_XXX 變數，不會清除 LOCAL_PATH，基本上是固定的，不需要去動ninclude $(CLEAR_VARS)nn# 需要構建模塊的名稱，會自動生成相應的 libNDKSample.so 文件，每個模塊名稱必須唯一，且不含任何空格nLOCAL_MODULE := NDKSamplenn# 包含要構建到模塊中的 C 或 C++ 源文件列表nLOCAL_SRC_FILES := HelloCPP.cppnn# 指定這個模塊里會用到哪些原生 API，詳見：https://developer.android.google.cn/ndk/guides/stable_apis.htmlnLOCAL_LDLIBS := -llognn# 幫助系統將所有內容連接到一起，固定的，不需要去動ninclude $(BUILD_SHARED_LIBRARY)n

Application.mk

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

# 選擇不同的 ABI，多個使用空格作為分隔符，全部是allnAPP_ABI := allnn# 指定要使用的運行時nAPP_STL := gnustl_staticn

調用 C 或 C++

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

HelloCPP.cpp

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

#include <jni.h>nnextern "C"nJNIEXPORT jstring JNICALL Java_com_wuxiaolong_ndksample_HelloLibrary_sayHello(JNIEnv *env, jobject instance) {n //從 C++ 傳字元串到 Javan return env->NewStringUTF("Hello from C++");n}n

說明：

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++ 代碼

直接調用 C 或 C++ 代碼，很方便。

build.gradle

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

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

so 文件輸出目錄

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

NDK 編譯

使用命令 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 {n //……n sourceSets.main {n jni.srcDirs = []n jniLibs.srcDir src/main/libsn }n}n

以上兩種方式可選其一。

HelloLibrary

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

public class HelloLibrary {n static {n //這裡對應 Android.mk 里的 LOCAL_MODULE := NDKSamplen System.loadLibrary("NDKSample");n }nn //使用 native 關鍵字指示以原生代碼形式實現的方法n public native String sayHello();nnn}n

調用 HelloLibrary

可以在自己的 Activity 調用。

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

調試

如果 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環境