拥抱 C/C++ : Android JNI 的使用

发表于

编译工具 CMake 以及 Android 上 JNI 的使用介绍。

编译工具 CMake

在Android Studio 2.2 之后，工具中增加了 CMake 的支持，于是我们有两种选择来编译 c/c++ 代码。一个是 ndk-build + Android.mk + Application.mk 组合，另一个是 CMake + CMakeLists.txt 组合。这2个组合与 Android 代码和 c/c++ 代码无关，只是不同的构建脚本和构建命令。

环境配置

Android Studio 的 SDK Tools 安装

  • CMake
  • LLDB
  • NDK

Hello World

先新建一个项目，记得要勾选 C++ support，看一下 Android Studio 自动生成的使用了 JNI 的项目是什么样子的。

目录结构

可以看到，与普通 Android 项目不同的是，支持 C++ 的项目在 app 目录下多了一个 .externalNativeBuild 编译目录与 CMakeLists.txt，main 目录下多了 cpp 目录。

CMakeLists 文件

关于 CMakeLists 文件的作用，我的理解是它指定了编译 c++ 库时所用到的一些配置，先来看看项目里 CMakeList.txt 文件：

1
2
3
4
5
// 去掉注释
cmake_minimum_required(VERSION 3.4.1)
add_library(native-lib SHARED src/main/cpp/native-lib.cpp )
find_library(log-lib log)
target_link_libraries(native-lib ${log-lib} )
  • cmake_minimum_required(VERSION 3.4.1)
    允许构建的最低版本
  • add_library(name path)
    生成链接库，SHARED 表示生成动态库， STATIC表示生成静态库。并指定了参与编译的文件路径
  • find_library(log-lib log)
    添加在编译本地文件时依赖的库（log），并指定别名（log-lib）
  • target_link_libraries(lib1 lib2 …)
    链接库，这里链接了我们自己的库 native-lib 与 log 库

默认的 so 库输出目录为 app/build/intermediates/cmake/debug/obj/${abi} 下，可以在 CMakeLists 中指定输出目录

1
2
#设置生成的so动态库最后输出的路径
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/src/main/jniLibs/${ANDROID_ABI})

再来看 cpp 目录下的 native-lib.cpp 文件：

1
2
3
4
5
6
7
8
9
10
11
12
13
#include <jni.h>
#include <string>

extern "C"
JNIEXPORT jstring

JNICALL
Java_com_yazhidev_cmakedemo_MainActivity_stringFromJNI(
        JNIEnv *env,
        jobject /* this */) {
    std::string hello = "Hello from C++";
    return env->NewStringUTF(hello.c_str());
}

第一次看到 .cpp 格式的源文件肯定有点摸不着头脑，Java 与 C++ 是如何通信的呢？答案就是 JNI。

JNI 规范

JNI (Java Native Interface,Java本地接口)是一种编程框架,使得 Java 虚拟机中的 Java 程序可以调用本地应用/或库,也可以被其他程序调用。

从上面的 native-lib.cpp 文件我们可以一窥 JNI 中 C/C++ 的使用规范：

  • #include
    C 语音中使用 #include <> 直接到系统指定的目录下查找文件，我将其理解为类似 Java 中的导包。JNI 中首先头部需要引入 <jni.h> ，由于使用到了字符串，还导入了 <string>。

  • JNIEXPORT
    JNIEXPORT 和 JNICALL 都是 JNI 的关键字，表示此函数是要被 JNI 调用的。

  • jstring
    是 JNI 中作为中介使 JAVA 的 String 与 C/C++ 的 String 交互的数据类型，JNI的数据类型包含两种，分别是基本类型和引用类型。

  • jobject
    指代调用该方法的对象。如果 Java 中该 native 方法是静态的，则指代该类，即 XXX.class。

  • JNIEnv
    这个env可以看做是 JNI 接口本身的一个对象，在头部引入的 jni.h 头文件中存在着大量被封装好的函数，这些函数也是 JNI 编程中经常被使用到的，要想调用这些函数就需要使用JNIEnv这个对象。除了上面使用到的传递返回值给 Java，还有获取类的 class 类型：evn->GetObjectClass()，改变 Java 中对象的某个变量的值 evn-> SetIntField(...) 等方法。

  • 命名方式
    Java_com_yazhidev_cmakedemo_MainActivity_stringFromJNI()，JNI 中对命名有规定，命名规范为：Java_包名_class_函数名，包名中的 . 也要改为 _，对应的，在 Java 中引用 Native 函数也需要声明关键字 native。

  • std::string、NewStringUTF
    这是 C++ 中字符串的一些写法，需要用时去翻一下语法，不多延伸。

以上只提到了项目里使用到的一些规范和注意点。下面通过写个 demo 实际操作一下。

实战

通过 JNI 对图片做变色处理。

jnigraphics 库

这里要使用到 NDK 里提供的 jnigraphics 库，该库
提供了基于 C/C++ 的接口，可以访问 Android 中的 Bitmap 的像素缓冲区（bitmap buffers）。

头文件中引入 android/bitmap.h，其典型用法如下（摘至 android/bitmap.h 详解）：

a) 用 AndroidBitmap_getInfo() 函数从位图句柄（从JNI得到）获得信息（宽度、高度、像素格式）
b) 用 AndroidBitmap_lockPixels() 对像素缓存上锁，即获得该缓存的指针。
c) 用C/C++ 对这个缓冲区进行读写
d) 用 AndroidBitmap_unlockPixels() 解锁

我们利用该用法对 bitmap 做处理。

新建 Module

首先新建个 module，并新建类 BitmapUtil：

1
2
3
4
5
6
7
8
static {
  // 不要忘记加载库
  System.loadLibrary("bitmap-util");
}

public class BitmapUtil {
    public static native void processBitmap(Bitmap bitmap;
}

并在 main 目录下新建 cpp 目录，新建类 bitmap-util.cpp：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
#include <jni.h>
#include <android/bitmap.h>

extern "C"

JNIEXPORT void JNICALL
Java_com_yazhidev_ndkdemo_BitmapUtil_processBitmap(JNIEnv *env, jobject /* this */, jobject bitmap) {
    //构造 AndroidBitmapInfo
    AndroidBitmapInfo info = {0};
    //将 bitmp 的信息填充给 info
    AndroidBitmap_getInfo(env, bitmap, &info);
    int *buf=NULL;
    //对 bitmap 解码并获取解码后的像素保存在内存中的地址指针，赋值给 srcBuf
    AndroidBitmap_lockPixels(env, bitmap, (void **) &buf);
    //处理像素
    int w = info.width;
    int h = info.height;
    int32_t *srcPixs = (int32_t *) buf;
    int alpha = 0xFF << 24;
    int i, j;
    int color;
    int red;
    int green;
    int blue;
    for (i = 0; i < h; i++) {
        for (j = 0; j < w; j++) {
            // get the color of per pixel
            color = srcPixs[w * i + j];
            red = ((color & 0x00FF0000) >> 16);
            green = ((color & 0x0000FF00) >> 8);
            blue = color & 0x000000FF;
            color = (red + green + blue) / 3;
            color = alpha | (color << 16) | (color << 8) | color;
            srcPixs[w * i + j] = color;
        }
    }
    //释放锁定，显示出被修改的像素数据
    AndroidBitmap_unlockPixels(env, bitmap);
}

module 根目录下新建 CMakeLists.txt 文件：

1
2
3
4
cmake_minimum_required(VERSION 3.4.1)
add_library(bitmap-util SHARED src/main/cpp/bitmap-util.cpp )
# 链接 jnigraphics 库
target_link_libraries(native-lib jnigraphics)

在 module 的 build.gradle 中引用 CMakeLists 文件：

1
2
3
4
5
6
7
8
android {
  ...
  externalNativeBuild {
        cmake {
            path "CMakeLists.txt"
        }
    }
}

Java 中调用：

1
2
3
4
5
// Kotlin image -> ImageView(android:id="@+id/image")
val drawable = resources.getDrawable(R.mipmap.google) as BitmapDrawable
val bitmap = drawable.bitmap
BitmapUtil.processBitmap(bitmap)
image.setImageBitmap(bitmap)

遇到的问题

java.lang.UnsatisfiedLinkError: No implementation found

extern “C”

扩展

项目中导入 so 库

在使用 JNI 时有时可能只有编译好的 so 库，那么如何在项目中使用 so 库呢？

右键 app 目录，选择 new - Folder -JNI Folder，新建一个 JNI 目录用于存放 so 文件。

so 库（CPU）的兼容

使用 CMake 编译 so 库时，可通过配置 gradle 文件指定编译的 so 库架构

1
2
3
4
5
6
7
8
9
10
11
android {
  defaultConfig {
    externalNativeBuild {
      cmake {
        cppFlags ""
        // 生成.so库的目标平台
        abiFilters "armeabi-v7a", "armeabi", "x86"
      }
    }
  }
}

对于CPU来说，不同的架构并不意味着一定互不兼容，根据目前Android共支持七种不同类型的CPU架构，其兼容特点可总结如下：

armeabi设备只兼容armeabi；
armeabi-v7a设备兼容armeabi-v7a、armeabi；
arm64-v8a设备兼容arm64-v8a、armeabi-v7a、armeabi；
X86设备兼容X86、armeabi；
X86_64设备兼容X86_64、X86、armeabi；
mips64设备兼容mips64、mips；
mips只兼容mips；

根据以上的兼容总结，我们还可以得到一些规律：
armeabi的SO文件基本上可以说是万金油，它能运行在除了mips和mips64的设备上，但在非armeabi设备上运行性能还是有所损耗；
64位的CPU架构总能向下兼容其对应的32位指令集，如：x86_64兼容X86，arm64-v8a兼容armeabi-v7a，mips64兼容mips。

更多 so 文件的信息可参考：Android SO文件的兼容和适配

参考

AndroidStudio项目CMakeLists解析
JNI技术规范
Android NDK之旅——图片高斯模糊
Jni接口-深入研究参数的传递（一）
android/bitmap.h 详解