深入 Android 系统 - Android 的 JNI

2141次阅读  |  发布于2年以前

JNI 的作用

JNIJava Native Interface的缩写。JNI不是Android专有的东西,它是从Java继承而来的,但是在Android中,JNI的作用和重要性大大增强了。

Android作为一种嵌入式操作系统,有大量驱动、硬件相关的功能必须在native层实现,另外一些注重性能、功耗的功能使用C/C++来实现也优于用Java来实现。因此,在Android的开发中,无论是应用级的开发,还是系统级的开发都离不开JNIAndroid在编译、应用打包和安装、程序装载等各方面都对JNI进行了有力的支持。

Java语言的执行,离不开虚拟机,因此,当需要在Java代码中调用C/C++层的函数时,需要告诉虚拟机哪个方法代表本地的函数,以及在哪里能找到这个函数,反之也类似。

另外,请记住,一旦使用 JNIJava 程序就丧失了 Java 平台的两个优点:

JNI 用法介绍

JNI 头文件位于libnativehelper/include_jni/jni.h

JavaC/C++

装载 JNI 动态库

为了使用JNI,在调用本地方法前必须把C/C++代码所编译生成的动态库装载到进程的内存空间中。

装载库文件使用的是System类的LoadLibrary方法,原型如下:

public static void loadLibrary (String libname)
复制代码

loadLibrary方法的参数是动态库文件名称的一部分。Android JNI 动态库必须以lib开头,这里传入的参数是去掉前缀lib,以及后缀.so的中间部分。

例如:库文件名为libmyjni.so,装载库的语句要写成loadLibrary("myjni")。为什么不使用全文件名呢?

调用loadLibrary方法不需要指定库文件所在的路径,Android会在几个系统目录下查找动态库

为了保证调用native方法前所需要的动态库已经加载,loadLibrary的调用位置一般放在类的static块中,这样在类加载的时候就能执行装载语句了。

定义native方法

Java类中定义native方法很简单,在方法前面加上native关键字就可以了,例如:

private native void  init();
复制代码

native方法中,可以使用任何类型作为参数,包括:

native方法在使用上和普通的Java方法没有区别,

编写JNI 动态库

JNI 动态库非 JNI 动态库的区别是:JNI 动态库中定义了一个名为JNI_OnLoader的函数,这个函数在动态库加载后会被系统调用,用于完成JNI 函数的注册

JNI_OnLoader函数的原型如下:

jint JNI_OnLoad(JavaVM* vm, void*)
复制代码

JNI_OnLoader函数中,最重要的一件事就是调用registerNativeMethods函数完成动态库JNI 函数的注册。

所谓注册,就是通过一张表把Java类中定义的native方法本地C函数联系起来,这样虚拟机在解析Java类中的native方法时就能查找到对应的C函数

随便从源码中找个例子来加深下印象:

static JNINativeMethod HdcpJNIMethods[] = {
    /* name, signature, funcPtr */
    { "aml_init_unifykeys", "()Ljava/lang/String;", (void*) aml_init_unifykeys },
    { "aml_key_query_exist", "(Ljava/lang/String;)Ljava/lang/String;", (void*) aml_key_query_exist },
    { "aml_key_get_name", "()Ljava/lang/String;", (void*) aml_key_get_name },
};
JNIEXPORT jint
JNI_OnLoad(JavaVM* vm, void* reserved)
{
    //......
    ret = android::AndroidRuntime::registerNativeMethods(env,
            FINSKY_CLASS_NAME, HdcpJNIMethods, NELEM(HdcpJNIMethods));
    //......
}
复制代码

registerNativeMethods函数的原型是

int registerNativeMethods(C_JNIEnv* env, const char* className,
    const JNINativeMethod* gMethods, int numMethods)
复制代码

参数中:

typedef struct {
    const char* name;
    const char* signature;
    void*       fnPtr;
} JNINativeMethod;
复制代码

JNINativeMethod类型中:

native方法原型要求如下:

返回类型 函数名(JNIEnv *env,jobject obj, ......)
复制代码

举个栗子:

static jstring aml_key_query_exist(JNIEnv *env, jobject obj, jstring keyName)
复制代码

参数签名

native方法的参数签名使用了一些缩写符号来表示参数类型,这些符号都是Java语言规定的。

签名参数返回值组成:

JNI环境中,定义了一些对象来和Java中的基本类型相匹配,我们看下对应表:

参数签名 Java类型 JNI类型
Z boolean jboolean
C char jchar
B byte jbyte
S short jshort
I int jint
J long jlong
F float jfloat
D double jdouble

举例:

使用 JNI 类型

1 . Java的基本类型都是无符号的,但是对应的JNI类型并不都是无符号的,我们看下JNI类型的定义:

//基本类型的定义,可以像Java中的基本类型一样,直接使用
typedef uint8_t  jboolean; /* unsigned 8 bits */
typedef int8_t   jbyte;    /* signed 8 bits */
typedef uint16_t jchar;    /* unsigned 16 bits */
typedef int16_t  jshort;   /* signed 16 bits */
typedef int32_t  jint;     /* signed 32 bits */
typedef int64_t  jlong;    /* signed 64 bits */
typedef float    jfloat;   /* 32-bit IEEE 754 */
typedef double   jdouble;  /* 64-bit IEEE 754 */

//数组类型的定义
//。。。只是定义的jobject的一个别名
//嗯,impressive
typedef void*           jobject;
typedef jobject         jclass;
typedef jobject         jstring;
typedef jobject         jarray;
typedef jarray          jobjectArray;
typedef jarray          jbooleanArray;
typedef jarray          jbyteArray;
//......
复制代码

2 . JNI数组类型,从上面的定义可以看到,其实只是jobject通过typedef定义出来的别名。那我们想操作数组怎么办呢?

在JNIEnv中定义了很多很多和数组相关的操作函数,我们看几个示例:

struct _JNIEnv {
    //......
    jsize GetArrayLength(jarray array){}
    //......
    jint* GetIntArrayElements(jintArray array, jboolean* isCopy){}
    //......
    void ReleaseIntArrayElements(jintArray array, jint* elems,jint mode){}
}
typedef _JNIEnv JNIEnv;
复制代码

有了上面这几个方法,对于一个数组来说,我们就可以:

    // UTF-8 字符相关的操作
    jsize GetStringUTFLength(jstring string){}
    const char* GetStringUTFChars(jstring string, jboolean* isCopy){}
    void ReleaseStringUTFChars(jstring string, const char* utf){}
    //unicode 字符相关的操作
    jsize GetStringLength(jstring string){}
    const jchar* GetStringChars(jstring string, jboolean* isCopy){}
    void ReleaseStringChars(jstring string, const jchar* chars){}
复制代码
jobject GetObjectArrayElement(jobjectArray array, jsize index){}
复制代码

C/C++Java

生成 Java对象

在JNIEnv中生成一个Java对象可以使用函数NewObject

jobject NewObject(jclass clazz, jmethodID methodID, ...){}
复制代码

我们看一个生成Intent对象的例子:

jclass clazz = env->FindClass("android/content/Intent");
jmethodID method = env->GetMethodID(clazz, "<init>", "Ljava/lang/String;");
jstring action = env->NewStringUTF("android.init.action.MAIN");
jobject intent = env->NewObject(clazz,method,action);
复制代码

调用 Java 类的方法

我们看下JNIEnv提供的调用Java类中的方法的函数:

   jobject CallObjectMethod(JNIEnv*, jobject, jmethodID, ...);
    jboolean CallBooleanMethod(JNIEnv*, jobject, jmethodID, ...);
    jbyte CallByteMethod(JNIEnv*, jobject, jmethodID, ...);
    jchar CallCharMethod(JNIEnv*, jobject, jmethodID, ...);
    jshort CallShortMethod(JNIEnv*, jobject, jmethodID, ...);
    jint CallIntMethod(JNIEnv*, jobject, jmethodID, ...);
    jlong CallLongMethod(JNIEnv*, jobject, jmethodID, ...);
    jfloat CallFloatMethod(JNIEnv*, jobject, jmethodID, ...);
    jdouble CallDoubleMethod(JNIEnv*, jobject, jmethodID, ...);
    void CallVoidMethod(JNIEnv*, jobject, jmethodID, ...);
复制代码
    jobject CallStaticObjectMethod(JNIEnv*, jobject, jmethodID, ...);
    jboolean CallStaticBooleanMethod(JNIEnv*, jobject, jmethodID, ...);
    jbyte CallStaticByteMethod(JNIEnv*, jobject, jmethodID, ...);
    jchar CallStaticCharMethod(JNIEnv*, jobject, jmethodID, ...);
    jshort CallStaticShortMethod(JNIEnv*, jobject, jmethodID, ...);
    jint CallStaticIntMethod(JNIEnv*, jobject, jmethodID, ...);
    jlong CallStaticLongMethod(JNIEnv*, jobject, jmethodID, ...);
    jfloat CallStaticFloatMethod(JNIEnv*, jobject, jmethodID, ...);
    jdouble CallStaticDoubleMethod(JNIEnv*, jobject, jmethodID, ...);
    void CallStaticVoidMethod(JNIEnv*, jobject, jmethodID, ...);
复制代码

存取Java类的域变量

在得到了成员变量的ID后,对于变量的读和写,JNIEnv分别定义了对应的函数:

   jobject GetObjectField(jobject obj, jfieldID fieldID){}
    jboolean GetBooleanField(jobject obj, jfieldID fieldID){}
    jint GetIntField(jobject obj, jfieldID fieldID){}
    //......
复制代码
    void SetObjectField(jobject obj, jfieldID fieldID, jobject value){}
    void SetBooleanField(jobject obj, jfieldID fieldID, jboolean value){}
    void SetIntField(jobject obj, jfieldID fieldID, jint value){}
    //......
复制代码
    jobject GetStaticObjectField(jobject obj, jfieldID fieldID){}
    jboolean GetStaticBooleanField(jobject obj, jfieldID fieldID){}
    jint GetStaticIntField(jobject obj, jfieldID fieldID){}
    //......
复制代码
  void SetStaticObjectField(jobject obj, jfieldID fieldID, jobject value){}
    void SetStaticBooleanField(jobject obj, jfieldID fieldID, jboolean value){}
    void SetStaticIntField(jobject obj, jfieldID fieldID, jint value){}
    //......
复制代码

JNI 环境

结构体 JNIEnv

JNIEnv 是代表JNI环境的结构体,定义如下:

struct _JNIEnv;
struct _JavaVM;
typedef const struct JNINativeInterface* C_JNIEnv;

#if defined(__cplusplus)
typedef _JNIEnv JNIEnv;
typedef _JavaVM JavaVM;
#else
typedef const struct JNINativeInterface* JNIEnv;
typedef const struct JNIInvokeInterface* JavaVM;
#endif
复制代码

从代码来看,JNI的定义还区分了C和C++

因为Android中定义了__cplusplus,所以,这里只需要关注C++部分的代码。

在C++部分,JNIEnv相当于_JNIEnv,我们看下_JNIEnv定义:

struct _JNIEnv {
    /* do not rename this; it does not seem to be entirely opaque */
    const struct JNINativeInterface* functions;

#if defined(__cplusplus)

    jint GetVersion()
    { return functions->GetVersion(this); }
    jclass DefineClass(const char *name, jobject loader, const jbyte* buf,jsize bufLen)
    { return functions->DefineClass(this, name, loader, buf, bufLen); }
    jclass FindClass(const char* name)
    { return functions->FindClass(this, name); }
    //......

#endif /*__cplusplus*/
复制代码

结构体中的函数有调用了成员变量functions的函数,functions是指向结构体JNINativeInterface的指针,JNINativeInterface的定义如下:

struct JNINativeInterface {
    void*       reserved0;
    void*       reserved1;
    void*       reserved2;
    void*       reserved3;
    jint        (*GetVersion)(JNIEnv *);
    jclass      (*DefineClass)(JNIEnv*, const char*, jobject, const jbyte*, jsize);
    jclass      (*FindClass)(JNIEnv*, const char*);
    //......
}
复制代码

JNINativeInterface 中定义的都是函数指针,这些函数指针在哪里实现的呢?

我们看下jni_internal.cc的代码片段:

class JNI {
 public:
  static jint GetVersion(JNIEnv*) {
    return JNI_VERSION_1_6;
  }
  static jclass DefineClass(JNIEnv*, const char*, jobject, const jbyte*, jsize) {
    LOG(WARNING) << "JNI DefineClass is not supported";
    return nullptr;
  }
  static jclass FindClass(JNIEnv* env, const char* name) {
    //......省略实现
  }
  //......省略JNINativeInterface中其他方法
}
复制代码
const JNINativeInterface gJniNativeInterface = {
  nullptr,  // reserved0.
  nullptr,  // reserved1.
  nullptr,  // reserved2.
  nullptr,  // reserved3.
  JNI::GetVersion,
  JNI::DefineClass,
  JNI::FindClass,
  //......省略其他参数
 }
复制代码

这样,JNINativeInterface的函数实现我们就找到了,在类JNI中。

JNIEnv 的创建和初始化

JNIEnv是JNI的使用环境。JNIEnv对象是和线程绑定在一起的,那我们考虑几个问题:

熟悉 JavaVM 的结构

在前面已经了解了JNI_OnLoad函数

既然这样,我们先看下_JavaVM的结构:

struct _JavaVM {
    const struct JNIInvokeInterface* functions;

#if defined(__cplusplus)
    jint DestroyJavaVM()
    { return functions->DestroyJavaVM(this); }
    jint AttachCurrentThread(JNIEnv** p_env, void* thr_args)
    { return functions->AttachCurrentThread(this, p_env, thr_args); }
    jint DetachCurrentThread()
    { return functions->DetachCurrentThread(this); }
    jint GetEnv(void** env, jint version)
    { return functions->GetEnv(this, env, version); }
    jint AttachCurrentThreadAsDaemon(JNIEnv** p_env, void* thr_args)
    { return functions->AttachCurrentThreadAsDaemon(this, p_env, thr_args); }
#endif /*__cplusplus*/
};
struct JNIInvokeInterface {
    void*       reserved0;
    void*       reserved1;
    void*       reserved2;

    jint        (*DestroyJavaVM)(JavaVM*);
    jint        (*AttachCurrentThread)(JavaVM*, JNIEnv**, void*);
    jint        (*DetachCurrentThread)(JavaVM*);
    jint        (*GetEnv)(JavaVM*, void**, jint);
    jint        (*AttachCurrentThreadAsDaemon)(JavaVM*, JNIEnv**, void*);
};
复制代码

这部分就和_JNIEnv的函数实现是一样的了。

同样的,通过查找在art/runtime/java_vm_ext.cc中找到了函数实现,如下:

//初始化 JNIInvokeInterface 部分
const JNIInvokeInterface gJniInvokeInterface = {
  nullptr,  // reserved0
  nullptr,  // reserved1
  nullptr,  // reserved2
  JII::DestroyJavaVM,
  JII::AttachCurrentThread,
  JII::DetachCurrentThread,
  JII::GetEnv,
  JII::AttachCurrentThreadAsDaemon
};
// 函数实现部分
class JII {
 public:
  static jint DestroyJavaVM(JavaVM* vm) {
    //......省略实现
  }
  static jint AttachCurrentThread(JavaVM* vm, JNIEnv** p_env, void* thr_args) {
    //......省略实现
  }
  static jint AttachCurrentThreadAsDaemon(JavaVM* vm, JNIEnv** p_env, void* thr_args) {
    //......省略实现
  }
  static jint DetachCurrentThread(JavaVM* vm) {
    //......省略实现
  }
  static jint GetEnv(JavaVM* vm, void** env, jint version) {
    //......省略实现
  }
};
复制代码

主线程下的初始化--ART的启动函数

这里并不会深入讲解,只是为了串联起JNI的一些相关知识。

Android 应用都是从Zygote进程fork而来的,后面会详细讲解Zygote进程。在这里我们需要了解的是

下面是简单的分析过程,这是主线程哟:

1 . ART的启动函数是在frameworks/base/core/jni/AndroidRuntime.cpp中,我们简单看下:

void AndroidRuntime::start(const char* className, const Vector<String8>& options, bool zygote)
{
    //...... 省略部分内容
    JNIEnv* env;
    if (startVm(&mJavaVM, &env, zygote) != 0) {
        return;
    }
    //...... 省略部分内容
}
复制代码

2 . 调用到了startVm函数,我们看下具体实现:

int AndroidRuntime::startVm(JavaVM** pJavaVM, JNIEnv** pEnv, bool zygote)
{
    // 大约有500多行的参数配置代码
    // 以为走错片场了。。。
    if (JNI_CreateJavaVM(pJavaVM, pEnv, &initArgs) < 0) {
        ALOGE("JNI_CreateJavaVM failed\n");
        return -1;
    }
    return 0;
}
复制代码

3 . 又调用到了JNI_CreateJavaVM,来看看:

extern "C" jint JNI_CreateJavaVM(JavaVM** p_vm, JNIEnv** p_env, void* vm_args) {
  //...... 省略部分代码
  Runtime* runtime = Runtime::Current();
  bool started = runtime->Start();
  if (!started) {
    delete Thread::Current()->GetJniEnv();
    delete runtime->GetJavaVM();
    LOG(WARNING) << "CreateJavaVM failed";
    return JNI_ERR;
  }

  //请看这里,赋值了有木有,算是找到根儿了
  //JNIEnv 对象是在 Thread 类中实例化的
  *p_env = Thread::Current()->GetJniEnv();
  // JavaVM 对象是在 Runtime 中实例化的
  *p_vm = runtime->GetJavaVM();
  return JNI_OK;
}
复制代码

到这里,主线程就梳理的差不多了:

普通线程下的初始化

主线程是在虚拟机启动时,在Thread类中初始化了JNIEnv对象。那如果是Java中新创建的线程呢?

Thread_nativeCreate函数位于art/runtime/native/java_lang_Thread.cc,我们看看怎么实现的:

static void Thread_nativeCreate(JNIEnv* env, jclass, jobject java_thread, jlong stack_size,
                                jboolean daemon) {
  //...... 省略部分
  Thread::CreateNativeThread(env, java_thread, stack_size, daemon == JNI_TRUE);
}
复制代码

CreateNativeThread函数中将使用Linux的线程函数来创建一个新线程。代码如下:

void Thread::CreateNativeThread(JNIEnv* env, jobject java_peer, size_t stack_size, bool is_daemon) {
    //...... 省略部分
    pthread_create_result = pthread_create(&new_pthread,
                                           &attr,
                                           Thread::CreateCallback,
                                           child_thread);
    //...... 省略部分
}
复制代码

这个新线程的运行函数是Thread::CreateCallback,我们再来看下它的实现:

void* Thread::CreateCallback(void* arg) {
  Thread* self = reinterpret_cast<Thread*>(arg);
  Runtime* runtime = Runtime::Current();
  //......
  {
    //......
    CHECK(self->Init(runtime->GetThreadList(), runtime->GetJavaVM(), self->tlsPtr_.tmp_jni_env));
    self->tlsPtr_.tmp_jni_env = nullptr;
   }
   //......
}
复制代码

Thread::CreateCallback调用了ThreadInit函数

bool Thread::Init(ThreadList* thread_list, JavaVMExt* java_vm, JNIEnvExt* jni_env_ext) {
    //......
    tlsPtr_.jni_env = JNIEnvExt::Create(this, java_vm, &error_msg);
    thread_list->Register(this);
    //......
}
复制代码

这里会新创建一个JNIEnv对象。

JNIEnv 对象的初始化总结

对于JNIEnv对象的初始化就两点:

JNI 中的异常处理

在 JNI 中检查Java层产生的异常

首先要明确的是,Android的C++层不支持try-catch机制

为此,JNI中提供了一组函数来检查Java方法是否抛出了异常,方法原型如下:

    // 检查是否有异常发生
    jthrowable ExceptionOccurred();
    // 打印输出异常信息
    void ExceptionDescribe();
    // 清除异常
    void ExceptionClear();
复制代码

在 JNI 中抛出异常

如果要在JNI中抛出异常,JNIEnv也提供了两个函数,如下所示:

    jint Throw(jthrowable obj);
    jint ThrowNew(jclass clazz, const char* message);
复制代码

在JNIHelp中也定义了几个函数来方便抛出一些常见的异常,具体包括:

// 抛出 java/lang/NullPointerException 空指针异常
inline int jniThrowNullPointerException(JNIEnv* env, const char* msg);
// 抛出 java/lang/RuntimeException 运行时异常
inline int jniThrowRuntimeException(JNIEnv* env, const char* msg);
// 抛出 java/lang/IOException IO异常
inline int jniThrowIOException(JNIEnv* env, int errnum);
复制代码

JNI 中的引用

在JNI中有三种引用:本地引用(LocalReference)、全局引用(GlobalReference)、弱全局引用(WeakGlobalReference)

JNI位于C/C++和Java之间,虽然JNI函数的代码使用C/C++语言编写,但是通过JNI创建的Java对象和在Java世界里创建的一样,都会被虚拟机进行垃圾回收

本地引用(LocalReference)

在JNI本地函数中生成的Java对象,它们的生命周期应该在函数退出时结束。

虚拟机如何保证呢?

我们也可以显式操作:

jobject NewLocalRef(jobject ref);
void DeleteLocalRef(jobject localRef);
复制代码

全局引用(GlobalReference)

全局引用(GlobalReference)的对象需要显式的创建、删除。虚拟机不会回收。

JNIEnv提供了两个函数:

jobject (jobject obj);
void DeleteGlobalRef(jobject globalRef);
复制代码

弱全局引用(WeakGlobalReference)

弱全局引用 (WeakGlobalReference) 引用下的对象如果没有其他的引用类型时,下次垃圾回收时会被回收掉。

相关的操作函数是:

    jweak NewWeakGlobalRef(jobject obj);
    void DeleteWeakGlobalRef(jweak obj);
复制代码

启动 CheckJNI

应用程序内部如果JNI部分发生了错误,通常情况下不会打印太多的log。

因此,Android定义了一个名为debug.checkjni的属性:

设置方式:

setprop debug.checkjni 1
复制代码

总结

本篇只是对JNI使用上的技巧进行了比较简单的总结。由于主动使用的频率不怎么高,权当一些补充知识啦。

本人在想,如果深究JNI原理上的事情可能就会涉及:

等等知识吧。

哈哈哈,JNI先了解到这里了,终于知道JNI中的env是咋来的了!

Copyright© 2013-2020

All Rights Reserved 京ICP备2023019179号-8