使用C/C++实现Java的Native方法接口（JNI）（5）jstring类和jobject类的等对象数据的方法

JNI编程(C/C++)

第1节：快速上手

一个简单的demo，快速跑通流程，详见使用C/C++实现Java的Native方法接口（JNI）（1）快速上手

第2节：实例详解（C语言版本）

本节针对第1节中的内例子详细说明（C），详见使用C/C++实现Java的Native方法接口（JNI）（2）实例详解（C语言版本）

第3节：实例详解（C++语言版本）

本节针对第1节中的内例子详细说明（C++），详见使用C/C++实现Java的Native方法接口（JNI）（3）实例详解（C++语言版本）

第4节：JNI数据类型

本节介绍了JNI中定义的部分数据类型，详见使用C/C++实现Java的Native方法接口（JNI）（4）JNI数据类型

第5节：jstring类和jobject类的等对象数据的方法

本节详细描述了JNI中最常用的jstring（java.lang.String）和jobject （Obejct）的相关操作方法

jstring类型相关方法

// 普通字符串方法
jstring (JNICALL *NewString) (JNIEnv *env, const jchar *unicode, jsize len);
jsize (JNICALL *GetStringLength) (JNIEnv *env, jstring str);
const jchar *(JNICALL *GetStringChars) (JNIEnv *env, jstring str, jboolean *isCopy);
void (JNICALL *ReleaseStringChars) (JNIEnv *env, jstring str, const jchar *chars);
// UTF字符串方法，一般选用这种
jstring (JNICALL *NewStringUTF) (JNIEnv *env, const char *utf);
jsize (JNICALL *GetStringUTFLength) (JNIEnv *env, jstring str);
const char* (JNICALL *GetStringUTFChars) (JNIEnv *env, jstring str, jboolean *isCopy);
void (JNICALL *ReleaseStringUTFChars) (JNIEnv *env, jstring str, const char* chars);

下面主要说明UTF字符串相关方法：

• NewStringUTF 输入环境和C的char* 字符串，在JVM中创建一个java.lang.String对象，如果成功，返回jstring对象引用，否则返回NULL
• GetStringUTFLength 输入环境和jstring对象引用，获得这个java.lang.String的长度
• GetStringUTFChars 输入环境和jstring对象引用，将其转换为C的char*字符串，isCopy参数代表是否返回拷贝值（当isCopy为真时，表示返回JVM内部源字符串的一份拷贝，并为新产生的字符串分配内存空间；当isCopy为假的时候，返回JVM内部源字符串的指针，不会生成新的字符串对象，修改会直接在原来的字符串上完成，但是并不推荐这样做，因为Java的机制中字符串池中的字符串是不能更改的；此外，JNI中带有JNI_TRUE和JNI_FALSE用于初始化jboolean，isCopy可以传入jboolean引用）
• ReleaseStringUTFChars 通知JVM输入参数的中的字符串的内存已经不使用了，参数对应与调用GetStringUTFChars方法的输入char*和输出jstring

注意，每一个GetStringUTFChars必须有一个对应的ReleaseStringUTFChars做内存回收。

注意2，上述列举显示的是C的调用方法，C++内同名方法则没有第一个env参数（因为是通过对象方法直接调用），本节和下节内的列举都是C方法，但最后的代码实例中使用的C++实现。

jobject类型相关方法

FindClass

输入一个类的名字，返回该类对应的jclass指针；类的名字使用“/”替换java里的“.”

jclass (JNICALL *FindClass) (JNIEnv *env, const char *name);
// example: 
// jclass array_list_class = env->FindClass("java/lang/Math");

GetObjectClass

输入一个jobject，获得它的类型

jclass (JNICALL *GetObjectClass) (JNIEnv *env, jobject obj);
// example:
// jclass input_class = env->GetObjectClass(input_obj);

Get{/Static}FieldID

获得对象字段/获得类的静态字段的ID号码，这个ID号码用于之后Get/Set字段的操作

jfieldID (JNICALL *GetFieldID) 
(JNIEnv *env, jclass clazz, const char *name, const char *sig);
// example:
// jfieldID amount_field = env->GetFieldID(input_class, "amount", "I"); 

jfieldID (JNICALL *GetStaticFieldID)
(JNIEnv *env, jclass clazz, const char *name, const char *sig);
// example:
// jfieldID static_str_field = env->GetStaticFieldID(input_class, "staticString", "Ljava/lang/String;"); 

注意到传入的参数不仅有类jclass、变量名，还有一个类型签名，这个类型签名用于说明这个变量的类型，类型签名对照表如下：

Field Type	Signature
boolean	Z
byte	B
char	C
shrot	S
int	I
long	J
float	F
double	D
void	V
Object	字母L后接用“/”分割的完整类名再加上字符“;”，例如“Ljava/lang/String;”
Array	字符[后接其他类型的签名，例如“[I” 、“[Ljava/lang/String;“

Get{/Static}{FIELDTYPE}Field

// {FIELDTYPE}代表字段数据类型

// Get{FIELDTYPE}Field系列的函数输入都是jobect和fieldID(使用GetFieldID函数得到的字段ID)
// 返回该对象的对应字段值

jobject GetObjectField(jobject obj, jfieldID fieldID);
jboolean GetBooleanField(jobject obj, jfieldID fieldID);
jbyte GetByteField(jobject obj, jfieldID fieldID);
jchar GetCharField(jobject obj, jfieldID fieldID);
jshort GetShortField(jobject obj, jfieldID fieldID);
jint GetIntField(jobject obj, jfieldID fieldID);
jlong GetLongField(jobject obj, jfieldID fieldID);
jfloat GetFloatField(jobject obj, jfieldID fieldID);
jdouble GetDoubleField(jobject obj, jfieldID fieldID);

// GetStatic{FIELDTYPE}Field系列的函数输入都是jclass和fieldID(使用GetStaticFieldID函数得到的字段ID)
// 由于是获取的类的静态字段，所以输入是jclass而不是jobject
// 返回该类的静态字段值

jobject GetStaticObjectField(jclass clazz, jfieldID fieldID);
jboolean GetStaticBooleanField(jclass clazz, jfieldID fieldID);
jbyte GetStaticByteField(jclass clazz, jfieldID fieldID);
jchar GetStaticCharField(jclass clazz, jfieldID fieldID);
jshort GetStaticShortField(jclass clazz, jfieldID fieldID);
jint GetStaticIntField(jclass clazz, jfieldID fieldID);
jlong GetStaticLongField(jclass clazz, jfieldID fieldID);
jfloat GetStaticFloatField(jclass clazz, jfieldID fieldID);
jdouble GetStaticDoubleField(jclass clazz, jfieldID fieldID);

Set{/Static}{FIELDTYPE}Field

// Set{FIELDTYPE}Field系列的函数输入都是jobect、fieldID(使用GetFieldID函数得到的字段ID)和赋予的新值
    void (JNICALL *SetObjectField)
      (JNIEnv *env, jobject obj, jfieldID fieldID, jobject val);
    void (JNICALL *SetBooleanField)
      (JNIEnv *env, jobject obj, jfieldID fieldID, jboolean val);
    void (JNICALL *SetByteField)
      (JNIEnv *env, jobject obj, jfieldID fieldID, jbyte val);
    void (JNICALL *SetCharField)
      (JNIEnv *env, jobject obj, jfieldID fieldID, jchar val);
    void (JNICALL *SetShortField)
      (JNIEnv *env, jobject obj, jfieldID fieldID, jshort val);
    void (JNICALL *SetIntField)
      (JNIEnv *env, jobject obj, jfieldID fieldID, jint val);
    void (JNICALL *SetLongField)
      (JNIEnv *env, jobject obj, jfieldID fieldID, jlong val);
    void (JNICALL *SetFloatField)
      (JNIEnv *env, jobject obj, jfieldID fieldID, jfloat val);
    void (JNICALL *SetDoubleField)
      (JNIEnv *env, jobject obj, jfieldID fieldID, jdouble val);

// SetStatic{FIELDTYPE}Field系列的函数输入都是jclass、fieldID(使用GetStaticFieldID函数得到的字段ID)和赋予的新值
// 由于是set的是类的静态字段，所以输入是jclass而不是jobject
    void (JNICALL *SetStaticObjectField)
      (JNIEnv *env, jclass clazz, jfieldID fieldID, jobject value);
    void (JNICALL *SetStaticBooleanField)
      (JNIEnv *env, jclass clazz, jfieldID fieldID, jboolean value);
    void (JNICALL *SetStaticByteField)
      (JNIEnv *env, jclass clazz, jfieldID fieldID, jbyte value);
    void (JNICALL *SetStaticCharField)
      (JNIEnv *env, jclass clazz, jfieldID fieldID, jchar value);
    void (JNICALL *SetStaticShortField)
      (JNIEnv *env, jclass clazz, jfieldID fieldID, jshort value);
    void (JNICALL *SetStaticIntField)
      (JNIEnv *env, jclass clazz, jfieldID fieldID, jint value);
    void (JNICALL *SetStaticLongField)
      (JNIEnv *env, jclass clazz, jfieldID fieldID, jlong value);
    void (JNICALL *SetStaticFloatField)
      (JNIEnv *env, jclass clazz, jfieldID fieldID, jfloat value);
    void (JNICALL *SetStaticDoubleField)
      (JNIEnv *env, jclass clazz, jfieldID fieldID, jdouble value);

Get{/Static}MethodID

获得对象方法/类静态方法的ID号码，这个ID号码用于之后Call操作

jmethodID GetMethodID(jclass clazz, const char *name, const char *sig);
// example:
// jmethodID object_method = env->GetMethodID(input_class, "someMethod", "(Ljava/lang/String;IZD)V")

jmethodID GetStaticMethodID(jclass clazz, const char *name, const char *sig);
// example:
// jmethodID static_class_method = env->GetMethodID(input_class, "someStaticMethod", "(IFJ)V")

输入参数为jclass、方法名字和方法签名；方法的签名包含其输入输出的数据类型

方法签名格式："(输入类型签名列表)输出类型签名"

// examples:

"()V"
// 代表是一个无参、返回为void的函数

"(ZSIJ)F"
// 代表输入参数有四个，类型依次为(boolean, short, int, long)，输出参数类型为float


"(Ljava/util/ArrayList;II)Ljava/lang/String;"
// 代表输入参数有三个，类型依次为(ArraList, int, int)，输出参数类型为String
// 注意L+包名后的分号";"一定要带上

一般成员方法名字都是字面的方法名字，初始化函数固定为"<init>"

Call{/Static}{RETTYPE}Method{/V/A}

// {RETTYPE}部分和之前的{FIELDTYPE}同样地，可以使用数据类型进行替换，此处的{RETTYPE}类型代表函数的返回类型
// {/V/A}代表函数的输入参数类型，不写代表直接正常传入"..."可变参数，V代表va_list，A代表const jvalue *

// 此处以{RETTYPE}=Object为例，列举Call{/Static}Void{/V/A}的6个方法
jobject (JNICALL *CallObjectMethod) (JNIEnv *env, jobject obj, jmethodID methodID, ...);
jobject (JNICALL *CallObjectMethodV) (JNIEnv *env, jobject obj, jmethodID methodID, va_list args);
jobject (JNICALL *CallObjectMethodA) (JNIEnv *env, jobject obj, jmethodID methodID, const jvalue * args);
jobject (JNICALL *CallStaticObjectMethod) (JNIEnv *env, jclass clazz, jmethodID methodID, ...);
jobject (JNICALL *CallStaticObjectMethodV) (JNIEnv *env, jclass clazz, jmethodID methodID, va_list args);
jobject (JNICALL *CallStaticObjectMethodA) (JNIEnv *env, jclass clazz, jmethodID methodID, const jvalue *args);

第6节：多种JNI数据类型的代码实例

本节结合前面1-5节的内容，编写了一个包含多种数据类型的实例JNI-C++代码，详见使用C/C++实现Java的Native方法接口（JNI）（6）多种JNI数据类型代码实例

附录：代码

整个项目的资源打包链接：JNI_C/C++_Demo