阅读 347

Android架构师之路:JNI与NDK编程常用方法史上最全总结和详解

前沿小计

1、前面把JNI与NDK编程基础知识点总结过了,如果不懂的可以再详细看下;

2、今天讲解下jni编程中常用的方法总结和详解-中文的:类操作方法、字符串、数组、方法等等;

3、jni编程一定要会的,不懂的就问;

此文章已经在公众号【Android开发编程】上发表

一、JNI中重要的JavaVM 和 JNIEnv详解

Dingtalk_20210722141216.jpg

JNI 定义了两个关键数据结构,即JavaVM和JNIEnv。两者本质上都是指向函数表的二级指针。在 C++ 版本中,它们是一些类,这些类具有指向函数表的指针,并具有每个通过该函数表间接调用的 JNI 函数的成员函数

1. JavaVM

JavaVM是虚拟机在JNI中的表示,一个JVM中只有一个JavaVM对象,这个对象是线程共享的。

通过JNIEnv我们可以获取一个Java虚拟机对象,其函数如下:

/**

* 获取Java虚拟机对象

* @param env JNIEnv对象

* @param vm 用来存放获得的虚拟机的指针的指针

* @return 成功返回0,失败返回其他

*/

jint GetJavaVM(JNIEnv *env, JavaVM **vm);

在加载动态链接库的时候,JVM会调用JNI_OnLoad(JavaVM* jvm, void* reserved)(如果定义了该函数),第一个参数会传入JavaVM指针。可以在该函数中保存JavaVM指针来供全局使用。

JavaVM *javaVM = NULL;

jint JNI_OnLoad(JavaVM *vm, void *reserved) {

javaVM = vm;

...

}

2. JNIEnv

JNIEnv类型是一个指向全部JNI方法的指针,JNIEnv 提供了大部分 JNI 函数。JNIEnv只在创建它的线程有效,不能跨线程传递,不能再线程之间共享 JNIEnv。

所有的本地接口函数都会以 JNIEnv 作为第一个参数。不管是静态注册的本地C/C++函数接口,还是动态注册的本地函数接口,函数的第一个参数都是JNIEnv。

静态注册的函数实例

JNIEXPORT jstring JNICALL Java_cc_ccbu_jnitest_Test

(JNIEnv *, jobject) {

return env->NewStringUTF("test");

}

动态注册的函数实例

jstring testtest(JNIEnv* env, jobject thiz) {

return env->NewStringUTF("test");

}

static JNINativeMethod gMethods[] = {

{"testtest", "()Ljava/lang/String;", (void*)testtest}

};

int registerMethod(JNIEnv *env) {

jclass test = env->FindClass("cc/ccbu/jnitest/Test");

return env->RegisterNatives(test, gMethods, sizeof(gMethods)/ sizeof(gMethods[0]));

}

如果一段代码无法通过其他方法获取自己的 JNIEnv,可以通过全局有效的 JavaVM,然后使用 GetEnv 来获取当前线程的 JNIEnv(如果该线程包含一个 JNIEnv)。

JNIEnv* env = NULL;

if (javaVM->GetEnv((void**) &env, JNI_VERSION_1_6) != JNI_OK) {

return JNI_ERR;

}

GetEnv函数定义如下:

/**

* 获取当前线程JNIEnv

* @param env 用来存放获取JNIEnv对象的指针的指针

* @param version JNI版本

* @return 成功返回0,失败返回其他

*/

jint GetEnv(void** env, jint version)

对于本地库中创建的线程,需要使用AttachCurrentThread来附加到 JavaVM来获取一个可用的JNIEnv。线程退出或不再需要使用JNIEnv时,必须通过调用DetachCurrentThread来解除连接。

JNIEnv *env = NULL;

JavaVM *vm = cachedVM;

bool bAttached = AttachCurrentThread(vm, &env);

if(bAttached) {

vm->DetachCurrentThread();

}

bool AttachCurrentThread(JavaVM* vm, JNIEnv** p_env)

{

bool bAttached = false;

switch(vm->GetEnv((void**)p_env, JNI_VERSION_1_4))

{

case JNI_OK:

break;

case JNI_EDETACHED:

if (vm->AttachCurrentThread(p_env, 0) < 0)

{

LOGD("%s :Attached failed!",__func__);

return false;

}

else

{

bAttached = true;

}

break;

case JNI_EVERSION:

LOGE("Invalid java version");

break;

}

return bAttached;

}

二、jni的接口函数表

5713484-489382d33286e74e.png

每个函数都可以通过JNIEnv参数访问,JNIEnv类型是指向一个存放所有JNI接口指针的指针,其定义如下:

typedef const struct JNINativeInterface *JNIEnv;

虚拟机初始化函数表,如下面代码所示,前三个条目是为了将来和COM兼容而保留的。另外,我们在函数表的开头附近保留了一些额外的NULL条目,例如,可以在FindClass之后添加未来与类相关的JNI操作,而不是在表的末尾。请注意,函数表可以在所有JNI接口指针之间共享。

首先我们来看下JNINativeInterface

const struct JNINativeInterface ... = {

GetVersion,

DefineClass,

FindClass,

FromReflectedMethod,

FromReflectedField,

ToReflectedMethod,

GetSuperclass,

IsAssignableFrom,

ToReflectedField,

Throw,

ThrowNew,

ExceptionOccurred,

ExceptionDescribe,

ExceptionClear,

FatalError,

PushLocalFrame,

PopLocalFrame,

NewGlobalRef,

DeleteGlobalRef,

DeleteLocalRef,

IsSameObject,

NewLocalRef,

EnsureLocalCapacity,

AllocObject,

NewObject,

NewObjectV,

NewObjectA,

GetObjectClass,

IsInstanceOf,

...

...

...

...

};

三、获取JNI版本信息

在JNIEnv指针中,有个函数用于获取JNI的版本:

jint GetVersion(JNIEnv *env);

该方法主要返回本地JNI方法接口的版本信息。在不同的JDK环境下返回值是不同的,具体如下:

在JDK/JRE 1.1中,返回0x00010001

在JDK/JRE 1.2中,返回0x00010002

在JDK/JRE 1.3中,返回0x00010004

在JDK/JRE 1.4中,返回0x00010006

上面这些数字可不是我乱拍的,其实是早就被定义为一个宏了,如下:

#define JNI_VERSION_1_1 0x00010001

#define JNI_VERSION_1_2 0x00010002

/* Error codes */

#define JNI_EDETACHED (-2) /* thread detached from the VM */

#define JNI_EVERSION (-3) /* JNI version error

SINCE JDK/JRE 1.4:

#define JNI_VERSION_1_4 0x00010004

SINCE JDK/JRE 1.6:

#define JNI_VERSION_1_6 0x00010006

四、Java 类 操作

(一)、定义类(加载类)

jclass DefineClass(JNIEnv *env,const char* name,jobject loader,const jbyte *buf, jsize bufLen)

这个函数,主要是从包含数据的buffer中加载类,该buffer包含类调用时未被虚拟机所引用的原始类数据。

入参解释:

env:JNI接口指针

name:所定义的类名或者接口名,该字符串有modefied UTF-8编码

loader:指派给定义的类加载器

buf:包含.class文件数据的buffer

bufLen:buffer长度

返回:Java类对象,当错误出现时返回NULL

可能抛出的异常:

如果没有指定这个Java类的,则会抛出ClassFormatError

如果是一个类/接口是它自己的一个父类/父接口,则会抛出ClassCircularityError

如果内存不足,则会抛出OutOfMemoryError

如果想尝试在Java包中定义一个类,则会抛出SecurityException

(二)、查找类

jclass FindClass(JNIEnv *env,const char *name);

这里面有两种情况一个是JDK release1.1,另外一种是JDK release 1.2

。从JDK release 1.1,该函数加载一个本地定义类,它搜索CLASSPATH环境变量里的目录及zip文件查找特定名字的类。自从Java 2 release 1.2,Java安全模型允许非系统类加载跟调用本地方法。FindClass定义与当前本地方法关联的类加载,也就是声明本地方法的类的类加载类。如果本地方法属于系统类,则不会涉及类加载器;否则,将调用适当的类加载来加载和链接指定的类。从Java 2 SDK1.2版本开始,通过调用接口调用FindClass时,没有当前的本机方法或关联的的类加载器。在这种情况下,在这种情况下,使用ClassLoader.getSystemClassLoader的结果。这是虚拟机为应用程序创建的类加载器,并且能够找到java.class.path属性列出的类。

入参解释:

env:JNI接口指针

name:一个完全限定的类名,即包含“包名”+“/”+类名。举个例子:如java.lang.String,该参数为java/lang/String;如果类名以[开头,将返回一个数组类。比如数组类的签名为java.lang.Object[],该参数应该为"[Ljava/lang/Object"

返回:

返回对应完全限定类对象,当找不到类时,返回NULL

可能抛出的异常:

如果没有指定这个Java类的,则会抛出ClassFormatError

如果是一个类/接口是它自己的一个父类/父接口,则会抛出ClassCircularityError

如果没有找到该类/接口的定义,则抛出NoClassDefFoundError

如果内存不足,则会抛出OutOfMemoryError

(三)、查找父类

jclass GetSuperclass(JNIEnv *env,jclass clazz);

如果clazz不是Object类,则此函数将返回表示该clazz的父类的Class对象,如果该类是Object,或者clazz代表接口,则此函数返回NULL。

入参解释:

env:JNI接口指针

clazz:Java的Class类

返回:

如果clazz有父类则返回其父类,如果没有其父类则返回NULL

(四)、安全转换

jboolean IsAssignableFrom(JNIEnv *env,jclass clazz1,jclass clazz2);

判断clazz1的对象是否可以安全地转化为clazz2的对象

入参解释:

env:JNI接口指针

clazz1:Java的Class类,即需要被转化的类

clazz2:Java的Class类,即需要转化为目标的类

返回:

如果满足以下任一条件,则返回JNI_TRUE:

如果clazz1和clazz2是同一个Java类。

如果clazz1是clazz2的子类

如果clazz1是clazz2接口的实现类

四、异常 操作

(一)、抛出异常

jint Throw(JNIEnv *env,jthrowable obj);

传入一个jthrowable对象,并且在JNI并将其抛起

入参解释:

env:JNI接口指针

jthrowable:一个Java的java.lang.Throwable对象

返回:

成功返回0,失败返回一个负数。

可能抛出的异常:

抛出一个java.lang.Throwable 对象

(二)、构造一个新的异常并抛出

jint ThrowNew(JNIEnv *env,jclass clazz,const char* message);

传入一个message,并用其构造一个异常并且抛出。

入参解释:

env:JNI接口指针

jthrowable:一个Java的java.lang.Throwable对象

message:用于构造一个java.lang.Throwable对象的消息,该字符串用modified UTF-8编码

返回:

如果成功返回0,失败返回一个负数

可能抛出的异常:

抛出一个新构造的java.lang.Throwable 对象

(三)、检查是否发生异常,并抛出异常

jthrowable ExceptionOccurred(JNIEnv *env);

检测是否发生了异常,如果发生了,则返回该异常的引用(再调用ExceptionClear()函数前,或者Java处理异常前),如果没有发生异常,则返回NULL。

入参解释:

env:JNI接口指针

返回:

jthrowable的异常引用或者NULL

(四)、打印异常的堆栈信息

void ExceptionDescribe(JNIEnv *env)

打印这个异常的堆栈信息

入参解释:

env:JNI接口指针

(五)、清除异常的堆栈信息

void ExceptionClear(JNIEnv *env);

清除正在抛出的异常,如果当前没有异常被抛出,这个函数不起作用

入参解释:

env:JNI接口指针

五、全局引用和局部引用

(一)、创建全局引用

jobject NewGlobalRef(JNIEnv *env,object obj);

给对象obj创建一个全局引用,obj可以是全局或局部引用。全局引用必须通过DeleteGlobalRef()显示处理。

参数解释:

env:JNI接口指针

obj:object对象

返回:

全局引用jobject,如果内存溢出则返回NULL

(二)、删除全局引用

void DeleteGlobalRef(JNIEnv *env,jobject globalRef);

删除全局引用

参数解释:

env:JNI接口指针

globalRef:需要被删除的全局引用

(三)、删除局部引用

局部引用只在本地接口调用时的生命周期内有效,当本地方法返回时,它们会被自动释放。每个局部引用都会消耗一定的虚拟机资源,虽然局部引用可以被自动销毁,但是程序员也需要注意不要在本地方法中过度分配局部引用,过度分配局部引用会导致虚拟机在执行本地方法时内存溢出。

void DeleteLocalRef(JNIEnv *env, jobject localRef);

通过localRef删除局部引用

参数解释

env:JNI接口指针

localRef:需要被删除的局部引用

JDK/JRE 1.1提供了上面的DeleteLocalRef函数,这样程序员就可以手动删除本地引用。

从JDK/JRE 1.2开始,提供可一组生命周期管理的函数,他们是下面四个函数。

(四)、设定局部变量的容量

jint EnsureLocalCapacity(JNIEnv *env,jint capacity);

在当前线程中,通过传入一个容量capacity,,限制局部引用创建的数量。成功则返回0,否则返回一个负数,并抛出一个OutOfMemoryError。VM会自动确保至少可以创建16个局部引用。

参数解释

env:JNI接口指针

capacity:容量

返回:

成功返回0,失败返回一个负数,并会抛出一个OutOfMemoryError

为了向后兼容,如果虚拟机创建了超出容量的局部引用。VM调用FatalError,来保证不能创建更多的本地引用。(如果是debug模式,虚拟机回想用户发出warning,并提示创建了更多的局部引用,在JDK中,程序员可以提供-verbose:jni命令行选项来打开这个消息)

(五)、释放一个局部引用

jobject PopLocalFrame(JNIEnv *env,jobject result)

弹出当前的局部引用帧,并且释放所有的局部引用。返回在之前局部引用帧与给定result对象对应的局部引用。如果不需要返回任何引用,则设置result为NULL

参数解释

env:JNI接口指针

result:需要释放的局部引用

(六)、创建一个局部引用

jobject NewLocalRef(JNIEnv *env,jobject ref);

创建一个引用自ref的局部引用。ref可以是全局或者局部引用,如果ref为NULL,则返回NULL。

参数解释

env:JNI接口指针

ref:可以试试局部引用也可以是全局引用。

(七)、弱全局引用

弱全局引用是一种特殊的全局引用,不像一般的全局引用,一个弱全局引用允许底层Java对象能够被垃圾回收。弱全局引用能够应用在任何全局或局部引用被使用的地方。当垃圾回收器运行的时候,如果对象只被弱引用所引用时,它将释放底层变量。一个弱阮菊引用指向一个被释放的对象相当于等于NULL。编程人员可以通过使用isSampleObject对比弱引用和NULL来检测一个弱全局应用是否指向一个被释放的对象。弱全局引用在JNI中是Java弱引用的一个简化版本,在Java平台API中有有效。

当Native方法正在运行的时候,垃圾回收器可能正在工作,被弱引用所指向的对象可能在任何时候被释放。弱全局引用能够应用在任何全局引用所使用的地方,通常是不太适合那么做的,因为它们可能在不注意的时候编程NULL。

当IsSampleObject能够识别一个弱全局引用是不是指向一个被释放的对象,但是这不妨碍这个对象在被检测之后马上被释放。这就说明了,程序员不能依赖这个方法来识别一个弱全局引用是否能够在后续的JNI函数调用中被使用。

如果想解决上述的问题,建议使用JNI函数NewLocalRef或者NewGlobalRef来用标准的全局也引用或者局部引用来指向相同的对象。如果这个独享已经被释放了这些函数会返回NULL。否则会返回一个强引用(这样就可以保证这个对象不会被释放)。当不需要访问这个对象时,新的引用必须显式被删除。

1、创建全局弱引用

jweak NewWeakGlobalRef(JNIEnv *env,jobject obj);

创建一个新的弱全局引用。如果obj指向NULL,则返回NULL。如果VM内存溢出,将会抛出异常OutOfMemoryError。

参数解释

env:JNI接口指针

obj:引用对象

返回:

全局弱引用

2、删除全局弱引用

void DeleteWeakGlobalRef(JNIEnv *env,jweak obj);

VM根据所给定的弱全局引用删除对应的资源。

参数解释

env:JNI接口指针

obj:将删除的弱全局引用

六、对象操作

(一)、直接创建一个Java对象

jobject AllocObject(JNIEnv *env,jclass clazz);

不借助任何构造函数的情况下分配一个新的Java对象,返回对象的一个引用。

参数解释:

env:JNI接口指针

clazz::Java类对象

返回:

返回一个Java对象,如果该对象无法被创建,则返回NULL。

异常:

如果该类是接口或者是抽象类,则抛出InstantiationException

如果是内存溢出,则抛出OutOfMemoryError

(二)、根据某个构造函数来创建Java对象

jobject NewObject(JNIEnv *env,jclass clazz,jmethodID methodID,...);

jobject NewObjectA(JNIEnv *env,jclass clazz,jmethodID methodID,const jvalue *args);

jobject NewObjectV(JNIEnv *env,jclass clazz,jmethodID methodID,va_list args);

构造一个新的Java对象,methodID表明需要调用一个构造函数。这个ID必须通过调用GetMethodID()获得,GetMethodID()为函数名,void(V)为返回值。clazz参数不能纸箱一个数组类

NewObject:需要把所有构造函数的入参,放在参数methodID之后。NewObject()接受这些参数并将它们传递给需要被调用的Java的构造函数

NewObjectA:在methodID后面,放了一个类型为jvalue的参数数组——args,该数组存放着所有需要传递给构造函数的参数。NewObjectA()接收到这个数组中的所有参数,并且按照顺序将它们传递给需要调用的Java方法。

NewObjectV:在methodID后面,放了一个类型为va_list的args,参数存放着所有需要传递给构造函数的参数。NewObjectv()接收到所有的参数,并且按照顺序将它们传递给需要调用的Java方法。

参数解释:

env:JNI接口指针

clazz::Java类

methodID:构造函数的方法ID

附加参数:

NewObject的附加参数:arguments是构造函数的参数

NewObjectA的附加参数:args是构造函数的参数数组

NewObjectV的附加参数:args是构造函数的参数list

返回:

Java对象,如果无法创建该对象,则返回NULL

异常:

如果传入的类是接口或者抽象类,则抛出InstantiationException

如果内存溢出,则抛出OutOfMemoryError

所有的异常都是通过构造函数抛出

(三)、获取某个对象的“类”

jclass GetObjectClass(JNIEnv *env,object obj);

返回obj对应的类

参数解释

env:JNI接口指针

obj:Java对象,不能为NULL

参数:

env:JNI接口指针

obj:JAVA对象,不能为NULL

返回:

返回一个Java“类”对象

(四)、获取某个对象的“类型”

jobjectRefType GetObjectRefType(JNIEnv *env,jobject obj);

返回obj参数所以指向对象的类型,参数obj可以是局部变量,全局变量或者若全局引用。

参数解释

env:JNI接口指针

obj:局部、全局或弱全局引用

返回:

JNIInvalidRefType=0:代表obj参数不是有效的引用类型

JNILocalRefType=1:代表obj参数是局部变量类型

JNIGlobalRefType=2:代表obj参数是全局变量类型

JNIWeakGlobalRefType=3:代表obj参数是弱全局有效引用

无效的引用就是没有引用的引用。也就是说,obj的指针没有指向内存中创建函数时候的地址,或者已经从JNI函数中返回了。所以说NULL就是无效的引用。并且GetObjectRefType(env,NULL)将返回类型是JNIInvalidRefType。但是空引用返回的不是JNIInvalidRefType,而是它被创建时候的引用类型。

PS:不能在引用在删除的时候,调用该函数

(五)、判断某个对象是否是某个“类”的子类

jboolean IsInstanceOf(JNIEnv *env, jobject obj,jclass clazz);

测试obj是否是clazz的一个实例

参数:

env:JNI接口指针

obj:一个Java对象

clazz:一个Java的类

返回:

如果obj是clazz的实例,则返回JNI_TRUE;否则则返回JNI_FALSE;一个空对象可以是任何类的实例。

(六)、判断两个引用是否指向同一个引用

jboolean IsSampleObject(JNIEnv *env,jobject ref1,jobject ref2);

判断两个引用是否指向同一个对象

参数解释:

env:JNI接口指针

ref1:Java对象

ref2:Java对象

返回:

如果同一个类对象,返回JNI_TRUE;否则,返回JNI_FALSE;

(七)、返回属性id

jfieldID GetFieldID(JNIEnv *env,jclass clazz,const char *name,const char *sig);

获取某个类的非静态属性id。通过方法属性名以及·属性的签名(也就是属性的类型),来确定对应的是哪个属性。通过检索这个属性ID,我们就可以调用Get Field和Set Field了,就是我们常用的get和set`方法

参数解释:

env:JNI接口指针

clazz:一个Java类对象

name:以"0"结尾的,而且字符类型是"utf-8"的属性名称

sig:以"0"结尾的,而且字符类型是"utf-8"的属性签名

返回

属性对应ID,如果操作失败,则返回NULL

异常:

如果找不到指定的属性,则抛出NoSuchFieldError

如果类初始化失败,则抛出ExceptionInitializerError

如果内存不足了,则抛出OutOfMemoryError

PS:GetFieldID()可能会导致还未初始化的类开始初始化,同时在获取数组的长度不能使用GetFieldID(),而应该使用GetArrayLength()。

(八)、返回属性id系列

NativeType GetField(JNIEnv *env,jobject obj,jfieldID fielD);

返回某个类的非静态属性的值,这是一组函数的简称,具体如下:

jobject GetObjectField(JNIEnv *env,jobject obj,jfieldID fielD)

jboolean GetBooleanField(JNIEnv *env,jobject obj,jfieldID fielD)

jbyte GetByteField(JNIEnv *env,jobject obj,jfieldID fielD)

jchar GetCharField(JNIEnv *env,jobject obj,jfieldID fielD)

jshort GetShortField(JNIEnv *env,jobject obj,jfieldID fielD)

jint GetIntField(JNIEnv *env,jobject obj,jfieldID fielD)

jlong GetLongField(JNIEnv *env,jobject obj,jfieldID fielD)

jfloat GetFloatField(JNIEnv *env,jobject obj,jfieldID fielD)

jdouble GetDoubleField(JNIEnv *env,jobject obj,jfieldID fielD)

参数解释:

env:JNI接口指针

obj:Java对象,不能为空

fieldID:有效的fieldID

返回:

对应属性的值

(九)、设置属性id系列

void SetField(JNIEnv *env,jobject obj,jfieldID fieldID,NativeType value)

设置某个类的的非静态属性的值。其中具体哪个属性通过GetFieldID()来确定哪个属性。这是一组函数的简称,具体如下:

void SetObjectField(jobject)

void SetBooleanField(jboolean)

void SetByteField(jbyte)

void SetCharField(jchar)

void SetShortField(jshort)

void SetIntField(jint)

void SetLongField(jlong)

void SetFloatField(jfloat)

void SetDoubleField(jdouble)

参数解释:

env:JNI接口指针

obj:Java对象,不能为空

fieldID:有效的属性ID

value:属性的新值

(十)、获取某个类的某个方法id

jmethodID GetMethodID(JNIEnv *env,jclass clazz,const char*name,const char* sig);

返回某个类或者接口的方法ID,该方法可以是被定义在clazz的父类中,然后被clazz继承。我们是根据方法的名字以及签名来确定一个方法的。

PS:GetMethodID()会造成还未初始化的类,进行初始化

如果想获取构造函数的ID,请提供init作为方法名称,并将void(V)作为返回类型

参数解释:

env:JNI接口指针

clazz:Java类对象

name:以0结尾的,并且是"utf-8"的字符串的方法名称

sig:以0结尾的,并且是"utf-8"的字符串的方法签名

返回:

返回一个方法ID,没有找到指定的方法,则返回NULL

异常:

如果找不到指定的方法,则抛出NoSuchMethodError

如果累初始化失败,则抛出ExceptionInInitializerError

如果内存不够,则抛出OutOfMemoryError

(十一)、调用Java实例的某个非静态方法“系列”

NativeType CallMethod(JNIEnv *env,jobject obj,jmethodID methodID,...);

NativeType CallMethodA(JNIEnv *env,jobjct obj,jmethodID methodID ,const jvalue *args);

NativeType CallMethodV(JNEnv *env,jobject obj,jmethodID methodID,va_list args);

这一些列都是在native中调用Java对象的某个非静态方法,它们的不同点在于传参不同。是根据方法ID来指定对应的Java对象的某个方法。methodID参数需要调用GetMethodID()获取。

PS:当需要调用某个"private"函数或者构造函数时,这个methodID必须是obj类的方法,不能是它的父类的方法。

下面我们来看下他们的不同点

CallMethod:需要把方法的入参放在参数methodID后面。CallMethod()其实把这些参数传递给需要调用的Java方法。

CallMethodA:在methodID后面,有一个类型为jvalue的args数组,该数组存放所有需要传递给构造函数的参数。CallMethodA()收到这个数组中的参数,是按照顺序将他们传递给对应的Java方法

CallMethodV:在methodID后面,有一个类型Wieva_list的参数args,它存放着所有需要传递给构造函数的参数。CallMethodV()接收所有的参数,并且按照顺序将它们传递给需要调用的Java方法。

CallMethod Routine Name Native Type

CallVoidMethod()

CallVoidMethodA() void

CallVoidMethodV()

CallObjectMethod()

CallObjectMethodA() jobject

CallObjectMethodV()

CallBooleanMethod()

CallBooleanMethodA() jboolean

CallBooleanMethodV()

CallByteMethod()

CallByteMethodA() jbyte

CallByteMethodV()

CallCharMethod()

CallCharMethodA() jchar

CallCharMethodV()

CallShortMethod()

CallShortMethodA() jshort

CallShortMethodV()

CallIntMethod()

CallIntMethodA() jint

CallIntMethodV()

CallLongMethod()

CallLongMethodA()

CallLongMethodV()

CallFloatMethod()

CallFloatMethodA() jlong

CallFloatMethodV()

CallDoubleMethod()

CallDoubleMethodA() jfloat

CallDoubleMethodV()

参数解释:

env:JNI接口指针

obj:对应的Java对象

methodID:某个方法的方法id

返回:

返回调用Java方法对应的结果

异常:

在Java方法执行过程中产生的异常。

(十二)、调用某个类的非抽象方法

调用父类中的实例方法,如下系列

CallNonvirtualMethod

CallNonvirtualMethodA

CallNonvirtualMethodV

具体如下:

NativeType CallNonvirtualMethod(JNIEnv *env,jobject obj,jclass clazz,jmethodID methodID,....);

NativeType CallNonvirtualMethodA(JNIEnv *env,jobject obj,jclass clazz,jmethodID methodID,const jvalue *args);

NativeType CallNonvirtualMethodV(JNIEnv *env, jobject obj,

jclass clazz, jmethodID methodID, va_list args);

这一系列操作就是根据特定的类,和其方法ID来调用Java对象的实例的非静态方法,methodID参数需要调用GetMethodID()获取。

CallNonvirtualMethod和CallMethod是不同的,其中CallNonvirtualMethod是基于"类",而和CallMethod是基于类的对象。所以说CallNonvirtualMethod`的入参是 clazz,methodID必须来源与obi的类,而不是它的父类

下面我们来看下他们的不同点

CallNonvirtualMethod :需要把方法的入参放在参数methodID后面。CallNonvirtualMethod()其实把这些参数传递给需要调用的Java方法。

CallNonvirtualMethod:在methodID后面,有一个类型为jvalue的args数组,该数组存放所有需要传递给构造函数的参数。CallNonvirtualMethod()收到这个数组中的参数,是按照顺序将他们传递给对应的Java方法

CallNonvirtualMethodV :在methodID后面,有一个类型Wieva_list的参数args,它存放着所有需要传递给构造函数的参数。 CallNonvirtualMethodV()接收所有的参数,并且按照顺序将它们传递给需要调用的Java方法。

将上面这系列方法展开如下:

CallNonvirtualMethod Routine Name Native Type

CallNonvirtualVoidMethod()

CallNonvirtualVoidMethodA() void

CallNonvirtualVoidMethodV()

CallNonvirtualObjectMethod()

CallNonvirtualObjectMethodA() jobject

CallNonvirtualObjectMethodV()

CallNonvirtualBooleanMethod()

CallNonvirtualBooleanMethodA() jboolean

CallNonvirtualBooleanMethodV()

CallNonvirtualByteMethod()

CallNonvirtualByteMethodA() jbyte

CallNonvirtualByteMethodV()

CallNonvirtualCharMethod()

CallNonvirtualCharMethodA() jchar

CallNonvirtualCharMethodV()

CallNonvirtualShortMethod()

CallNonvirtualShortMethodA() jshort

CallNonvirtualShortMethodV()

CallNonvirtualIntMethod()

CallNonvirtualIntMethodA() jint

CallNonvirtualIntMethodV()

CallNonvirtualLongMethod()

CallNonvirtualLongMethodA() jlong

CallNonvirtualLongMethodV()

CallNonvirtualFloatMethod()

CallNonvirtualFloatMethodA() jfloat

CallNonvirtualFloatMethodV()

CallNonvirtualDoubleMethod()

CallNonvirtualDoubleMethodA() jdouble

CallNonvirtualDoubleMethodV()

参数解释:

env:JNI接口指针

obj:Java对象

clazz:Java类

methodID:方法ID

返回:

调用Java方法的结果

抛出异常:

在Java方法中执行过程可能产生的异常

(十三)、获取静态属性

jfieldID GetStaticFieldID(JNIEnv *env,jclass clazz,const char* name,const char *sig);

获取某个类的某个静态属性ID,根据属性名以及标签来确定是哪个属性。GetStaticField()和SetStaticField()通过使用属性ID来对属性进行操作的。如果这个类还没有初始化,直接调用GetStaticFieldID()会引起这个类进行初始化。

参数解释:

env:JNI接口指针

clazz:Java类

name:静态属性的属性名,是一个编码格式"utf-8"并且以0结尾的字符串。

sig:属性的签名,是一个编码格式"utf-8"并且以0结尾的字符串。

返回:

返回静态属性ID,如果指定的静态属性无法找则返回NULL

异常:

如果指定的静态属性无法找到则抛出NoSuchFieldError

如果类在初始化失败,则抛出ExceptionInInitializerError

如果内存不够,则抛出OutOfMemoryError

(十四)、获取静态属性系列

NativeType GetStaticField(JNIEnv *env,jclass clazz,jfieldID fieldID);

这个系列返回一个对象的静态属性的值。可以通过GetStaticFieldID()来获取静态属性的的ID,有了这个ID,我们就可以获取这个对其进行操作了

下面表明了函数名和函数的返回值,所以只需要替换GetStaticField中的类替换为该字段的Java类型或者表中的实际静态字段存取器。并将NativeType替换为相应的本地类型

GetStaticField Routine Name Native Type

GetStaticObjectField() jobject

GetStaticBooleanField() jboolean

GetStaticByteField() jbyte

GetStaticCharField() jchar

GetStaticShortField() jshort

GetStaticIntField() jint

GetStaticLongField() jlong

GetStaticFloatField() jfloat

GetStaticDoubleField() jdouble

参数解释:

env:JNI接口指针

clazz:Java类

field:静态属性ID

返回:

返回静态属性

(十五)、设置静态属性系列

void SetStaticField(JNIEnv *env,jclass clazz,jfieldID fieldID,NativeType value);

这个系列是设置类的静态属性的值。可以通过GetStaticFieldID()来获取静态属性的ID。

下面详细介绍了函数名和其值,你可以通过SetStatic并传入的NativeType来设置Java中的静态属性。

SetStaticField Routine Name NativeType

SetStaticObjectField() jobject

SetStaticBooleanField() jboolean

SetStaticByteField() jbyte

SetStaticCharField() jchar

SetStaticShortField() jshort

SetStaticIntField() jint

SetStaticLongField() jlong

SetStaticFloatField() jfloat

SetStaticDoubleField() jdouble

参数解释:

env:JNI接口指针

clazz:Java类

field:静态属性ID

value:设置的值

(十六)、获取静态函数ID

jmethodID GetStaticMethodID(JNIEnv *env,jclass clazz,const char *name,const char sig);

返回类的静态方法ID,通过它的方法名以及签名来确定哪个方法。如果这个类还没被初始化,调用GetStaticMethodID()将会导致这个类初始化。

参数解释:

env:JNI接口指针

clazz:Java类

name:静态方法的方法名,以"utf-8"编码的,并且以0结尾的字符串

sig:方法签名,以"utf-8"编码的,并且以0结尾的字符串

返回:

返回方法ID,如果操作失败,则返回NULL

异常:

如果没有找到对应的静态方法,则抛出NoSuchMethodError

如果类初始化失败,则抛出ExceptionInInitializerError

如果系统内存不足,则抛出OutOfMemoryError

(十七)、调用静态函数系列

NativeType CallStaticMethod(JNIEnv *env,jclass clazz,jmethodID methodID,...);

NativeType CallStaticMethodA(JNIEnv *env,jclass clazz,jmethodID methodID,... jvalue *args);

NativeType CallStaticMethodV(JNIEnv *env,jclass,jmethodID methodid, va_list args)

根据指定的方法ID,就可以操作Java对象的静态方法了。可以通过GetStaticMethodID()来获得methodID。方法的ID必须是clazz的,而不是其父类的方法ID。

下面就是详细的方法了

CallStaticMethod Routine Name Native Type

CallStaticVoidMethod()

CallStaticVoidMethodA() void

CallStaticVoidMethodV()

CallStaticObjectMethod()

CallStaticObjectMethodA() jobject

CallStaticObjectMethodV()

CallStaticBooleanMethod()

CallStaticBooleanMethodA() jboolean

CallStaticBooleanMethodV()

CallStaticByteMethod()

CallStaticByteMethodA() jbyte

CallStaticByteMethodV()

CallStaticCharMethod()

CallStaticCharMethodA() jchar

CallStaticCharMethodV()

CallStaticShortMethod()

CallStaticShortMethodA() jshort

CallStaticShortMethodV()

CallStaticIntMethod()

CallStaticIntMethodA() jint

CallStaticIntMethodV()

CallStaticLongMethod()

CallStaticLongMethodA() jlong

CallStaticLongMethodV()

CallStaticFloatMethod()

CallStaticFloatMethodA() jfloat

CallStaticFloatMethodV()

CallStaticDoubleMethod()

CallStaticDoubleMethodA() jdouble

CallStaticDoubleMethodV()

参数解释:

env:JNI接口指针

clazz:Java类

methodID:静态方法ID

返回:

返回静态的Java方法的调用方法

异常:

在Java方法中执行中抛出的异常

七、字符串操作

(一)、创建一个字符串

jstring NewString(JNIEnv *env,const jchar *unicodeChars,jszie len);

参数解释:

env:JNI接口指针

unicodeChars:指向Unicode字符串的指针

len:unicode字符串的长度

返回:

返回一个Java字符串对象,如果该字符串无法被创建在,则返回NULL

异常:

如果内存不足,则抛出OutOfMemoryError

(二)、获取字符串的长度

jsize GetStringLength(JNIEnv *env,jstring string);

返回Java字符串的长度(unicode字符的个数)

参数解释:

env:JNI接口指针

string:Java字符串对象

返回:

返回Java字符串的长度

(三)、获取字符串的指针

const jchar* GetStringChar(JNIEnv *env,jstring string , jboolean *isCopy);

返回指向字符串的UNICODE字符数组的指针,该指针一直有效直到被ReleaseStringchars()函数调用。

如果isCopy为非空,则在复制完成后将isCopy设为JNI_TRUE。如果没有复制,则设为JNI_FALSE。

参数解释:

env:JNI接口指针

string:Java字符串对象

isCopy:指向布尔值的指针

返回:

返回一个指向unicode字符串的指针,如果操作失败,则返回NULL

(四)、释放字符串

void ReleaseStringChars(JNIEnv *env,jstring string,const jchar *chars);

通过VM,native代码不会再访问chars了。参数chars是一个指针。可以通过GetStringChars()函数获得。

参数解释:

env:JNI接口指针

string:Java字符串对象

chars:指向Unicode字符串的指针

(五)、创建一个UTF-8的字符串

jstring NewStringUTF(JNIEnv *env,const char *bytes);

创建一个UTF-8的字符串。

参数解释:

env:JNI接口指针

bytes:指向UTF-8字符串的指针

返回:

Java字符串对象,如果无法构造该字符串,则为NULL。

异常:

如果系统内存不足,则抛出OutOfMemoryError

(六)、获取一个UTF-8的字符串的长度

jsize GetStringUTFLength(JNIEnv *env,jstring string);

以字节为单位,返回字符串UTF-8的长度。

参数解释:

env:JNI接口指针

String:Java字符串对象

返回:

字符串的UTF-8的长度

(七)、获取StringUTFChars的指针

const char *GetStringUFTChars(JNIEnv *env, jString string, jboolean *isCopy);

返回指向UTF-8字符数组的指针,除非该数组被ReleaseStringUTFChars()函数调用释放,否则一直有效。

如果isCopy不是NULL,*isCopy在赋值完成后即被设置为JNI_TRUE。如果未复制,则设置为JNI_FALSE。

参数解释:

env:JNI接口指针

String:Java字符串对象

isCopy:指向布尔值的指针

返回:

指向UTF-8的字符串指针,如果操作是啊白,则返回NULL

(八)、释放UTFChars

void ReleaseStringUTFChars(JNIEnv *env,jstring string,const char *urf)

通过虚拟机,native代码不再访问了utf了。utf是一个指针,可以调用GetStringUTFChars()获取。

参数解释:

env:JNI接口指针

string:Java字符串对象

utf:指向utf-8字符串的指针

注意:在JDK/JRE 1.1,程序员可以在用户提供的缓冲区获取基本类型数组元素,从JDK/JRE1.2开始,提供了额外方法,这些方法允许在用户提供的缓冲区获取Unicode字符(UTF-16编码)或者是UTF-8的字符。这些方法如下:

(九)、字符串操作方法

1、截取一个字符串

void GetStringRegion(JNIEnv *env,jstring str,jsize start,jsize len,jchar *buf)

在str(Unicode字符)从start位置开始截取len长度放置在buf中。如果越界,则抛出StringIndexOutOfBoundsException。

2、 截取一个字符串并将其转换为UTF-8格式

void GetStringUTFRegion(JNIEnv *env,jstring str,jsize start ,jsize len,char *buf);

将str(Unicode字符串)从start位置开始截取len长度并且将其转换为UTF-8编码,然后将结果防止在buf中。

3 、截取一个字符串并将其转换为UTF-8格式

const jchar * GetStringCritical(JNIEnv *env,jstring string,jboolean *isCopy);

void ReleaseStringCritical(JNIEnv *env,jstring string,cost jchar * carray);

上面这两个函数有点类似于GetStringChars()和ReleaseStringChars()功能。如果可能的话虚拟机会返回一个指向字符串元素的指针;否则,则返回一个复制的副本。

PS:GetStringChars()和ReleaseStringChars()这里两个函数有很大的限制。在使用这两个函数时,这两个函数中间的代码不能调用任何让线程阻塞或者等待JVM的其他线程的本地函数或者JNI函数。有了这些限制,JVM就可以在本地方法持有一个从GetStringCritical得到的字符串的指指针时,禁止GC。当GC被禁止时,任何线程如果出发GC的话,都会被阻塞。而GetStringChars()和ReleaseStringChars()这两个函数中间的任何本地代码都不可以执行会导致阻塞的调用或者为新对象在JVM中分配内存。否则,JVM有可能死活,想象一下这样的场景:

1、只有当前线程触发的GC完成阻塞并释放GC时,由其他线程出发的GC才可能由阻塞中释放出来继续执行。

2、在这个过程中,当前线程会一直阻塞,因为任何阻塞性调用都需要获取一个正在被其他线程持有的锁,而其他线程正等待GC。

GetStringChars()和ReleaseStringChars()的交替迭代调用是安全的,这种情况下,它们的使用必须有严格的顺序限制。而且,我们一定要记住检查是否因为内存溢出而导致它的返回值是NULL。因为JVM在执行GetStringChars()这个函数时,仍有发生数据复制的可能性,尤其是当JVM在内存存储的数组不连续时,为了返回一个指向连续内存空间的指针,JVM必须复制所有数据。

总之,为了避免死锁,在GetStringChars()和ReleaseStringChars()`之间不要调用任何JNI函数。

八、数组操作

(一)、获取数组的长度

jsize GetArrayLength(JNIEnv *env,jarray array)

返回数组的长度

参数解释:

env:JNI接口指针

array:Java数组

返回:

数组的长度

(二)、创建对象数组

jobjectArray NewObjectArray(JNIEnv *env,jsize length,jclass elementClass, jobject initialElement);

创建一个新的对象数组,它的元素的类型是elementClass,并且所有元素的默认值是initialElement。

参数解释:

env:JNI接口指针

length:数组大小

elementClass:数组元素类

initialElement:数组元素的初始值

返回:

Java数组对象,如果无法构造数组,则返回NULL

异常:

如果内存不足,则抛出OutOfMemoryError

(三)、获取数组元中的某个元素

jobject GetObjectArrayElement(JNIEnv *env,jobjectArray array,jsize index);

返回元素中某个位置的元素

参数解释:

env:JNI接口指针

array:Java数组

index:数组下标

返回:

Java对象

异常:

如果index下标不是一个有效的下标,则会抛出ArrayIndexOutOfBoundsException

(四)、设置数组中某个元素的值

void SetObjectArrayElement(JNIEnv *env,jobjectArray array,jsize index,jobject value);

设置下标为index元素的值。

参数解释:

env:JNI接口指针

array:Java数组

index:数组下标

value:数组元素的新值

异常:

如果index不是有效下标,则会抛出ArrayIndexOutOfBoundsException

如果value不是元素类的子类,则会抛出ArrayStoreException

(五)、创建基本类型数组系列

ArrayType NewArray(JNIEnv *env,jsize length);

用于构造基本类型数组对象的一系列操作。下面说明了特定基本类型数组的创建函数。可以把NewArray替换为某个实际的基本类型数组创建函数 ,然后将ArrayType替换为相应的数组类型

NewArray Routines Array Type

NewBooleanArray() jbooleanArray

NewByteArray() jbyteArray

NewCharArray() jcharArray

NewShortArray() jshortArray

NewIntArray() jintArray

NewLongArray() jlongArray

NewFloatArray() jfloatArray

NewDoubleArray() jdoubleArray

参数解释:

env:JNI接口指针

length:数组长度

返回:

Java数组,如果无法创建该数组,则返回NULL。

(六)、获取基本类型数组的中数组指针系列

NativeType * GetArrayElements(JNIEnv *env,ArrayType array,jboolean * isCopy);

一组返回类型是基本类型的数组指针。在调用相应的ReleaseArrayElements()函数前将一直有效。由于返回的数组可能是Java数组的副本,因此,对返回数组的变更没有在基本类型中反应出来。除非了调用

一组返回基本类型数组体的函数。结果在调用相应的 ReleaseArrayElements()函数前将一直有效。由于返回的数组可能是 Java 数组的副本,因此对返回数组的更改不必在基本类型数组中反映出来,直到调用``ReleaseArrayElements()`函数。

如果isCopy不是NULL,*isCopy在复制完成后即被设为JNI_TRUE。如果未复制,则设为JNI_FALSE。

下面说明了特定的基本类型数组元素的具体函数:

将GetArrayElements替换为表中某个实际的基本> 类型的函数

将ArrayType替换为对应的数组类型

将NativeType替换为本地变量

不管布尔数组在Java虚拟机总如何表示,GetBooleanArrayElements()将始终返回一个jboolean类型的指针,其中每一个字节代表一个元素(开包表示)。内存中将确保所有其他类型的数组为连续的。

GetArrayElements Routines Array Type Native Type

GetBooleanArrayElements() jbooleanArray jboolean

GetByteArrayElements() jbyteArray jbyte

GetCharArrayElements() jcharArray jchar

GetShortArrayElements() jshortArray jshort

GetIntArrayElements() jintArray jint

GetLongArrayElements() jlongArray jlong

GetFloatArrayElements() jfloatArray jfloat

GetDoubleArrayElements() jdoubleArray jdouble

参数解释:

env:JNI接口指针

array:Java数组

isCopy:指向布尔值的指针

返回:

返回指向数组元素的指针,如果操作失败,则返回NULL

(七)、复制过去基本类型的数组系列

void Get ArrayRegion(JNIEnv *env,ArrayType array,jsize start,jsize len,NativeType *buf);

复制基本类型的数组给buff

下面说明了特定的基本类型数组元素的具体函数:

将Get ArrayRegion替换下面中某个实际的基本> 类型的函数

将ArrayType替换为对应的基本数组类型

将NativeType替换为本地变量

GetArrayRegion Routine Array Type Native Type

GetBooleanArrayRegion() jbooleanArray jboolean

GetByteArrayRegion() jbyteArray jbyte

GetCharArrayRegion() jcharArray jchar

GetShortArrayRegion() jshortArray jhort

GetIntArrayRegion() jintArray jint

GetLongArrayRegion() jlongArray jlong

GetFloatArrayRegion() jfloatArray jloat

GetDoubleArrayRegion() jdoubleArray jdouble

参数解释:

env:JNI接口指针

array:Java数组

start:开始索引

len:需要复制的长度

buf:目标buffer

异常:

如果索引无效,则抛出ArrayIndexOutOfBoundsException

(八)、把基本类型数组的数组复制回来系列

void Set ArrayRegion(JNIEnv *env,ArrayType array,jsize start,jsize len,const NativeType *buf);

主要是冲缓冲区复制基本类型的数组的函数

下面说明了特定的基本类型数组元素的具体函数:

将SetArrayRegion替换下面中某个实际的基本> 类型的函数

将ArrayType替换为对应的基本数组类型

将NativeType替换为本地变量

SetArrayRegion Routine Array Type Native Type

SetBooleanArrayRegion() jbooleanArray jboolean

SetByteArrayRegion() jbyteArray jbyte

SetCharArrayRegion() jcharArray jchar

SetShortArrayRegion() jshortArray jshort

SetIntArrayRegion() jintArray jint

SetLongArrayRegion() jlongArray jlong

SetFloatArrayRegion() jfloatArray jfloat

SetDoubleArrayRegion() jdoubleArray jdouble

参数解释:

env:JNI接口指针

array:Java数组

start:开始索引

len:需要复制的长度

buf:源buffer

异常:

如果索引无效则会抛出ArrayIndexOutOfBoundsException

九、系统级别的操作

(一) 注册方法

jint RegisterNatives(JNIEnv *env,jclass clazz,const JNINativeMethod *methods,jint nMethod);

根据clazz参数注册本地方法,methods参数制定JNINativeMethod结构数组,该数组包含本地方法的名字、签名及函数指针。其中名字及签名是指向编码为“UTF-8”的指针;nMethod参数表明数组中本地方法的个数。

这里说下JNINativeMethod这个结构体

typedef struct {

char *name;

char *signature;

void *fnPtr;

} JNINativeMethod;

参数解释:

env:JNI接口指针

clazz:Java类对象

methods:类中的native方法

nMethod:类中本地方法的个数

返回;

成功返回0,失败返回负数

异常:

如果没有找到指定的方法或者方法不是本地方法,则抛出NoSuchMethodError。

(二) 注销方法

jint UnregisterNatives(JNIEnv *env,jclass clazz);

注销本地方法。类回收之前还没有被函数注册的状态。该函数一般不能再Native代码中被调用,它为特定的程序提供了一种重加载重链接本地库的方法。

参数解释:

JNI:接口指针

clazz:Java类对象

返回:

注销成功返回0,失败返回负数

总结:

常用的jni都总结到这里了,需要的可以收藏下;

下次会介绍java和jni之间的相互调用。

文章分类
Android
文章标签