`

JNI编程中如何传递参数和返回值

 
阅读更多

 

本篇将介绍在JNI编程中如何传递参数和返回值。

首先要强调的是,native方法不但可以传递Java的基本类型做参数,还可以传递更复杂的类型,比如String,数组,甚至自定义的类。这一切都可以在jni.h中找到答案。

1. Java基本类型的传递

用过Java的人都知道,Java中的基本类型包括boolean,byte,char,short,int,long,float,double 这样几种,如果你用这几种类型做native方法的参数,当你通过javah -jni生成.h文件的时候,只要看一下生成的.h文件,就会一清二楚,这些类型分别对应的类型是 jboolean,jbyte,jchar,jshort,jint,jlong,jfloat,jdouble 。这几种类型几乎都可以当成对应的C++类型来用,所以没什么好说的。

2. String参数的传递

Java的String和C++的string是不能对等起来的,所以处理起来比较麻烦。先看一个例子,

class Prompt {

// native method that prints a prompt and reads a line

private native String getLine(String prompt);

public static void main(String args[]) {

Prompt p = new Prompt();

String input = p.getLine("Type a line: ");

System.out.println("User typed: " + input);

}

static {

System.loadLibrary("Prompt");

}

}

在这个例子中,我们要实现一个native方法
String getLine(String prompt);
读入一个String参数,返回一个String值。

通过执行javah -jni得到的头文件是这样的

#include

#ifndef _Included_Prompt

#define _Included_Prompt

#ifdef __cplusplus

extern "C" {

#endif

JNIEXPORT jstring JNICALL Java_Prompt_getLine(JNIEnv *env, jobject this, jstring prompt);

#ifdef __cplusplus

}

#endif

#endif

jstring是JNI中对应于String的类型,但是和基本类型不同的是,jstring不能直接当作C++的string用。如果你用
cout << prompt << endl;
编译器肯定会扔给你一个错误信息的。

其实要处理jstring有很多种方式,这里只讲一种我认为最简单的方式,看下面这个例子,

#include "Prompt.h"

#include

JNIEXPORT jstring JNICALL Java_Prompt_getLine(JNIEnv *env, jobject obj, jstring prompt)

{

const char* str;

str = env->GetStringUTFChars(prompt, false);

if(str == NULL) {

return NULL; /* OutOfMemoryError already thrown */

}

std::cout << str << std::endl;

env->ReleaseStringUTFChars(prompt, str);

char* tmpstr = "return string succeeded";

jstring rtstr = env->NewStringUTF(tmpstr);

return rtstr;

}

在上面的例子中,作为参数的prompt不能直接被C++程序使用,先做了如下转换
str = env->GetStringUTFChars(prompt, false);
将jstring类型变成一个char*类型。

返回的时候,要生成一个jstring类型的对象,也必须通过如下命令,
jstring rtstr = env->NewStringUTF(tmpstr);

这里用到的GetStringUTFChars和NewStringUTF都是JNI提供的处理String类型的函数,还有其他的函数这里就不一一列举了。

3. 数组类型的传递

和String一样,JNI为Java基本类型的数组提供了j*Array类型,比如int[]对应的就是jintArray。来看一个传递int数组的例子,Java程序就不写了,

JNIEXPORT jint JNICALL Java_IntArray_sumArray(JNIEnv *env, jobject obj, jintArray arr)

{

jint *carr;

carr = env->GetIntArrayElements(arr, false);

if(carr == NULL) {

return 0; /* exception occurred */

}

jint sum = 0;

for(int i=0; i<10; i++) {

sum += carr[i];

}

env->ReleaseIntArrayElements(arr, carr, 0);

return sum;

}

这个例子中的GetIntArrayElements和ReleaseIntArrayElements函数就是JNI提供用于处理int数组的函数。如果试图用arr[i]的方式去访问jintArray类型,毫无疑问会出错。JNI还提供了另一对函数GetIntArrayRegion和 ReleaseIntArrayRegion访问int数组,就不介绍了,对于其他基本类型的数组,方法类似。

4. 二维数组和String数组

在JNI中,二维数组和String数组都被视为object数组,因为数组和String被视为object。仍然用一个例子来说明,这次是一个二维int数组,作为返回值。

JNIEXPORT jobjectArray JNICALL Java_ObjectArrayTest_initInt2DArray(JNIEnv *env, jclass cls, int size)

{

jobjectArray result;

jclass intArrCls = env->FindClass("[I");

result = env->NewObjectArray(size, intArrCls, NULL);

for (int i = 0; i < size; i++) {

jint tmp[256]; /* make sure it is large enough! */

jintArray iarr = env->NewIntArray(size);

for(int j = 0; j < size; j++) {

tmp[j] = i + j;

}

env->SetIntArrayRegion(iarr, 0, size, tmp);

env->SetObjectArrayElement(result, i, iarr);

env->DeleteLocalRef(iarr);

}

return result;

}

上面代码中的第三行,
jobjectArray result;
因为要返回值,所以需要新建一个jobjectArray对象。

jclass intArrCls = env->FindClass("[I");
是创建一个jclass的引用,因为result的元素是一维int数组的引用,所以intArrCls必须是一维int数组的引用,这一点是如何保证的呢?注意FindClass的参数"[I",JNI就是通过它来确定引用的类型的,I表示是int类型,[标识是数组。对于其他的类型,都有相应的表示方法,

Z boolean
B byte
C char
S short
I int
J long
F float
D double

String是通过“Ljava/lang/String;”表示的,那相应的,String数组就应该是“[Ljava/lang/String;”。

还是回到代码,
result = env->NewObjectArray(size, intArrCls, NULL);
的作用是为result分配空间。

jintArray iarr = env->NewIntArray(size);
是为一维int数组iarr分配空间。

env->SetIntArrayRegion(iarr, 0, size, tmp);
是为iarr赋值。

env->SetObjectArrayElement(result, i, iarr);
是为result的第i个元素赋值。

通过上面这些步骤,我们就创建了一个二维int数组,并赋值完毕,这样就可以做为参数返回了。

如果了解了上面介绍的这些内容,基本上大部分的任务都可以对付了。虽然在操作数组类型,尤其是二维数组和String数组的时候,比起在单独的语言中编程要麻烦,但既然我们享受了跨语言编程的好处,必然要付出一定的代价。

有一点要补充的是,本文所用到的函数调用方式都是针对C++的,如果要在C中使用,所有的env->都要被替换成(*env)->,而且后面的函数中需要增加一个参数env,具体请看一下jni.h的代码。另外还有些省略的内容,可以参考JNI的文档:Java Native Interface 6.0 Specification,在JDK的文档里就可以找到。如果要进行更深入的JNI编程,需要仔细阅读这个文档。接下来的高级篇,也会讨论更深入的话题。

关于JNI编程更深入的话题,包括:在native方法中访问Java类的域和方法,将Java中自定义的类作为参数和返回值传递等等。了解这些内容,将会对JNI编程有更深入的理解,写出的程序也更清晰,易用性更好。

1. 在一般的Java类中定义native方法

在前两篇的例子中,都是将native方法放在main方法的Java类中,实际上,完全可以在任何类中定义native方法。这样,对于外部来说,这个类和其他的Java类没有任何区别。

2. 访问Java类的域和方法

native方法虽然是native的,但毕竟是方法,那么就应该同其他方法一样,能够访问类的私有域和方法。实际上,JNI的确可以做到这一点,我们通过几个例子来说明,

public class ClassA {

String str_ = "abcde";

int number_;

public native void nativeMethod();

private void javaMethod() {

System.out.println("call java method succeeded");

}

static {

System.loadLibrary("ClassA");

}

}

在这个例子中,我们在一个没有main方法的Java类中定义了native方法。我们将演示如何在nativeMethod()中访问域str_,number_和方法javaMethod(),nativeMethod()的C++实现如下,

JNIEXPORT void JNICALL Java_testclass_ClassCallDLL_nativeMethod(JNIEnv *env, jobject obj) {

// access field

jclass cls = env->GetObjectClass(obj);

jfieldID fid = env->GetFieldID(cls, "str_", "Ljava/lang/String;");

jstring jstr = (jstring)env->GetObjectField(obj, fid);

const char *str = env->GetStringUTFChars(jstr, false);

if(std::string(str) == "abcde")

std::cout << "access field succeeded" << std::endl;

jint i = 2468;

fid = env->GetFieldID(cls, "number_", "I");

env->SetIntField(obj, fid, i);

// access method

jmethodID mid = env->GetMethodID(cls, "javaMethod", "()V");

env->CallVoidMethod(obj, mid);

}

上面的代码中,通过如下两行代码获得str_的值,
jfieldID fid = env->GetFieldID(cls, "str_", "Ljava/lang/String;");
jstring jstr = (jstring)env->GetObjectField(obj, fid);

第一行代码获得str_的id,在GetFieldID函数的调用中需要指定str_的类型,第二行代码通过str_的id获得它的值,当然我们读到的是一个jstring类型,不能直接显示,需要转化为char*类型。

接下来我们看如何给Java类的域赋值,看下面两行代码,
fid = env->GetFieldID(cls, "number_", "I");
env->SetIntField(obj, fid, i);

第一行代码同前面一样,获得number_的id,第二行我们通过SetIntField函数将i的值赋给number_,其他类似的函数可以参考JDK的文档。

访问javaMethod()的过程同访问域类似,

JNI 调用java类的方法与反射代码类似。

 

先得到object的类。

 

-->jobject obj;

 

jclass cls = env->GetObjectClass(obj);

 

然后查找方法:

 

jmethodID mid = env->GetMethodID(cls, "javaMethod", "()V");

 

然后用这个方法id去执行obj的方法。

 

env->CallVoidMethod(obj, mid);

 

需要注意的是 GetMethodID方法的格式。

 

jmethodID GetMethodID(JNIEnv *env, jclass clazz,

 

const char *name, const char *sig);

 

JNIEnv这个参数C++中不需要。clazz就是前面得到的jclass.

 

name则是方法名称,sig是方法签名。

 

方法签名有特定的格式:(param-type)ret-type,括号内表示该方法传入参数类型,后面的是返回类型

 

其中param-type和ret-type都是由特定符号组成,各java primitive type都有各自对应符号如下表。

 

Table 3-2 Java VM Type Signatures

 

Type Signature Java Type

 

Z boolean

 

B byte

 

C char

 

S short

 

I int

 

J long

 

F float

 

D double

 

L fully-qualified-class ; fully-qualified-class

 

[ type type[]

 

( arg-types ) ret-type method type

 

比如long f (int n, String s, int[] arr);

 

的signature就是(ILjava/lang/String;[I)J

 

另外千万别忘记L fully-qualified-class ; 这个格式后面的那个;号。
jmethodID mid = env->GetMethodID(cls, "javaMethod", "()V");
env->CallVoidMethod(obj, mid);


需要强调的是,在GetMethodID中,我们需要指定javaMethod方法的类型,域的类型很容易理解,方法的类型如何定义呢,在上面的例子中,我们用的是()V,V表示返回值为空,()表示参数为空。如果是更复杂的函数类型如何表示?看一个例子,
long f (int n, String s, int[] arr);
这个函数的类型符号是(ILjava/lang/String;[I)J,I表示int类型,Ljava/lang/String;表示String类型,[I表示int数组,J表示long。这些都可以在文档中查到。

3. 在native方法中使用用户定义的类

JNI不仅能使用Java的基础类型,还能使用用户定义的类,这样灵活性就大多了。大体上使用自定义的类和使用Java的基础类(比如 String)没有太大的区别,关键的一点是,如果要使用自定义类,首先要能访问类的构造函数,看下面这一段代码,我们在native方法中使用了自定义的Java类ClassB,

jclass cls = env->FindClass("Ltestclass/ClassB;");

jmethodID id = env->GetMethodID(cls, "", "(D)V");

jdouble dd = 0.033;

jvalue args[1];

args[0].d = dd;

jobject obj = env->NewObjectA(cls, id, args);

首先要创建一个自定义类的引用,通过FindClass函数来完成,参数同前面介绍的创建String对象的引用类似,只不过类名称变成自定义类的名称。然后通过GetMethodID函数获得这个类的构造函数,注意这里方法的名称是"",它表示这是一个构造函数。

jobject obj = env->NewObjectA(cls, id, args);
生成了一个ClassB的对象,args是ClassB的构造函数的参数,它是一个jvalue*类型。

通过以上介绍的三部分内容,native方法已经看起来完全像Java自己的方法了,至少主要功能上齐备了,只是实现上稍麻烦。而了解了这些,JNI编程的水平也更上一层楼。下面要讨论的话题也是一个重要内容,至少如果没有它,我们的程序只能停留在演示阶段,不具有实用价值。

4. 异常处理

在C++和Java的编程中,异常处理都是一个重要的内容。但是在JNI中,麻烦就来了,native方法是通过C++实现的,如果在native方法中发生了异常,如何传导到Java呢?

JNI提供了实现这种功能的机制。我们可以通过下面这段代码抛出一个Java可以接收的异常,

jclass errCls;

env->ExceptionDescribe();

env->ExceptionClear();

errCls = env->FindClass("java/lang/IllegalArgumentException");

env->ThrowNew(errCls, "thrown from C++ code");

如果要抛出其他类型的异常,替换掉FindClass的参数即可。这样,在Java中就可以接收到native方法中抛出的异常。

分享到:
评论

相关推荐

    JNI编程指南(中文版&英文版)

    6. **回调Java方法**:了解如何在本地代码中调用Java方法,包括同步调用和异步调用,以及传递参数和返回值。 7. **异常处理**:学习在JNI中处理Java异常,包括检查和抛出异常,以及在本地代码中捕获并处理异常。 8...

    android_JNI编程_一些技巧

    本篇将介绍在JNI编程中如何传递参数和返回值。 首先要强调的是,native方法不但可以传递Java的基本类型做参数,还可以传递更复杂的类型,比如String,数组,甚至自定义的类。这一切都可以在jni.h中找到答案

    JNI编程指南.zip

    9. **线程安全**:JNI编程需要考虑线程安全问题,因为本地代码可能在多个线程中并发执行。正确地管理和同步资源,避免数据竞争和死锁,是开发JNI程序的关键。 10. **性能优化**:JNI允许直接访问硬件,因此在某些...

    jni编程指南(相当给力的说明文档)

    - **主要内容**:提供了JNI基础教程的概览,包括基本的数据类型传递和复杂类型的处理等。 - **关键知识点**: - 传递字符串 - 传递整型数组 - 传递字符串数组 - 传递对象数组 #### 知识点六:C++与Java之间的...

    JAVA C++ JNI小结一下JNI编程

    ### JNI编程概述 JNI(Java Native Interface)是Java平台的一部分,它允许Java代码与其他语言写的代码进行交互。...掌握JNI编程的基本原理和技术细节,可以帮助开发者更好地利用不同编程语言的优势。

    Java本地接口(JNI)编程指南和规范 Java Native Interface 6.0 Specification

    )V"表示一个接受一个整数和一个字符串参数,返回值为空的方法。 3. **Java对象引用**:在本地代码中,Java对象通过`jobject`类型的指针表示,通过JNIEnv指针可以获取对象的字段值、调用方法等。 4. **数组处理**:...

    JNI完全技术手册 带完整书签

    7、实例七:jni函数中传递基本数据类型参数... 62 8、实例八:在jni函数中传递对象类型参数... 62 9、实例九:在jni函数中处理字符串... 63 10、实例十:在jni函数中处理数组... 64 11、实例十一:在jni中的...

    NDK jni中编程时帮助文档

    QNX632.chm文档将详细解释这些知识点,包括每个函数的参数、返回值、使用场景和可能的错误情况,是开发者进行NDK和JNI编程的宝贵资源。通过学习和查阅这个文档,开发者能够更熟练地在Android平台上进行原生代码开发...

    Java JNI 编程

    通过这些接口,Java应用程序可以调用C/C++编写的函数,并且可以传递参数、返回值等信息。 #### 三、JNI在Windows注册表访问中的应用 Windows注册表是存储操作系统及其应用程序设置信息的一个关键数据库。它包含了...

    jni编程指南

    - 详细说明了每个JNI函数的作用、参数类型和返回值。 - 如何正确地使用这些函数以确保程序的稳定性和兼容性。 2. **JVM开发指导** - 对于希望实现自己JVM的开发者而言,这些章节提供了必要的指导和规范。 - ...

    AndroidJNI编程

    本教程将深入讲解JNI编程的关键概念和技术,主要涵盖了Java调用C,C调用Java以及参数的传递。 1. **Java调用C**: 在Android应用中,Java代码可以通过JNI函数声明来调用C/C++代码。首先,你需要在Java类中声明一个...

    JNI中C代码调用使用java属性和方法

    在JNI编程中,异常处理也是非常重要的一部分,应通过检查返回值来确定是否存在异常,并进行相应的处理。 JNI编程虽然复杂,但是它提供了一种强大的机制,使得Java应用可以利用其他语言编写的高效代码。JNI不仅限于...

    JNI完全技术手册

    开发者需要了解这些映射关系,以便正确地传递参数和返回值。 5. **本地方法签名**:每个本地方法都有一个唯一的签名,由返回类型、参数类型按顺序组成,如`(IILjava/lang/String;)V`表示一个无返回值的方法,接受一...

    帮你快速上手JNI技术

    如何在Java与本地方法之间传递参数和接收返回值是JNI编程的一个重要部分。 5. 访问对象的变量和方法:包括访问对象实例变量、访问类的静态变量、回调实例方法和被覆盖的父类方法。理解如何在本地代码中安全地操作...

    JNI

    首先,本地方法的参数和返回值都需要转换为JNI数据类型,如`jint`, `jobject`等。其次,线程安全是个挑战,因为Java的多线程机制和C/C++的多线程处理方式不同,需要谨慎管理线程同步。最后,性能优化是另一个重要...

    Android JNI开发手册

    通过各种示例,手册逐步引导读者了解如何在JNI中传递和返回值,包括基本数据类型、对象类型、字符串和数组等。 在深入学习如何在Java和C/C++之间传递参数的同时,本手册还介绍了JNI中的参数传递机制,特别是如何将...

    JNI-study(讲JNI的书,中文版)

    4. 跨语言通信:阐述JNI如何在Java和本地代码之间传递参数,以及如何处理返回值,包括引用传递和值传递的区别。 5. 异常处理:介绍在JNI中如何捕获和抛出Java异常,以及如何在本地代码中进行错误处理。 6. 类和...

    网上整理的JNI教程

    - **JNI传递返回值**:详细讲解了如何在JNI中传递和返回各种类型的数据,包括基本类型、字符串、数组等。 - **传递字符串**:介绍了在JNI中如何安全有效地处理字符串传递。 - **传递整型数组**:探讨了整型数组在...

Global site tag (gtag.js) - Google Analytics