Android NDK 开发（二）JNI 传递参数和返回值

红太狼 2022-07-16 04:49 142阅读 0赞

## 前言 ##

我们在使用 JNI 时最常问到的是 JAVA 和 C/C++之间如何传递数据，以及数据类型之间如何 互相映射。我们从整数等基本类型和数组、字符串等普通的对象类型开始讲述。至于如何传递任意对象，将在后面会更新。

原文链接请标明：  
[http://blog.csdn.net/u011974987/article/details/52743495][http_blog.csdn.net_u011974987_article_details_52743495]  
本文出自:【[stromxu][]的博客】

--------------------

## 正文 ##

继[JNI简介及调用流程][JNI]这篇文章，我们再来实现一个非静态的native方法。

Java端：

public class JniTest {
    
        //静态的
        public native static String getStringFromC();
    
        //非静态的
        public native String getString2FromC(int i);
    
        public static void main(String[] args) {
            String text = getStringFromC();
            System.out.println(text);
    
            JniTest t = new JniTest();
            text = t.getString2FromC(6);
            System.out.println(text);
    
        }
    
        //加载动态库
        static{ 
            System.loadLibrary("jni_study");
        }
    
    }

在native层实现 getString2FromC 非静态方法；

JNIEXPORT jstring JNICALL Java_com_study_jni_JniTest_getString2FromC
    (JNIEnv *env, jobject jobj, jint num){
        return (*env)->NewStringUTF(env,"C String2");
    }

由此看出，每个native函数，都至少有两个参数（JNIEnv\*,jclass或者jobject)

*  **当native方法为静态方法时：**  
    jclass 代表native方法所属类的class对象(JniTest.class)
 *  **当native方法为非静态方法时：**  
    jobject 代表native方法所属的对象

--------------------

### **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++类型来用。

Java基本数据类型与JNI数据类型的映射关系如下：

![JNI的基本数据类型][JNI 1]

对应的java引用数据类型：

struct _jobject;
    
    typedef struct _jobject *jobject;
    typedef jobject jclass;
    typedef jobject jthrowable;
    typedef jobject jstring;
    typedef jobject jarray;
    typedef jarray jbooleanArray;
    typedef jarray jbyteArray;
    typedef jarray jcharArray;
    typedef jarray jshortArray;
    typedef jarray jintArray;
    typedef jarray jlongArray;
    typedef jarray jfloatArray;
    typedef jarray jdoubleArray;
    typedef jarray jobjectArray;

关系图：

![这里写图片描述][20161006153213851]

最终都是jobject 的结构体指针类型。

--------------------

### **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 <jni.h>
    #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 <iostream>
    
    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; 
    }
    
    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端主要代码：

public native void giveArray(int[] array);
    
        int[] array = {
       9,100,10,37,5,10};
            //排序
        t.giveArray(array);
    
        for (int i : array) {
            System.out.println(i);
        }

C实现主要代码：

int compare(int *a,int *b){
        return (*a) - (*b);
    }
    
    //传入
    JNIEXPORT void JNICALL Java_com_study_jni_JniTest_giveArray
    (JNIEnv *env, jobject jobj, jintArray arr){
        //jintArray -> jint指针 -> c int 数组
        jint *elems = (*env)->GetIntArrayElements(env, arr, NULL);
        //printf("%#x,%#x\n", &elems, &arr);
    
        //数组的长度
        int len = (*env)->GetArrayLength(env, arr);
        //排序
        qsort(elems, len, sizeof(jint), compare);   
    
        //同步
        //mode
        //0, Java数组进行更新，并且释放C/C++数组
        //JNI_ABORT, Java数组不进行更新，但是释放C/C++数组
        //JNI_COMMIT，Java数组进行更新，不释放C/C++数组（函数执行完，数组还是会释放）
    
        (*env)->ReleaseIntArrayElements(env, arr, elems, JNI_COMMIT);
    }

这个代码中的**GetIntArrayElements**和**ReleaseIntArrayElements**函数就是JNI提供用于处理int数组的函数。

如果用arr\[i\]的方式去访问jintArray类型，不用问肯定会出错。  
JNI还提供了另一对函数**GetIntArrayRegion**和**ReleaseIntArrayRegion**访问int数组，不在这里做介绍，至于其他的类型数组，方法类似。

--------------------

### **4.返回数组** ###

在JNI中，二维数组和String数组都被视为object数组，因为数组和String被视为object。最后一个示例说明如何在本地代码中创建一个字符串数组并将它返回给 Java 调用者。

java端的代码：

int[] array2 = t.getArray(10);
        System.out.println("------------");
        for (int i : array2) {
            System.out.println(i);
        }

函数实现：

//返回数组
    JNIEXPORT jintArray JNICALL Java_com_study_jni_JniTest_getArray(JNIEnv *env, jobject jobj, jint len){
        //创建一个指定大小的数组
        jintArray jint_arr = (*env)->NewIntArray(env, len);
        jint *elems = (*env)->GetIntArrayElements(env, jint_arr, NULL); 
        int i = 0;
        for (; i < len; i++){
            elems[i] = i;
        }
    
        //同步
        (*env)->ReleaseIntArrayElements(env, jint_arr, elems, 0);   
    
        return jint_arr;
    }

jintArray jint\_arr ;因为要返回值，所以需要创建一个指定大小jintArray对象。根据jintArray对象拿到jint 指针。然后，赋值，同步，这样通过参数返回就可以了。  
下一篇将会介绍C 访问Java 属性和方法。

> 本文由博主辛苦整理下来的笔记；  
> 希望大家能够指点或提出宝贵意见，共同学习，谢谢！  
> 转载请注明出处：[http://blog.csdn.net/u011974987/article/details/52743495][http_blog.csdn.net_u011974987_article_details_52743495]  
> 欢迎关注我的社交网站~  
> 个人博客：[xuhaoblog.com][]  
> 新浪微博：[http://weibo.com/xuxiho][http_weibo.com_xuxiho]  
> github：[https://github.com/git-xuhao][https_github.com_git-xuhao]

[http_blog.csdn.net_u011974987_article_details_52743495]: http://blog.csdn.net/u011974987/article/details/52743495
[stromxu]: http://blog.csdn.net/u011974987
[JNI]: http://blog.csdn.net/u011974987/article/details/52602913
[JNI 1]: /images/20220716/21209ff9a5014dce84a46978e967437c.png
[20161006153213851]: /images/20220716/3da043e3e21546eea79f6af6d6af5a77.png
[xuhaoblog.com]: http://xuhaoblog.com
[http_weibo.com_xuxiho]: http://weibo.com/xuxiho
[https_github.com_git-xuhao]: https://github.com/git-xuhao