Android NDK/JNI从入门到重新入门

1.1 JNI(Java Native Interface)

提供一种Java字节码调用C/C++的解决方案，JNI描述的是一种技术

1.2 NDK(Native Development Kit)

Android NDK 是一组允许您将 C 或 C++（“原生代码”）嵌入到 Android 应用中的工具，NDK描述的是工具集。 能够在 Android 应用中使用原生代码对于想执行以下一项或多项操作的开发者特别有用：

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

1.3 JNI注册

1.3.1 环境配置

这里已有现成的文章就引用一下别人的了 ，讲的很仔细 关于JNI环境配置

1.3.2 静态注册

当Java层调用navtie函数时，会在JNI库中根据函数名查找对应的JNI函数。如果没找到，会报错。如果找到了，则会在native函数与JNI函数之间建立关联关系，其实就是保存JNI函数的函数指针。下次再调用native函数，就可以直接使用这个函数指针。

JNI函数名格式（包名里面的”.”需要改为”_”）：
Java_ + 包名（com_example_auto_jnitest）+ 类名(_MainActivity) + 函数名(_stringFromJNI)

静态注册缺点：

• 要求JNI函数的名字必须遵循JNI规范的命名格式；
• 名字冗长，容易出错；
• 初次调用会根据函数名去搜索JNI中对应的函数，会影响执行效率；
• 需要编译所有声明了native函数的Java类，每个所生成的class文件都要用javah工具生成一个头文件；

静态注册例子

类 JNITest 包名：com.hqk.jnitestone

package com.hqk.jnitestone;

public class JNITest  {
    
    

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

    public static native String sayHello();
}

对应c++代码 ，cpp 类名为：native-lib.cpp

#include <jni.h>
#include <string>


extern "C"
JNIEXPORT jstring JNICALL
Java_com_hqk_jnitestone_JNITest_sayHello(JNIEnv *env, jclass clazz) {
    
    
    std::string hello = "Hello from C++";
    return env->NewStringUTF(hello.c_str());
}

注：

• cpp 类名为：native-lib.cpp，则对应java交互类 需要加入

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

• java 对应交互类的包名：com.hqk.jnitestone，则cpp对应方法需要将对应[.]转化成[_]；(参照上面格式)

1.3.2 动态注册

通过提供一个函数映射表，注册给JVM虚拟机，这样JVM就可以用函数映射表来调用相应的函数，就不必通过函数名来查找需要调用的函数。

Java与JNI通过JNINativeMethod的结构来建立函数映射表，它在jni.h头文件中定义，其结构内容如下：

typedef struct {
    
    
    const char* name; // 对应交互java 类对应的方法名
    const char* signature;	//对应交互方法的函数签名 （参考本文1.4.3）
    void*       fnPtr;	//对应交互cpp方法的 指针函数 （指向对应函数）
} JNINativeMethod;

1、创建映射表后，调用RegisterNatives函数将映射表注册给JVM;
2、当Java层通过System.loadLibrary加载JNI库时，会在库中查JNI_OnLoad函数。可将JNI_OnLoad视为JNI库的入口函数，需要在这里完成所有函数映射和动态注册工作，及其他一些初始化工作。

概念说完了，实际操作一下

JAVA类 JNITest 包名：com.hqk.jnitestone

package com.hqk.jnitestone;

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

    public static native String sayHello();

    public static native String sayHello2();
}

注意：这里多了一个 sayHello2 方法，方法返回值为: String

CPP类名 native-lib.cpp 对应代码

#include <jni.h>
#include <string>
#include <android/log.h>

extern "C"
JNIEXPORT jstring JNICALL
Java_com_hqk_jnitestone_JNITest_sayHello(JNIEnv *env, jclass clazz) {
    
    
    std::string hello = "Hello from C++";
    return env->NewStringUTF(hello.c_str());
}

//cpp 交互方法
jstring sayHello2(JNIEnv *env, jobject thiz) {
    
    
    std::string hello = "Hello，我是动态注册成功的！";
    return env->NewStringUTF(hello.c_str());
}

// 动态注册 函数 结构数组
static const JNINativeMethod gMethods[] = {
    
     
        {
    
    "sayHello2",	//对应java交互类的方法名
        "()Ljava/lang/String;", //对应方法名的函数签名 （参考本文1.4.3）
         (jstring *) sayHello2 //对应 cpp交互类的指针函数
         } 
};

JNIEXPORT jint JNI_OnLoad(JavaVM *vm, void *reserved) {
    
    
    __android_log_print(ANDROID_LOG_INFO, "native", "Jni_OnLoad");
    JNIEnv *env = NULL;
    if (vm->GetEnv((void **) &env, JNI_VERSION_1_4) != JNI_OK) //从JavaVM获取JNIEnv，一般使用1.4的版本
        return -1;
        //注意：这里 FindClass 必须要和交互类的 包名对应上，并换成[/]符号
    jclass clazz = env->FindClass("com/hqk/jnitestone/JNITest");
    if (!clazz) {
    
    
        __android_log_print(ANDROID_LOG_INFO, "native",
                            "cannot get class: com/hqk/jnitestone/JNITest");
        return -1;
    }
    if (env->RegisterNatives(clazz, gMethods, sizeof(gMethods) / sizeof(gMethods[0]))) {
    
    
        __android_log_print(ANDROID_LOG_INFO, "native", "register native method failed!\n");
        return -1;
    }
    return JNI_VERSION_1_4;
}

从上面代码可以看出

1、CPP类里面 创建了 JNI_OnLoad 方法–》
该方法是在 初始化的时候执行，类似于 activity 的onCreate，
核心代码，就是通过Find找到对应Java类，最后通过RegisterNatives 实现动态注册
2、CPP类里面 新增了JNINativeMethod 类型的 结构数组 ；
3、CPP类里面 新增了 sayHello2 交互方法
4、Java类里面通用新增了 sayHello2方法

1.4 数据类型转换

1.4.1 基本数据转换

1.4.2 引用数据类型转换

除了Class、String、Throwable和基本数据类型的数组外，其余所有Java对象的数据类型在JNI中都用jobject表示。Java中的String也是引用类型，但是由于使用频率较高，所以在JNI中单独创建了一个jstring类型。

• 引用类型不能直接在 Native 层使用，需要根据 JNI 函数进行类型的转化后，才能使用;
• • 多维数组（含二维数组）都是引用类型，需要使用 jobjectArray 类型存取其值；
    例如，二维整型数组就是指向一位数组的数组，其声明使用方式如下：

    //获得一维数组的类引用，即jintArray类型  
    jclass intArrayClass = env->FindClass("[I");   
    //构造一个指向jintArray类一维数组的对象数组，该对象数组初始大小为length，类型为 jsize
    jobjectArray obejctIntArray  =  env->NewObjectArray(length ,intArrayClass , NULL);

1.4.3 JNI函数签名信息

由于Java支持函数重载，因此仅仅根据函数名是没法找到对应的JNI函数。为了解决这个问题，JNI将参数类型和返回值类型作为函数的签名信息。

• JNI规范定义的函数签名信息格式：
  (参数1类型字符…)返回值类型字符

• 函数签名例子:
  3.JNI常用的数据类型及对应字符:
  

1.4.4 JNIEnv介绍

• JNIEnv概念 :
  JNIEnv是一个线程相关的结构体, 该结构体代表了 Java 在本线程的运行环境。通过JNIEnv可以调用到一系列JNI系统函数。
• JNIEnv线程相关性：
  每个线程中都有一个 JNIEnv 指针。JNIEnv只在其所在线程有效, 它不能在线程之间进行传递。

注意：
在C++创建的子线程中获取JNIEnv，要通过调用JavaVM的AttachCurrentThread函数获得。在子线程退出时，要调用JavaVM的DetachCurrentThread函数来释放对应的资源，否则会出错。

JNIEnv 作用：

• 访问Java成员变量和成员方法；
• 调用Java构造方法创建Java对象等。

1.5 JNI编译

1.5.1 Cmake编译

CMake 则是一个跨平台的编译工具，它并不会直接编译出对象，而是根据自定义的语言规则（CMakeLists.txt）生成 对应 makefile 或 project 文件，然后再调用底层的编译， 在Android Studio 2.2 之后支持Cmake编译。

cmake_minimum_required(VERSION 3.4.1)

add_library(
        native-lib
        SHARED
        native-lib.cpp)
find_library(
        log-lib
        log)
target_link_libraries(
        native-lib
        ${
    
    log-lib})

1.5.1.1 add_library 指令

语法：add_library(libname SHARED | STATIC | MODULE [source])

将一组源文件 source 编译出一个库文件，并保存为 libname.so (lib 前缀是生成文件时 CMake自动添加上去的)。其中有三种库文件类型，不写的话，默认为 STATIC;

• SHARED: 表示动态库，可以在(Java)代码中使用 System.loadLibrary(name) 动态调用；
• STATIC: 表示静态库，集成到代码中会在编译时调用；
• MODULE: 只有在使用 dyId 的系统有效，如果不支持 dyId，则被当作 SHARED 对待；
• EXCLUDE_FROM_ALL: 表示这个库不被默认构建，除非其他组件依赖或手工构建;

#将compress.c 编译成 libcompress.so 的共享库
add_library(compress SHARED compress.c)

1.5.1.2 target_link_libraries 指令

语法：target_link_libraries(target library <debug | optimized> library2…)

这个指令可以用来为 target 添加需要的链接的共享库，同样也可以用于为自己编写的共享库添加共享库链接。如：

#指定 compress 工程需要用到 libjpeg 库和 log 库
target_link_libraries(compress libjpeg ${
    
    log-lib})

1.5.1.3 find_library 指令

语法：find_library( name1 path1 path2 …)

VAR 变量表示找到的库全路径，包含库文件名 。例如：

find_library(libX  X11 /usr/lib)
find_library(log-lib log)  #路径为空，应该是查找系统环境变量路径

1.5.1.4 更多详细使用

参考文献：更多关于Cmake的详细使用

1.5.2 Abi架构

ABI（Application binary interface）应用程序二进制接口。不同的CPU 与指令集的每种组合都有定义的 ABI (应用程序二进制接口)，一段程序只有遵循这个接口规范才能在该 CPU 上运行，所以同样的程序代码为了兼容多个不同的CPU，需要为不同的 ABI 构建不同的库文件。当然对于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；

1.6 项目地址

gitHub地址：点击下载