Android NDK開發之旅11 JNI JNI資料型別與方法屬性訪問

###JNI資料型別

#####JNI的資料型別包含兩種: 基本型別和引用型別

####基本型別 基本型別主要有jboolean, jchar, jint等, 它們和Java中的資料型別對應關係如下表所示:

Java型別	JNI型別	描述
boolean	jboolean	無符號8位整型
byte	byte	無符號8位整型
char	jchar	無符號16位整型
short	jshort	有符號16位整型
int	jint	32位整型
long	jlong	64位整型
float	jfloat	32位浮點型
double	jdouble	64位浮點型
void	void	無型別

####引用型別(物件) JNI中的引用型別主要有類, 物件和陣列. 它們和Java中的引用型別的對應關係如下表所示:

Java型別	JNI型別	描述
Object	jobject	Object型別
Class	jclass	Class型別
String	jstring	String型別
Object[]	jobjectArray	物件陣列
boolean[]	jbooleanArray	boolean陣列
byte[]	jbyteArray	byte陣列
char[]	jcharArray	char陣列
short[]	jshortArray	short陣列
int[]	jintArray	int陣列
long[]	jlongArray	long陣列
float[]	jfloatArray	float陣列
double[]	jdoubleArray	double陣列
Throwable	jthrowable	Throwable

####native函式引數說明

每個native函式，都至少有兩個引數（JNIEnv*,jclass或者jobject)。

1）當native方法為靜態方法時： jclass 代表native方法所屬類的class物件(JniTest.class)。

2）當native方法為非靜態方法時： jobject 代表native方法所屬的物件。

native函式的標頭檔案可以自己寫。

####關於屬性與方法的簽名

資料型別	簽名
boolean	Z
byte	B
char	C
short	S
int	I
long	J
float	F
double	D
ully-qualified-class	Lfully-qualified-class;
type[]	[type
method type	(arg-types)ret-type

#####注意：

• 類描述符開頭的 'L' 與結尾的 ';' 必須要有

• 陣列描述符,開頭的 '[' 必須要有

• 方法描述符規則: "(各引數描述符)返回值描述符",其中引數描述符間沒有任何分隔符號

從上表可以看出, 基本資料型別的簽名基本都是單詞的首字母大寫, 但是boolean和long除外因為B已經被byte佔用, 而long也被Java類簽名的佔用.

物件和陣列的簽名稍微複雜一些.

物件的簽名就是物件所屬的類簽名, 比如String物件, 它的簽名為Ljava/lang/String; .

陣列的簽名為[+型別簽名, 例如byte陣列. 其型別為byte, 而byte的簽名為B, 所以byte陣列的簽名就是[B.同理可以得到如下的簽名對應關係:

char[]      [C
float[]     [F
double[]    [D
long[]      [J
String[]    [Ljava/lang/String;
Object[]    [Ljava/lang/Object;
複製程式碼

方法簽名具體方法： 獲取方法的簽名比較麻煩一些，通過下面的方法也可以拿到屬性的簽名。 開啟命令列，輸入javap，出現以下資訊：

上述資訊告訴我們，通過以下命令就可以拿到指定類的所有屬性、方法的簽名了，很方便有木有？！

javap -s -p 完整類名
複製程式碼

我們通過cd命令，來到編譯生成的class位元組碼檔案目錄（注意：非src目錄。 eclipse 編譯生成的class位元組碼檔案在bin資料夾中， 而用idea編譯器 編譯生成的class位元組碼檔案在out\production下），然後輸入命令：

D:\IdeaProjects\jni1\out\production\jni1>javap -s -p com.haocai.jni.JniTest 
複製程式碼

得到以下資訊：

Compiled from "JniTest.java"
public class com.haocai.jni.JniTest {
  public java.lang.String key;
    descriptor: Ljava/lang/String;
  public static int count;
    descriptor: I
  public com.haocai.jni.JniTest();
    descriptor: ()V

  public static native java.lang.String getStringFromC();
    descriptor: ()Ljava/lang/String;

  public native java.lang.String getString2FromC(int);
    descriptor: (I)Ljava/lang/String;

  public native java.lang.String accessField();
    descriptor: ()Ljava/lang/String;

  public native void accessStaticField();
    descriptor: ()V

  public native void accessMethod();
    descriptor: ()V

  public native void accessStaticMethod();
    descriptor: ()V

  public static void main(java.lang.String[]);
    descriptor: ([Ljava/lang/String;)V

  public int genRandomInt(int);
    descriptor: (I)I

  public static java.lang.String getUUID();
    descriptor: ()Ljava/lang/String;

  static {};
    descriptor: ()V
}
複製程式碼

#####其中，descriptor：對應的值就是我們需要的簽名了，注意簽名中末尾的分號 ";" 不能省略。

###C/C++訪問Java的屬性、方法

在JNI呼叫中，肯定會涉及到本地方法操作Java類中資料和方法。在Java1.0中“原始的”Java到C的繫結中，程式設計師可以直接訪問物件資料域。然而，直接方法要求虛擬機器暴露他們的內部資料佈局，基於這個原因，JNI要求程式設計師通過特殊的JNI函式來獲取和設定資料以及呼叫java方法。

######有以下幾種情況：

1.訪問Java類的非靜態屬性。 2.訪問Java類的靜態屬性。 3.訪問Java類的非靜態方法。 4.訪問Java類的靜態方法。 5.間接訪問Java類的父類的方法。 6.訪問Java類的構造方法。

####一、訪問Java的非靜態屬性 Java宣告如下：

 public String name = "kpioneer";

//訪問非靜態屬性name，修改它的值 
//accessField 自定義的一個方法
public native void accessField();
複製程式碼

C程式碼如下：

//把java中的變數name中值kpioneer 變為kpioneer Goodman
JNIEXPORT jstring JNICALL Java_com_haocai_jni_JniTest_accessField
(JNIEnv *env, jobject jobject) {
	//Jclass 
	//jobj是t物件
	jclass cls = (*env)->GetObjectClass(env, jobject);
	//jfieldID
	//屬性名稱，屬性簽名
	jfieldID fid = (*env)->GetFieldID(env, cls, "name", "Ljava/lang/String;");


	//類似於反射
	//拿到jniTest(jobject) 中name的值
	/*
	Get<Type>Field：
	GetFloatField
	GetIntField
	GetLongField
	...
	*/
	jstring jstr = (*env)->GetObjectField(env, jobject, fid);
	printf("jstr:%#x\n", &jstr);
	//printf("jstr:%#x\n", &jstr);
	//jstring -> C 字串

	boolean isCopy =NULL;
	//函式內部複製了，isCopy 為JNI_TRUE,沒有複製JNI_FALSE
	char *c_str = (*env)->GetStringUTFChars(env, jstr, &isCopy );
	//意義：isCopy為JNI_FALSE,c_str和jstr都指向同一個字串，不能修改java字串

	char text[20] = " Goodman";
	strcat(c_str, text);//拼接函式

	//再把C字串 ->jstring
	jstring new_str = (*env)->NewStringUTF(env, c_str);
	printf("jstr:%#x\n", &new_str);
	//修改name
	/*
	Set<Type>Field：
	SetFloatField
	SetIntField
	SetLongField
	...
	*/
	(*env)->SetObjectField(env, jobject, fid, new_str);

	//最後釋放資源，通知垃圾回收器來回收
	//良好的習慣就是，每次GetStringUTFChars，結束的時候都有一個ReleaseStringUTFChars與之呼應
	(*env)->ReleaseStringUTFChars(env, jstr, c_str);
	return new_str;
}
複製程式碼

最後在Java中測試：

public static void main(String[] args) {
        JniTest jniTest = new JniTest();
        System.out.println("name修改前："+jniTest.name);
        jniTest.accessField();
        System.out.println("name修改後："+jniTest.name);
}

結果輸出：
name修改前：kpioneer
name修改後：kpioneer Goodman
jstr:0x27cf238  //呼叫的C也列印輸出
jstr:0x27cf2a8  
複製程式碼

####二、訪問Java的靜態屬性 Java宣告如下：

public static int count = 9;
public native void accessStaticField();
複製程式碼

C程式碼如下：

//訪問靜態屬性
JNIEXPORT void JNICALL Java_com_haocai_jni_JniTest_accessStaticField
(JNIEnv *env, jobject jobj) {
	//jclass
	jclass cls = (*env)->GetObjectClass(env, jobj);
	//jfieldID
	jfieldID fid =(*env)->GetStaticFieldID(env, cls, "count", "I");
	//GetStatic<Type>Field
	jint count = (*env)->GetStaticIntField(env, cls, fid);
	count++;
	//修改
	//SetStatic<Type>Field
	(*env)->SetStaticIntField(env, cls, fid, count);
}
複製程式碼

最後在Java中測試：

public static void main(String[] args) {
    JniTest jniTest= new JniTest();
    System.out.println("count修改前："+count);
    jniTest.accessStaticField();
    System.out.println("count修改後："+count);
}

結果輸出：
count修改前：9
count修改後：10
複製程式碼

####三、訪問Java的非靜態方法 Java宣告如下：

    //產生指定範圍的隨機數
    public int genRandomInt(int max){
        System.out.println("genRandomInt 執行了..");
        return new Random().nextInt(max);
    }
複製程式碼

C程式碼如下：

JNIEXPORT void JNICALL Java_com_haocai_jni_JniTest_accessMethod
(JNIEnv *env, jobject jobj) {

	//Jclass
	jclass cls = (*env)->GetObjectClass(env, jobj);
	//JmethodID
	jfieldID mFid = (*env)->GetMethodID(env, cls, "genRandomInt", "(I)I");
	//呼叫
	//Call<Type>Method
	jint random = (*env)->CallIntMethod(env, jobj, mFid, 200);
	printf("random num:%ld",random);

}
複製程式碼

最後在Java中測試：

public static void main(String[] args) {
    JniTest jniTest= new JniTest();
    jniTest.accessMethod();
}
結果輸出：
genRandomInt 執行了..

random num:109
複製程式碼

####四、訪問Java的靜態方法 Java宣告如下：

    public static  String getUUID(){
      return  UUID.randomUUID().toString();
    }
複製程式碼

C程式碼如下：

//訪問Java靜態方法
JNIEXPORT void JNICALL Java_com_haocai_jni_JniTest_accessStaticMethod
(JNIEnv *env, jobject jobj) {

	//Jclass
	jclass cls = (*env)->GetObjectClass(env, jobj);
	//JmethodID
	jfieldID mFid = (*env)->GetStaticMethodID(env, cls, "getUUID", "()Ljava/lang/String;");

	//呼叫
	//CallStatic<Type>Method
	jstring uuid = (*env)->CallStaticObjectMethod(env, jobj, mFid);
	
	//隨機檔名稱 uuid.txt
	//jstring -> char*
	//isCopy JNI_FALSE,代表java和c操作的是同一個字串
	char *uuid_str = (*env)->GetStringUTFChars(env, uuid, NULL);
	//拼接
	char filename[100];
	sprintf(filename, "D://%s.txt", uuid_str);
	FILE *fp = fopen(filename, "w");
	fputs("i love kpioneer", fp);
	fclose(fp);


}
複製程式碼

最後在Java中測試：

public static void main(String[] args) {
        JniTest jniTest = new JniTest();

        jniTest.accessStaticMethod();.
}
複製程式碼

######最終在D盤目錄下生成名為2fbf3e41-741b-4899-8e4e-a6a80a23a0b2（UUID隨機生成） 的txt檔案

####五、訪問Java類的構造方法 Java宣告如下：

    public native long accessConstructor();
複製程式碼

C程式碼如下：

//訪問Java類的構造方法
//使用java.util.Date產生一個當前的事件戳
JNIEXPORT jlong  JNICALL Java_com_haocai_jni_JniTest_accesssConstructor
(JNIEnv *env, jobject jobj) {

	jclass cls = (*env)->FindClass(env, "java/util/Date");
	//jmethodID
	jmethodID  constructor_mid= (*env)->GetMethodID(env, cls,"<init>","()V");
	//例項化一個Date物件(可以在constructor_mid後加參)
	jobject date_obj =  (*env)->NewObject(env, cls, constructor_mid);
	//呼叫getTime方法
	jmethodID mid = (*env)->GetMethodID(env, cls, "getTime", "()J");
	jlong time = (*env)->CallLongMethod(env, date_obj, mid);

	printf("time:%lld\n",time);

	return time;

}
複製程式碼

最後在Java中測試：

public static void main(String[] args) {

        JniTest test = new JniTest();
        //直接在Java中構造Date然後呼叫getTime
        Date date = new Date();
        System.out.println(date.getTime());
        //通過C語音構造Date然後呼叫getTime
        long time = jniTest.accessConstructor();
        System.out.println(time);
}


結果輸出：
1509688828013
1509688828013

time:1509688828013
複製程式碼

####六、間接訪問Java類的父類的方法 Java程式碼如下： 父類：

public class Human {
    public void sayHi(){
        System.out.println("人類打招乎(父類)");
    }
}
複製程式碼

子類：

public class Man extends Human {
    @Override
    public void sayHi() {
        System.out.println("男人打招乎");
    }
}
複製程式碼

在TestJni類中有Human方法宣告：

    public Human human = new Man();

    public native void accessNonvirtualMethod();
複製程式碼

如果是直接使用human .sayHi()的話，其實訪問的是子類Man的方法 但是通過底層C的方式可以間接訪問到父類Human的方法，跳過子類的實現，甚至你可以直接哪個父類（如果父類有多個的話），這是Java做不到的。

下面是C程式碼實現，無非就是屬性和方法的訪問：

//呼叫父類的方法
JNIEXPORT void JNICALL Java_com_haocai_jni_JniTest_accessNonvirtualMethod
(JNIEnv *env, jobject jobj) {

	jclass cls = (*env)->GetObjectClass(env, jobj);

	//獲取man屬性(物件)
	jfieldID fid = (*env)->GetFieldID(env, cls, "human", "Lcom/haocai/jni/Human;");
	//獲取
	jobject human_obj = (*env)->GetObjectField(env, jobj, fid);

	//執行sayHi方法
	jclass human_cls = (*env)->FindClass(env, "com/haocai/jni/Human");
	jmethodID mid = (*env)->GetMethodID(env, human_cls, "sayHi", "()V");
	
	//執行Java相關的子類方法
	(*env)->CallObjectMethod(env, human_obj, mid);

	//執行Java相關的父類方法
	(*env)->CallNonvirtualObjectMethod(env, human_obj, human_cls, mid);

}

複製程式碼

1.當有這個類的物件的時候，使用(*env)->GetObjectClass()，相當於Java中的test.getClass() 2.當有沒有這個類的物件的時候，(*env)->FindClass()，相當於Java中的Class.forName("com.test.TestJni") 這裡直接使用CallVoidMethod，雖然傳進去的是父類的Method ID，但是訪問的讓然是子類的實現。

最後，通過CallNonvirtualVoidMethod，訪問不覆蓋的父類方法（C++使用virtual關鍵字來覆蓋父類的實現），當然你也可以指定哪個父類（如果有多個父類的話）。

最後在Java中測試：

    public static void main(String[] args) {
        JniTest jniTest = new JniTest();
        jniTest.human.sayHi();
        jniTest.accessNonvirtualMethod();

    }

結果輸出：
男人打招乎
男人打招乎  
人類打招乎(父類) 
複製程式碼

####實際案例---用JNI方法和屬性訪問解決中文編碼亂碼問題 中文亂碼

	char *cOutStr = "李四";
	string jstr = (*env)->NewStringUTF(env, cOutStr);
	return jstr; 直接返回會有中文亂碼問題
複製程式碼

######原因分析，呼叫NewStringUTF的時候，產生的是UTF-16的字串，但是我們需要的時候UTF-8字串。

#####如果使用C語言方法解決中文編碼問題，程式碼行數多（幾百行+），且容易產生問題。所以直接通過Java 中的String(byte bytes[],String charsetName)構造方法來進行字符集變換，解決該問題。

Java宣告如下：

  public native String chineseChars(String str);
複製程式碼

C程式碼如下：

JNIEXPORT jstring JNICALL Java_com_haocai_jni_JniTest_chineseChars
(JNIEnv *env, jobject jobj,jstring in) {

//輸出
	char *cStr = (*env)->GetStringUTFChars(env, in, JNI_FALSE);
	printf("C %s\n", cStr);


	//c -> jstring
	char *cOutStr = "李四";
	//jstring jstr = (*env)->NewStringUTF(env, cOutStr);
	//return jstr; 直接返回會有中文亂碼問題

	//解決中文亂碼問題
	//執行java 中String(byte bytes[],String charsetName);
	//1.jmethodID
	//2.byte陣列
	//3.字元編碼

	jstring str_cls = (*env)->FindClass(env, "java/lang/String");
	//構造方法用<init>
	jmethodID construvtor_mid =  (*env)->GetMethodID(env, str_cls, "<init>", "([BLjava/lang/String;)V");

	//jbyte-> char
	//jbyteArray -> char[]
	jbyteArray bytes = (*env)->NewByteArray(env, strlen(cOutStr));
	//byte陣列賦值
	//從0到strlen(cOutStr)，從頭到尾
	(*env)->SetByteArrayRegion(env,bytes,0,strlen(cOutStr), cOutStr);

	//字元編碼jstring
	jstring charsetName = (*env)->NewStringUTF(env, "GB2312");

	//呼叫建構函式，返回編碼之後的jstring


	return (*env)->NewObject(env,str_cls, construvtor_mid,bytes, charsetName);

}
複製程式碼

最後在Java中測試：

    public static void main(String[] args) {
       JniTest jniTest = new JniTest();
       String outStr = jniTest.chineseChars("張三");
       System.out.println("中文輸出："+outStr);
    }

結果輸出：
中文輸出：李四

C 張三
複製程式碼

####總結

• #####1.C/C++完成的功能並不是所有程式碼一定要C/C++語句寫，有時候C/C++可以呼叫現成的Java方法或屬性解決問題，能起到事半功倍的作用。
• #####2.屬性、方法的訪問的使用是和Java的反射相類似。

特別感謝： 動腦學院Jason