Android NDK相关知识总结（转自Android Developer中文档）

迈不过友情╰ 2023-06-11 12:22 2阅读 0赞

# 1 NDK 使用入门 #

原生开发套件 (NDK) 是一套工具，使您能够在 Android 应用中使用 C 和 C++ 代码，并提供众多平台库，您可使用这些平台库管理原生 Activity 和访问物理设备组件，例如传感器和轻触输入。

对于Android初学者NDK不适合，但是若有以下事项，NDK可以派上用场。

*  进一步提升设备性能，以降低延迟，或运行计算密集型应用，如游戏或物理模拟。
 *  重复使用您自己或其他开发者的 C 或 C++ 库。

流程是：使用NDK将C和CPP代码编译到原生库中，然后使用 **`Gradle`** 将原生库打包到APK中。Java代码便可以通过Java原生接口(JNI)框架调用原生库中的函数。

AS编译原生库的默认编译工具是 **`CMake`**。由于很多现有项目是使用 `ndk-build` 编译工具包，所以AS也支持 ndk-build，但要创建新的原生库，则应使用 CMake。

--------------------

## 1.1 NDK相关组件： ##

*  **`NDK`** : 这套工具使您能在 Android 应用中使用 C 和 C++ 代码。
 *  **`CMake`**: 一款外部编译工具，可与 Gradle 搭配使用来编译原生库。如果使用了 ndk-build，则不需要此组件。
 *  **`LLDB`**：Android Studio 用于调试原生代码的调试程序。

--------------------

## 1.2 创建或导入原生项目 ##

Android Studio 设置完成后，可以直接**创建支持 C/C++ 的新项目**。但如果您要向现有 Android Studio 项目添加或导入原生代码，则需要按以下基本流程操作：

1.  创建**新的原生源文件**。如果您已经拥有原生代码或想要导入预编译原生库，则可跳过此步骤。
2.  创建**CMake编译脚本**：告知CMake如何将原生源文件编译入库。如果导入和关联预编译库或平台库，也需要此编译脚本。如果现有的原生库已有 `CMakeLists.txt` 编译脚本，或使用 ndk-build 并包含 [`Android.mk`][Android.mk] 编译脚本，则可跳过此步骤。
3.  提供一个指向 CMake 或 ndk-build 脚本文件的路径，将 Gradle 关联到原生库。Gradle 使用编译脚本将源代码导入您的 Android Studio 项目并将原生库（SO 文件）打包到 APK 中。
4.  通过点击 **Run** ![从主菜单运行应用][format_png] \[编译并运行应用\]。Gradle 会以依赖项的形式添加 CMake 或 ndk-build 进程，用于编译原生库并将其随 APK 一起打包。

--------------------

# 2 概念 #

## 2.1 简介 ##

Android NDK是一组可以将C或CPP（原生代码）嵌入到Android应用中的工具。其对于想执行以下一项或多项操作的开发者特别有用：

*  在平台之间移植其应用。
 *  重复使用现有库，或者提供其自己的库供重复使用。
 *  在某些情况下提高性能，特别是像游戏这种计算密集型应用。

## 2.2 工作原理 ##

### 2.2.1 主要组件 ###

在编译应用时，使用如下组件：

*  原生**共享**库：NDK从 C/C++ 源代码编译这些库或 `.so` 文件。
 *  原生**静态**库：NDK也可以编译静态库或 `.a` 文件，而我们可以将静态库关联到其他库。
 *  **JNI**（Java 原生接口）：JNI 是 *Java 和 C++ 组件用以互相通信*的接口。
 *  **ABI**（应用二进制借口）：ABI 可以非常精确地定义应用的机器代码在运行时应该如何与系统交互。NDK 根据这些定义编译 `.so` 文件。不同的 ABI 对应不同的架构：NDK 为 32 位 ARM、AArch64、x86 及 x86-64 提供 ABI 支持。
 *  清单：如果编写的应用不包含 Java 组件，则必须在清单中声明 `NativeActivity` 类。

### 2.2.2 流程 ###

为Android开发原生应用的一般流程如下：

1.  设计应用，确定**以 Java 实现的部分，以及需要以原生代码形式实现的部分**。
2.  正常地创建一个支持 C/C++ 的Android应用项目。
3.  如果要编写纯原生应用，要在 `AndroidManifest.xml`中声明 `NativeActivity` 类。
4.  在 **“JNI”** 目录中创建一个描述原生库的 `Android.mk`文件，包括名称、标记、关联库和要编译的源文件。
5.  或者，也可以创建一个配置目标 ABI、工具链、发布/调试模式和 STL 的 `Application.mk` 文件。对于其中任何您未指明的项，将分别使用以下默认值：
    
     *  ABI：所有非弃用的ABI
     *  工具链：Clang
     *  模式：发布
     *  STL：系统
6.  将原生源代码放在项目的 **`jni`** 目录下。
7.  使用 `ndk-build` 编译原生（`.so`， `.a`）库。
8.  编译 Java 组件，生成可执行 `.dex` 文件。
9.  将所有内容封装到一个 APK 文件中，包括 `.so`, `.dex` 以及应用运行所需的其他文件。

--------------------

# 3 JNI #

JNI 是指 Java 原生接口。它定义了 Android 从受管理代码（使用 Java 或 Kotlin 编程语言编写）编译的字节码与原生代码（使用 C/C++ 编写）互动的方式。JNI 不依赖于供应商，支持从动态共享库加载代码，虽然较为繁琐，但有时相当有效。

## 3.1 常规提示 ##

尽量减少 JNI 层的占用空间。您需要从几个方面来考虑实现这一点。您的 JNI 解决方案应该尝试遵循以下准则（按重要程度依次列出，从最重要的开始）：

*  **尽可能减少跨 JNI 层编组资源的次数。** 跨 JNI 层进行编组的费用十分高昂。尝试设计一种接口，尽可能减少需要编组的数据量以及必须进行数据编组的频率。
 *  **尽可能避免在使用受管理编程语言编写的代码与使用 C++ 编写的代码之间进行异步通信**。这样可使 JNI 接口更易于维护。通常，您可以使用与界面相同的语言保持异步更新，以简化异步界面更新。例如，最好使用 Java 编程语言在两个线程之间进行回调（其中一个线程发出阻塞 C++ 调用，然后在阻塞调用完成时通知界面线程），而不是通过 JNI 从界面线程调用使用 Java 代码的 C++ 函数。
 *  **尽可能减少需要接触 JNI 或被 JNI 接触的线程数**。如果您确实需要以 Java 和 C++ 这两种语言来利用线程池，请尝试在池所有者之间（而不是各个工作线程之间）保持 JNI 通信。
 *  **将接口代码保存在少量易于识别的 C++ 和 Java 源位置，以便将来进行重构。** 请根据需要考虑使用 JNI 自动生成库。

--------------------

# 4 ndk-build #

`ndk-build` 脚本可用于编译采用 NDK 基于 Make 的编译系统的项目。

## 4.1 内部编译 ##

运行 ndk-build 脚本相当于运行以下命令：

>     $GNUMAKE -f <ndk>/build/core/build-local.mk
>        <parameters>

`$GNUMAKE` 指向 GNU Make 3.81 或更高版本，`<ndk>` 则指向 NDK 安装目录。您可以根据这项信息从其他 shell 脚本（甚至是您自己的 Make 文件）中调用 ndk-build。

## 4.2 从命令行调用 ##

`ndk-build` 脚本位于 NDK 安装目录顶层。要从命令行运行该脚本，请在应用项目目录或其子目录中进行调用。例如：

$ cd <project>
        $ <ndk>/ndk-build <option>

在此示例中，`<project>` 指向项目的根目录，`<ndk>` 则是您安装 NDK 的目录。

主要有：

*  clean：移除之前生成的所有二进制文件。
 *  V=1：启动编译，并显示编译命令。
 *  \-B：强制执行完整的重新编译。

--------------------

# 5 Android.mk #

## 5.1 概览 ##

`Android.mk` 文件位于项目 `jni/` 目录的子目录中，**用于向编译系统描述源文件和共享库**。它实际上是编译系统解析一次或多次的微小 GNU makefile 片段。`Android.mk` 文件用于**定义`Application.mk`、编译系统和环境变量所未定义的项目范围设置**。它还可**替换特定模块的项目范围设置**。

`Android.mk` 的语法支持将源文件分组为模块。模块是静态库、共享库或独立的可执行文件。可在 `Android.mk` 文件中定义一个或多个模块，也可在多个模块中使用同一个源文件。编译系统只将共享库放入您的应用软件包。此外，静态库可生成共享库。

除了封装库之外，编译系统还可为您处理各种其他事项。例如，您无需在 `Android.mk` 文件中列出头文件或生成的文件之间的显式依赖关系。NDK 编译系统会自动计算这些关系。

此文件的语法与随整个Android 开源项目分发的 `Android.mk` 文件中使用的语法非常接近。虽然使用这些语法的编译系统实现并不相同，但通过有意将语法设计得相似，可使应用开发者更轻松地将源代码重复用于外部库。

## 5.2 基础知识 ##

下面来解释 `Android.mk` 文件中每一行的作用。

*  `Android.mk` 文件必须先定义 `LOCAL_PATH` 变量：

LOCAL_PATH := $(call my-dir)

此变量表示源文件在开发树中的位置。在这行代码中，编译系统提供的宏函数 `my-dir` 将返回当前目录（`Android.mk` 文件本身所在的目录）的路径。

*  下一行声明 `CLEAR_VARS` 变量，其值由编译系统提供。

include $(CLEAR_VARS)

`CLEAR_VARS` 变量指向一个特殊的 GNU Makefile，后者会清除许多 `LOCAL_XXX` 变量，例如 `LOCAL_MODULE`、`LOCAL_SRC_FILES` 和 `LOCAL_STATIC_LIBRARIES`。请注意，GNU Makefile 不会清除 `LOCAL_PATH`。此变量必须保留其值，因为系统在单一 GNU Make 执行环境（其中的所有变量都是全局变量）中解析所有编译控制文件。在描述每个模块之前，必须声明（重新声明）此变量。

*  接下来，`LOCAL_MODULE` 变量存储**要编译的模块的名称**。需要在应用的每个模块中使用一次此变量。

LOCAL_MODULE := hello-jni

每个模块名称**必须唯一**，且**不含任何空格**。编译系统在生成最终共享库文件时，会对您分配给 `LOCAL_MODULE` 的名称自动添加正确的前缀和后缀。例如，上述示例会生成名为 `libhello-jni.so`的库。

*  下一行会**列举源文件**，以空格分隔多个文件：
    
        LOCAL_SRC_FILES := hello-jni.c

`LOCAL_SRC_FILES` 变量必须包含要编译到模块中的 C 和/或 C++ 源文件列表。

*  最后一行帮助系统将所有内容连接到一起：
    
        include $(BUILD_SHARED_LIBRARY)

`BUILD_SHARED_LIBRARY` 变量指向一个 GNU Makefile 脚本，该脚本会收集您自最近 `include` 以来在 `LOCAL_XXX` 变量中定义的所有信息。此脚本确定要编译的内容以及编译方式。

--------------------

# 6 Application.mk #

## 6.1 概览 ##

`Application.mk` 指定了 ndk-build 的**项目范围设置**。默认情况下，它位于应用项目目录中的`jni/Application.mk` 下。

## 6.2 变量 ##

*  **APP\_ABI**
    
    默认情况下，NDK 编译系统会为所有非弃用 ABI 生成代码。您可以使用 `APP_ABI` 设置为特定 ABI 生成代码。下表显示了不同指令集的 `APP_ABI` 设置。
    
    <table> 
     <thead> 
      <tr> 
       <th>指令集</th> 
       <th>值</th> 
      </tr> 
     </thead> 
     <tbody> 
      <tr> 
       <td>32 位 ARMv7</td> 
       <td><code>APP_ABI := armeabi-v7a</code></td> 
      </tr> 
      <tr> 
       <td>64 位 ARMv8 (AArch64）</td> 
       <td><code>APP_ABI := arm64-v8a</code></td> 
      </tr> 
      <tr> 
       <td>x86</td> 
       <td><code>APP_ABI := x86</code></td> 
      </tr> 
      <tr> 
       <td>x86-64</td> 
       <td><code>APP_ABI := x86_64</code></td> 
      </tr> 
      <tr> 
       <td>所有支持的 ABI（默认）</td> 
       <td><code>APP_ABI := all</code></td> 
      </tr> 
     </tbody> 
    </table>
    
    您也可以指定多个值，方法是将它们放在同一行上，中间用空格分隔。例如：
    
        APP_ABI := armeabi-v7a arm64-v8a x86
 *  **APP\_PLATFORM**
    
    `APP_PLATFORM` 会声明编译此应用所面向的 **Android API** 级别，并对应于应用的 `minSdkVersion`。
    
    如果未指定，ndk-build 将以 NDK 支持的最低 API 级别为目标。最新 NDK 支持的最低 API 级别总是足够低，可以支持几乎所有使用中的设备。
    
    **警告**：将 `APP_PLATFORM` 设置为高于应用的 `minSdkVersion` 可能会生成一个无法在旧设备上运行的应用。在大多数情况下，库将无法加载，因为它们引用了在旧设备上不可用的符号。
 *  **APP\_STL**
    
    用于此应用的 **C++ 标准库**。
    
    默认情况下使用 `system` STL。其他选项包括 `c++_shared`、`c++_static` 和 `none`。

--------------------

# 7 CMake #

CMake 编译脚本是一个纯文本文件，您必须将其命名为 `CMakeLists.txt`，并在其中包含 CMake 编译您的 C/C++ 库时需要使用的命令。如果原生源代码文件还没有 CMake 编译脚本，您需要自行创建一个，并在其中包含适当的 CMake 命令。

## 7.1 配置 Cmake 编译脚本 ##

通过添加 CMake 命令来配置您的编译脚本。要指示 CMake 通过原生源代码创建原生库，请将向您的编译脚本添加 `cmake_minimum_required()`和 `add_library()` 命令：

cmake_minimum_required(VERSION 3.4.1)
    add_library( # Specifies the name of the library.
                     native-lib
    
                     # Sets the library as a shared library.
                     SHARED
    
                     # Provides a relative path to your source file(s).
                     src/main/cpp/native-lib.cpp )

在使用 `add_library()` 向 CMake 编译脚本添加源代码文件或库时，Android Studio 还会在您同步项目后在 **Project** 视图中显示相关的头文件。不过，为了让 CMake 能够在编译时找到头文件，您需要向 CMake 编译文件添加 `include_directories()`命令，并指定头文件的路径：

add_library(...)
    
    # Specifies a path to native header files.
    include_directories(src/main/cpp/include/)

CMake 使用 **`liblibrary-name.so`** 规范来为库文件命名。

例如，如果您在编译脚本中指定`“native-lib”`作为共享库的名称，CMake 就会创建一个名为 `libnative-lib.so` 的文件。不过，在 Java 或 Kotlin 代码中加载此库时，请使用您在 CMake 编译脚本中指定的名称：

static {
                
        	System.loadLibrary("native-lib");    
        }

Android Studio 会自动向 **Project** 窗格中的 **cpp** 组添加源代码文件和头文件。通过使用多个 `add_library()` 命令，您可以为 CMake 定义要通过其他源代码文件编译的更多库。

## 7.2 在Gradle中使用CMake变量 ##

要将参数从模块级 `build.gradle` 文件传送到 CMake，请使用以下 （领域特定语言）DSL：

android {
      ...
      defaultConfig {
        ...
        // This block is different from the one you use to link Gradle
        // to your CMake build script.
        externalNativeBuild {
          cmake {
            ...
            // Use the following syntax when passing arguments to variables:
            // arguments "-DVAR_NAME=ARGUMENT".
            arguments "-DANDROID_ARM_NEON=TRUE",
            // If you're passing multiple arguments to a variable, pass them together:
            // arguments "-DVAR_NAME=ARG_1 ARG_2"
            // The following line passes 'rtti' and 'exceptions' to 'ANDROID_CPP_FEATURES'.
                      "-DANDROID_CPP_FEATURES=rtti exceptions"
          }
        }
      }
      buildTypes {...}
    
      // Use this block to link Gradle to your CMake build script.
      externalNativeBuild {
        cmake {...}
      }
    }

[Android.mk]: https://developer.android.google.cn/ndk/guides/android_mk.html
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9kZXZlbG9wZXIuYW5kcm9pZC5nb29nbGUuY24vc3R1ZGlvL2ltYWdlcy9idXR0b25zL3Rvb2xiYXItcnVuLnBuZw?x-oss-process=image/format,png