使用CMake构建NDK项目

# 1. 导言

## 1.1 CMake和NDK介绍

CMake是一个跨平台的构建工具，它可以自动生成构建脚本，例如Makefile或Visual Studio项目文件。Android NDK（Native Development Kit）是一个用于开发使用C/C++编写的Android应用程序的工具集合。

在开发涉及NDK的项目时，使用CMake可以简化构建过程，提高开发效率。CMake使用简单的语法来描述项目的构建配置，可以根据不同的目标平台和架构生成相应的构建文件。

## 1.2 目标读者

本文适合具备一定编程基础和对NDK开发有一定了解的读者。读者应该对C/C++语言以及Android应用开发有一定的了解。

## 1.3 本文主要内容概览

本文将介绍如何使用CMake构建NDK项目。主要内容包括：

- 准备工作：安装Android NDK并配置开发环境，熟悉CMake基本概念。
- 创建CMake项目：创建NDK项目的文件结构，编写CMakeLists.txt文件，添加源文件和头文件，定义目标可执行文件或库。
- 配置NDK构建：设置NDK编译器和工具链，配置CMake生成的Makefile，选择构建架构和ABI。
- 构建和调试：使用CMake生成构建系统，运行构建过程，调试NDK项目。
- 高级主题和最佳实践：使用第三方库，配置NDK宏和选项，以及最佳实践和常见问题解决方案。

希望通过本文的介绍，读者能够掌握使用CMake构建NDK项目的基本步骤，并能够运用到实际的开发中。

# 2. 准备工作

在开始使用CMake构建NDK项目之前，我们需要进行一些准备工作。本章将介绍如何安装Android NDK、配置开发环境以及熟悉CMake的基本概念。

### 2.1 安装Android NDK

Android NDK是一个用于开发Android应用的工具集合，其中包含了用于构建原生代码的编译器、工具链和库文件。安装Android NDK是使用CMake构建NDK项目的前提条件。

你可以从[Android开发者官网](https://developer.android.com/ndk/downloads)上下载最新版本的安装包。根据你的开发环境，选择合适的安装包进行下载并按照安装向导进行安装。

### 2.2 配置开发环境

在安装Android NDK之后，我们需要配置开发环境，以便正确使用NDK和CMake。

首先，设置环境变量`NDK_HOME`，指向你安装的Android NDK的根目录。这可以帮助CMake找到NDK的工具链和库文件。

export NDK_HOME=/path/to/android-ndk

其次，将NDK的`build/tools`目录添加到环境变量`PATH`中，这样可以在命令行中直接运行NDK提供的工具。

export PATH=$PATH:$NDK_HOME/build/tools

最后，检查是否正确配置了Java开发工具，包括Java Development Kit (JDK) 和 Android SDK。确保`JAVA_HOME`和`ANDROID_SDK_ROOT`环境变量正确指向相应的路径。

### 2.3 熟悉CMake基本概念

在使用CMake构建NDK项目之前，建议你熟悉一些基本的CMake概念和语法。CMake使用一种命令式的配置脚本语言，可以用于描述项目的构建过程。以下是一些常用的CMake命令和语法：

- `cmake_minimum_required`：指定所需的最低CMake版本。
- `project`：定义项目的名称和版本。
- `add_executable`：定义一个可执行文件。
- `add_library`：定义一个库文件。
- `add_subdirectory`：添加子目录到构建中。
- `target_include_directories`：指定源文件的头文件目录。
- `target_link_libraries`：指定链接的库文件。

以上是一些常用的CMake命令和语法，更多详细的CMake用法可以参考CMake官方文档。

在下一章中，我们将开始创建一个CMake项目，并编写CMakeLists.txt文件来构建NDK项目。

# 3. 创建CMake项目

在本章中，我们将详细介绍如何创建一个使用CMake构建的NDK项目。我们将从创建项目文件结构开始，编写CMakeLists.txt文件，添加源文件和头文件，最后定义目标可执行文件或库。

#### 3.1 创建NDK项目文件结构

首先，我们需要创建一个合适的文件结构来组织我们的NDK项目。一般来说，我们可以按照以下结构创建文件夹：

project_root/
    ├── CMakeLists.txt
    ├── src/
    │   ├── main/
    │   │   ├── cpp/
    │   │   │   ├── CMakeLists.txt
    │   │   │   └── ... (源文件)
    │   │   └── jni/
    │   │       ├── CMakeLists.txt
    │   │       └── ... (JNI代码)
    │   └── test/
    │       ├── cpp/
    │       │   ├── CMakeLists.txt
    │       │   └── ... (测试源文件)
    │       └── jni/
    │           ├── CMakeLists.txt
    │           └── ... (测试JNI代码)
    ├── libs/
    ├── build/
    └── ...

在`src/main/cpp/`文件夹中，我们将存放与主要功能相关的源文件，而在`src/main/jni/`文件夹中，我们将存放与JNI相关的代码。类似地，`src/test/cpp/`和`src/test/jni/`文件夹中存放与测试相关的源文件和JNI代码。

#### 3.2 编写CMakeLists.txt文件

接下来，我们需要编写根目录下的`CMakeLists.txt`文件，以指导CMake构建我们的项目。以下是一个示例的`CMakeLists.txt`文件：

cmake_minimum_required(VERSION 3.4.1)

# 定义项目名称
project(MyNDKProject)

# 设置C++编译标准
set(CMAKE_CXX_STANDARD 14)

# 添加并设置NDK模块路径
set(NDK_MODULE_PATH ${CMAKE_SOURCE_DIR}/libs)

# 添加NDK库搜索路径
link_directories(${CMAKE_SOURCE_DIR}/libs/${ANDROID_ABI})

# 添加包含路径
include_directories(src/main/cpp)

# 添加子目录
add_subdirectory(src/main/cpp)

在这个示例中，我们首先指定了CMake的最低版本要求，然后定义了项目名称和项目使用的C++编译标准。接下来，我们设置了NDK模块路径和库搜索路径，并添加了源文件所在的包含路径。最后，我们添加了主要源文件所在的子目录。

#### 3.3 添加源文件和头文件

现在，我们可以在刚才创建的文件结构中添加我们的源代码文件和头文件。根据实际情况，我们将源文件和头文件放置在相应的文件夹中。

在`src/main/cpp/`文件夹中添加源文件，并在`src/main/cpp/CMakeLists.txt`文件中添加以下内容来将其包含进构建：

add_library(mylib SHARED
    file1.cpp
    file2.cpp
    ...
)

同时，确保你已经在头文件中正确地包含了相关的头文件引用。类似地，在`src/main/cpp/CMakeLists.txt`文件中，你可以继续添加任何其他需要构建的C++源文件。

#### 3.4 定义目标可执行文件或库

最后，我们需要定义我们的目标可执行文件或库。在`src/main/cpp/CMakeLists.txt`文件中，添加以下内容来定义一个可执行文件或库的构建：

add_executable(MyExecutable main.cpp)

# 或者

add_library(MyLibrary SHARED
    file1.cpp
    file2.cpp
    ...
)

这样，我们就成功地创建了一个使用CMake构建的NDK项目。在接下来的章节中，我们将讨论如何配置NDK构建，运行构建过程，并进行NDK项目的调试。

希望本章对你在创建CMake项目时有所帮助！下一章，我们将讨论如何配置NDK构建。

# 4. 配置NDK构建

在本章中，我们将深入讨论如何配置NDK构建，包括设置NDK编译器和工具链，配置CMake生成的Makefile，以及选择构建架构和ABI。

#### 4.1 设置NDK编译器和工具链

在使用CMake构建NDK项目时，我们需要确保配置正确的NDK编译器和工具链。这些工具链和编译器会根据所选择的ABI进行配置，以确保生成的可执行文件或库与目标平台兼容。

在CMakeLists.txt文件中，可以使用如下方式配置NDK编译器和工具链：

# 设置NDK路径
set(NDK_PATH /path/to/ndk)

# 配置工具链和编译器
set(CMAKE_SYSTEM_NAME Android)
set(CMAKE_SYSTEM_VERSION 21) # Android API级别
set(CMAKE_ANDROID_ARCH_ABI armeabi-v7a) # 选择所需的ABI
set(CMAKE_ANDROID_STL_TYPE c++_shared) # 选择STL类型

# 设置交叉编译工具链
set(CMAKE_C_COMPILER ${NDK_PATH}/toolchains/llvm/prebuilt/linux-x86_64/bin/clang)
set(CMAKE_CXX_COMPILER ${NDK_PATH}/toolchains/llvm/prebuilt/linux-x86_64/bin/clang++)

#### 4.2 配置CMake生成的Makefile

为了让CMake生成适用于NDK的Makefile，需要在CMakeLists.txt中添加以下内容：

# 设置CMake生成的Makefile格式
set(CMAKE_SYSTEM_NAME Android)
set(CMAKE_SYSTEM_VERSION 21) # Android API级别
set(CMAKE_ANDROID_ARCH_ABI armeabi-v7a) # 选择所需的ABI
set(CMAKE_ANDROID_STL_TYPE c++_shared) # 选择STL类型

#### 4.3 选择构建架构和ABI

在配置NDK构建过程中，需要明确选择所需的构建架构和ABI。这些选择会直接影响生成的可执行文件或库在不同平台上的兼容性。

在CMakeLists.txt中，可以使用如下方式选择构建架构和ABI：

# 选择所需的ABI和架构
set(CMAKE_ANDROID_ARCH_ABI armeabi-v7a) # 选择所需的ABI
set(CMAKE_ANDROID_ARCH_ABI_LIST armeabi-v7a arm64-v8a x86 x86_64) # 枚举所有支持的ABI

# 或者根据不同平台选择ABI
if(${ANDROID_ABI} STREQUAL "armeabi-v7a")
  # 针对armeabi-v7a的配置
elseif(${ANDROID_ABI} STREQUAL "arm64-v8a")
  # 针对arm64-v8a的配置
endif

以上是配置NDK构建过程中常用的设置，具体的配置取决于项目的具体需求和目标平台。务必仔细选择和配置以确保生成的可执行文件或库能够在目标平台上正常运行。

希望这些内容能帮助你更好地理解如何配置NDK构建过程。

接下来我们将继续深入讨论构建和调试NDK项目。

# 5. 构建和调试

在前面的章节中，我们已经创建了一个CMake项目，并配置了NDK的构建设置。现在，让我们来学习如何使用CMake生成构建系统，运行构建过程，并进行调试。

#### 5.1 使用CMake生成构建系统

要使用CMake生成构建系统，首先进入到项目的根目录。然后，在命令行中输入以下命令：

$ cd path/to/project
$ mkdir build
$ cd build
$ cmake ..

上述命令中，`path/to/project`是你的项目路径。首先进入项目根目录，并创建一个名为`build`的文件夹，然后进入该文件夹。然后，我们使用`cmake`命令来生成构建系统的文件。

根据配置的NDK构建设置，CMake将根据你的`CMakeLists.txt`文件生成相应的构建系统文件，例如Makefile。

#### 5.2 运行构建过程

生成构建系统文件后，我们可以使用相应的构建工具来运行构建过程。如果你的构建系统是Makefile，可以使用以下命令来运行构建过程：

$ make

这将根据你的`CMakeLists.txt`文件中定义的规则来编译源文件、链接依赖库，并生成可执行文件或库。

#### 5.3 调试NDK项目

在构建完成后，你可能需要对NDK项目进行调试。幸运的是，NDK提供了一些调试工具和技术。

首先，你可以使用`ndk-gdb`命令来配置和启动NDK调试。在命令行中输入以下命令：

$ ndk-gdb

这将自动配置GDB调试器，并启动应用程序的调试会话。

当GDB调试器启动后，你可以使用常用的GDB命令来进行调试，例如设置断点、单步执行等。这些命令可以帮助你理解代码的执行过程，定位和解决问题。

另外，NDK还提供了一些调试工具，例如`ndk-stack`命令用于解析NDK堆栈跟踪信息，以帮助你分析崩溃和异常情况。

需要注意的是，调试NDK项目可能需要一些额外的配置和步骤。具体的调试步骤和工具可能会因为你的项目和开发环境而有所不同，你可以参考NDK的文档或相关资源来获取更多的帮助和指导。

总结：

本章介绍了如何使用CMake生成构建系统，运行构建过程，并进行调试。通过理解这些步骤和工具，你可以更好地管理和调试你的NDK项目，以便快速解决问题并改进你的应用程序。

# 6. 高级主题和最佳实践

本章将进一步探讨如何在使用CMake构建NDK项目时，应用一些高级主题和最佳实践。这些技巧可以帮助你更好地管理项目的依赖关系，提高构建效率以及解决常见问题。

### 6.1 使用第三方库

在实际的项目开发中，我们经常会使用第三方库来扩展功能或提供更高级的功能支持。使用CMake可以方便地管理第三方库的引用和构建。

#### 6.1.1 引入第三方库的源码

通常情况下，第三方库的源码会以某种方式提供，你可以将其源码文件拷贝到你的项目中，然后在CMakeLists.txt中进行引入。

首先，将第三方库的源码文件拷贝到你的项目的合适的目录下，比如将其放在`libs/thirdparty`目录中。

|-- src
|   |-- main
|       |-- cpp
|           |-- CMakeLists.txt
|-- libs
    |-- thirdparty
        |-- thirdparty.cpp
        |-- thirdparty.h

然后，在你的`CMakeLists.txt`中，使用`add_library`命令引入第三方库的源码文件。

add_library(thirdparty STATIC
            ${CMAKE_SOURCE_DIR}/libs/thirdparty/thirdparty.cpp
            ${CMAKE_SOURCE_DIR}/libs/thirdparty/thirdparty.h)

接下来，你可以在你自己的源码中引用和使用该库。

#### 6.1.2 使用预编译库

有时候，第三方库可能已经被编译为预编译库（.a 或 .so 文件），你只需要将其链接到你的项目中即可。

首先，将预编译库文件拷贝到你的项目的合适的目录下，比如将其放在`libs/prebuilt`目录中。

|-- src
|   |-- main
|       |-- cpp
|           |-- CMakeLists.txt
|-- libs
    |-- prebuilt
        |-- libthirdparty.a

然后，在你的`CMakeLists.txt`中，使用`target_link_libraries`命令链接第三方预编译库。

target_link_libraries(your_target_name
                      ${CMAKE_SOURCE_DIR}/libs/prebuilt/libthirdparty.a)

这样，预编译库就会被链接到你的目标文件中。

### 6.2 在CMake中配置NDK宏和选项

在使用CMake构建NDK项目时，你可能需要根据不同的需求来配置一些NDK特定的宏和编译选项。CMake提供了一种简单的方式来实现这个目的。

首先，在你的`CMakeLists.txt`文件中，通过`add_definitions`命令定义宏和选项。

add_definitions(-DDEBUG_MODE)
add_definitions(-DENABLE_FEATURE_ONE)

接下来，你可以在你的源码中使用这些预定义的宏来开启或关闭特定的功能。

#ifdef DEBUG_MODE
    // 这段代码仅在 DEBUG_MODE 宏被定义时被编译
    // ...
#endif

#ifdef ENABLE_FEATURE_ONE
    // 这段代码仅在 ENABLE_FEATURE_ONE 宏被定义时被编译
    // ...
#endif

### 6.3 最佳实践和常见问题解决方案

在使用CMake构建NDK项目时，有一些最佳实践和常见问题解决方案可以帮助你更好地管理项目并提高开发效率。

- 使用外部构建：将生成的构建系统文件和构建结果文件分离，保持源代码目录的清洁和可维护性。
- 使用变量和宏定义：合理使用CMake中的变量和宏定义，提高代码的可读性和可维护性。
- 注意平台兼容性：在编写CMake脚本时，考虑不同平台和ABI的兼容性，避免出现平台相关的问题。
- 考虑自动化和持续集成：将CMake构建过程纳入自动化和持续集成流程，提高项目的可测试性和可靠性。

通过遵循这些最佳实践和解决常见问题的方案，可以更好地管理和开发NDK项目。

本章介绍了使用CMake构建NDK项目的高级主题和最佳实践。你可以根据项目的需求来选择适合的技巧和方案。希望这些内容能帮助你在使用CMake构建NDK项目的过程中取得更好的效果。

以上就是使用CMake构建NDK项目的全部内容。通过本文的学习，相信你已经对如何使用CMake构建NDK项目有了更清晰的理解。祝你在使用CMake构建NDK项目时取得成功！