Android 向您的项目添加 C 和 C++ 代码

为了项目后期开发,需要了解Android JNI的知识,于是开始以下学习过程,那么先从环境开始,后续如果可以的话会持续写相关文章。
环境搭建流程如下:

  1. 安装Android studio


    Android 向您的项目添加 C 和 C++ 代码_第1张图片
    android studio.png

向您的项目添加 C 和 C++ 代码
https://developer.android.google.cn/studio/projects/add-native-code

您可以向 Android 项目添加 C 和 C++ 代码,只需将相应的代码添加到项目模块的 cpp 目录中即可。在您编译项目时,这些代码会编译到一个可由 Gradle 与您的 APK 打包在一起的原生库中。然后,Java 或 Kotlin 代码即可通过 Java 原生接口 (JNI) 调用原生库中的函数。要详细了解如何使用 JNI 框架,请参阅 Android JNI 提示。

下载 NDK 和编译工具

  • Android 原生开发套件 (NDK):一个工具集,让您能够在 Android 应用中使用 C 和 C++ 代码;它提供了各种平台库,让您能够管理原生 Activity 并访问实际设备组件,例如传感器和轻触输入。
  • CMake:一款外部编译工具,可与 Gradle 搭配使用来编译原生库。如果您只计划使用 ndk-build,则不需要此组件。
  • LLDB:Android Studio 用于调试原生代码的调试程序。

您可以使用 SDK 管理器安装这些组件:

  1. 在打开的项目中,从菜单栏依次选择 Tools > SDK Manager
  2. 点击 SDK Tools 标签。
  3. 选中 LLDBCMakeNDK 旁的复选框,如图 1 所示。
  4. 点击 Apply,然后在弹出式对话框中点击 OK。
  5. 安装完成后,点击 Finish,然后点击 OK。


    Android 向您的项目添加 C 和 C++ 代码_第2张图片
    图片.png

使用 CMake 3.6.0 或 3.10.2
SDK 管理器包含 CMake 的 3.6.0 派生版本和版本 3.10.2。未在 build.gradle 中设置特定 CMake 版本的项目均使用 CMake 3.6.0 进行编译。要使用后来包含的版本,请在模块的 build.gradle 文件中指定 CMake 版本 3.10.2:

android {
    ...
    externalNativeBuild {
        cmake {
            ...
            version "3.10.2"
        }
    }
}

您可以指定此 CMake 版本作为最低版本,只需在 build.gradle 条目的末尾添加一个“+”即可,例如 3.10+ 和 3+。不过,这并非最佳做法。

使用自定义 CMake 版本

如果您想使用 SDK 管理器中未包含的 CMake 版本 3.7 或更高版本,请按以下步骤操作:

  1. 从官方 CMake 网站下载并安装 CMake 3.7 或更高版本。
  2. 指定您想要让 Gradle 在模块的 build.gradle 文件中使用的 CMake 版本:
    android {
        ...
        externalNativeBuild {
            cmake {
                ...
                version "cmake-version"
            }
        }
    }
  1. 将 CMake 的安装路径添加到 PATH 环境变量,或将其添加到项目的 local.properties 文件中,具体步骤如下所示。如果 Gradle 找不到您在 build.gradle 文件中指定的 CMake 版本,您便会遇到编译错误。
    # If you set this property, Gradle no longer uses PATH to find CMake.
    cmake.dir="path-to-cmake"
  1. 如果您尚未在工作站上安装 Ninja 编译系统,请访问 Ninja 官方网站,然后下载并安装适用于您的操作系统的最新版本的 Ninja。此外,请务必将 Ninja 的安装路径也添加到 PATH 环境变量。

创建支持 C/C++ 的新项目

创建支持原生代码的新项目的步骤与创建任何其他 Android Studio 项目的步骤相似,但前者还需要执行一个额外的步骤:

  1. 在向导的 Choose your project 部分中,选择 Native C++ 项目类型。
  2. 点击 Next
  3. 填写向导下一部分中的所有其他字段。
  4. 点击 Next
  5. 在向导的 Customize C++ Support 部分中,您可以使用 C++ Standard 字段来自定义项目。使用下拉列表选择您想要使用哪种 C++ 标准化。选择 Toolchain Default 可使用默认的 CMake 设置。
  6. 点击 Finish
    在 Android Studio 完成新项目的创建后,请从 IDE 左侧打开 Project 窗格,然后选择 Android 视图。如图 2 所示,Android Studio 会添加 cpp 组:
Android 向您的项目添加 C 和 C++ 代码_第3张图片
原生源代码和外部编译脚本的 Android 视图组

图 2. 原生源代码和外部编译脚本的 Android 视图组。

cpp 组中,您可以找到项目中的所有原生源代码文件、头文件、CMake 或 ndk-build 的编译脚本,以及项目中的预编译库。对于新项目,Android Studio 会创建一个示例 C++ 源代码文件 native-lib.cpp,并将其置于应用模块的 src/main/cpp/ 目录中。此示例代码提供了一个简单的 C++ 函数 stringFromJNI(),它可以返回字符串“Hello from C++”。要了解如何向项目添加其他源代码文件,请参阅介绍如何创建新的原生源代码文件的部分。

build.gradle 文件指示 Gradle 如何编译应用一样,CMake 和 ndk-build 需要编译脚本以确定如何编译您的原生库。对于新项目,Android Studio 会创建 CMake 编译脚本 CMakeLists.txt,并将其置于模块的根目录中。要详细了解此编译脚本的内容,请参阅配置 CMake。

编译和运行示例应用

点击 Run 图标后,Android Studio 会编译并启动一个应用,此应用会在您的 Android 设备或模拟器上显示文字“Hello from C++”。下面的概览介绍了在编译和运行示例应用时会发生的事件:

  1. Gradle 调用您的外部编译脚本 CMakeLists.txt
  2. CMake 按照编译脚本中的命令将 C++ 源代码文件 native-lib.cpp 编译到共享的对象库中,并将其命名为 libnative-lib.so,Gradle 随后会将后者打包到 APK 中。
  3. 运行时,应用的 MainActivity 会使用 System.loadLibrary() 加载原生库。现在,应用就可以使用库的原生函数 stringFromJNI() 了。
  4. MainActivity.onCreate() 调用 stringFromJNI(),后者返回“来Hello from C++”,并使用它来更新 TextView

如果想要验证 Gradle 是否会将原生库打包到 APK 中,您可以使用 APK 分析器:

  1. 依次选择 Build > Build Bundles(s) / APK(s) > Build APK(s)

  2. 依次选择 Build > Analyze APK

  3. app/build/outputs/apk/ 目录中选择 APK,然后点击 OK

  4. 如图 3 所示,您可以在 lib// 下的 APK 分析器窗口中看到 libnative-lib.so

    Android 向您的项目添加 C 和 C++ 代码_第4张图片
    image

    图 3. 使用 APK 分析器查找原生库。

创建新的 C/C++ 源代码文件

要将新的 C/C++ 源代码文件添加到现有项目,请执行以下操作:

  1. 如果您的应用的主源代码文件集内还没有 cpp/ 目录,请按如下所示的方法创建一个:

  2. 从 IDE 的左侧打开 Project 窗格,然后从下拉菜单中选择 Project 视图。

  3. 转到 your-module > src,右键点击 main 目录,然后依次选择 New > Directory

  4. 输入 cpp 作为目录名称,然后点击 OK

  5. 右键点击 cpp/ 目录,然后依次选择 New > C/C++ Source File

  6. 为您的源代码文件输入一个名称,例如 native-lib

  7. Type 下拉菜单中,为您的源代码文件选择文件扩展名,例如 .cpp

*   您可以向此下拉菜单添加其他文件类型(例如 `.cxx` 或 `.hxx`),只需点击 **Edit File Types** 图标 ![image](https://upload-images.jianshu.io/upload_images/4655344-f2e12559197f3208.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

     即可。在弹出的 **C/C++** 对话框中,从 **Source Extension** 和 **Header Extension** 下拉菜单中选择另一个文件扩展名,然后点击 **OK**。
  1. 如果您还想要创建头文件,请选中 Create an associated header 复选框。

  2. 点击 OK

向项目添加新的 C/C++ 文件后,您仍需要配置 CMake 以将这些文件包含在原生库中。

其他资源

要详细了解如何在应用中支持 C/C++ 代码,请尝试参阅以下资源。

代码实验室

  • 使用 Android Studio 创建 Hello-CMake,这是一个代码实验室,它将向您介绍如何使用 Android Studio CMake 模板开始开发 Android NDK 项目

如果是原生项目想要配置ndk环境,怎么操作呢?
即: 将 Gradle 关联到您的原生库
官方文档: 将 Gradle 关联到您的原生库

Androdi studio 配置Javah命令工具

AS从File进入 Setting 界面,点击 Tools → External Tools → + 配置添加外部工具。参数如下:

Name :JavaH
Program:$JDKPath$/bin/javah
Parameters: -encoding UTF-8 -d ../cpp -jni $FileClass$
Working directory: $SourcepathEntry$\..\java
Android 向您的项目添加 C 和 C++ 代码_第5张图片
配置javah.png

编辑 MainActivity

package com.example.testapp;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity {

    static {
        System.loadLibrary("hello-ndk");
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        //添加下面两行代码
        TextView tv_test = findViewById(R.id.tv_test);
        tv_test .setText(helloNDK());

    }

    public native String helloNDK();
}

生成 .h 头文件

Android 向您的项目添加 C 和 C++ 代码_第6张图片
生成.h头文件.png

会看到在 cpp目录下有生成 com_example_testapp_MainActivity.h的文件

编辑hello-ndk.cpp

#include 
//确认此处名字是否可你生成的头文件的名字一样
#include "com_example_testapp_MainActivity.h"

//函数名要和头文件中的名字一致
JNIEXPORT jstring JNICALL Java_com_example_testapp_MainActivity_helloNDK
        (JNIEnv * env, jobject){
    return env ->NewStringUTF("Hello NDK");
}

运行程序

点击顶部菜单栏 Build中的 Rebuild Projec,完了之后按 Shirt + F10 运行程序,然后界面上就会显示 Hello NDK 的字样。

Android 向您的项目添加 C 和 C++ 代码_第7张图片
显示结果.png

你可能感兴趣的