java调用本地方法--JNI字符串参数传递与返回

本篇结构：

简介
实例

一、简介

补充JNI字符串参数传递与返回调用实例。

二、实例

2.1、编写Java类

public class Sample {

    public native static String sayHello(String text);

    public static void main(String[] args) {
        String text = sayHello("james");
        System.out.println("Java str: " + text);
    }

    static {
        System.loadLibrary("Sample");
    }
}

2.2、编译java类

javac Sample.java

2.3、生成相关JNI方法的头文件

javah -d jnilib -jni Sample

/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class Sample */

#ifndef _Included_Sample
#define _Included_Sample
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     Sample
 * Method:    sayHello
 * Signature: (Ljava/lang/String;)Ljava/lang/String;
 */
JNIEXPORT jstring JNICALL Java_Sample_sayHello
  (JNIEnv *, jclass, jstring);

#ifdef __cplusplus
}
#endif
#endif

2.4、使用C/C++实现本地方法

#include "Sample.h"
#include <string.h>

JNIEXPORT jstring JNICALL Java_Sample_sayHello
  (JNIEnv *env, jclass cls, jstring j_str)  
{
    const char *c_str = NULL;  
    char buff[128] = {0};  
    c_str = (*env)->GetStringUTFChars(env, j_str, NULL);  
    if(c_str == NULL)  
    {  
        return NULL;  
    }  
    printf("C_str: %s \n", c_str);  
    sprintf(buff, "hello %s", c_str);  
    (*env)->ReleaseStringUTFChars(env, j_str, c_str);  
    return (*env)->NewStringUTF(env,buff);  
}

上面是c语言版，下面是c++版，注意到字符串操作上有些不同：

#include "Sample.h"
#include <string.h>

JNIEXPORT jstring JNICALL Java_Sample_sayHello
  (JNIEnv *env, jclass cls, jstring j_str)  
{
    const char *c_str = NULL;  
    char buff[128] = {0};  
    c_str = env->GetStringUTFChars(j_str, NULL);  /* 获得传入的字符串，将其转换为native Strings */
    if(c_str == NULL)  /* c_str == NULL意味着JVM为native String分配内存失败 */
    {  
        return NULL;  
    }  
    printf("C_str: %s \n", c_str);  
    sprintf(buff, "hello %s", c_str);  
    env->ReleaseStringUTFChars(j_str, c_str);  /* 通知JVM释放String所占的内存 */
    return env->NewStringUTF(buff);  /* 构造新的Java.lang.String，如果JVM分配内存失败，则抛出OutOfMemoryError，并且返回NULL */
}

2.5、生成动态链接库

g++ -D_REENTRANT -fPIC -I $JAVA_HOME/include -I $JAVA_HOME/include/linux -shared -o libSample.so Sample.cpp

2.6、运行java

java -Djava.library.path=jnilib Sample

2.7、解释

1.访问字符串

Java_Sample_sayHello函数接收一个jstring类型的参数j_str，但jstring类型是指向JVM内部的一个字符串，和C风格的字符串类型char*不同，所以在JNI中不能通把jstring当作普通C字符串一样来使用，必须使用合适的JNI函数来访问JVM内部的字符串数据结构。

GetStringUTFChars(env, j_str, &isCopy) 参数说明：

env：JNIEnv函数表指针
j_str：jstring类型（Java传递给本地代码的字符串指针）
isCopy：取值JNI_TRUE和JNI_FALSE，如果值为JNI_TRUE，表示返回JVM内部源字符串的一份拷贝，并为新产生的字符串分配内存空间。如果值为JNI_FALSE，表示返回JVM内部源字符串的指针，意味着可以通过指针修改源字符串的内容，不推荐这么做，因为这样做就打破了Java字符串不能修改的规定。但我们在开发当中，并不关心这个值是多少，通常情况下这个参数填NULL即可。

因为Java默认使用Unicode编码，而C/C++默认使用UTF编码，所以在本地代码中操作字符串的时候，必须使用合适的JNI函数把jstring转换成C风格的字符串。JNI支持字符串在Unicode和UTF-8两种编码之间转换，GetStringUTFChars可以把一个jstring指针（指向JVM内部的Unicode字符序列）转换成一个UTF-8格式的C字符串。在上例中sayHello函数中我们通过GetStringUTFChars正确取得了JVM内部的字符串内容。

2.异常检查

调用完GetStringUTFChars之后不要忘记安全检查，因为JVM需要为新诞生的字符串分配内存空间，当内存空间不够分配的时候，会导致调用失败，失败后GetStringUTFChars会返回NULL，并抛出一个OutOfMemoryError异常。JNI的异常和Java中的异常处理流程是不一样的，Java遇到异常如果没有捕获，程序会立即停止运行。而JNI遇到未决的异常不会改变程序的运行流程，也就是程序会继续往下走，这样后面针对这个字符串的所有操作都是非常危险的，因此，我们需要用return语句跳过后面的代码，并立即结束当前方法。

3.释放字符串

在调用GetStringUTFChars函数从JVM内部获取一个字符串之后，JVM内部会分配一块新的内存，用于存储源字符串的拷贝，以便本地代码访问和修改。即然有内存分配，用完之后马上释放是一个编程的好习惯。通过调用ReleaseStringUTFChars函数通知JVM这块内存已经不使用了，你可以清除了。注意：这两个函数是配对使用的，用了GetXXX就必须调用ReleaseXXX，而且这两个函数的命名也有规律，除了前面的Get和Release之外，后面的都一样。

4.创建字符串

通过调用NewStringUTF函数，会构建一个新的java.lang.String字符串对象。这个新创建的字符串会自动转换成Java支持的Unicode编码。如果JVM不能为构造java.lang.String分配足够的内存，NewStringUTF会抛出一个OutOfMemoryError异常，并返回NULL。在这个例子中我们不必检查它的返回值，如果NewStringUTF创建java.lang.String失败，OutOfMemoryError这个异常会被在Sample.main方法中抛出。如果NewStringUTF创建java.lang.String成功，则返回一个JNI引用，这个引用指向新创建的java.lang.String对象。