Android JNI開發詳解(3)-JavaVM和JNIEnv

原文出處：http://www.ccbu.cc/index.php/android/android-jni-jnivm-jnienv.html

JavaVM 和 JNIEnv

JNI 定義了兩個關鍵數據結構，即JavaVM和JNIEnv。兩者本質上都是指向函數表的二級指針。在 C++ 版本中，它們是一些類，這些類具有指向函數表的指針，並具有每個通過該函數表間接調用的 JNI 函數的成員函數。

1. JavaVM

JavaVM是虛擬機在JNI中的表示，一個JVM中只有一個JavaVM對象，這個對象是線程共享的。

通過JNIEnv我們可以獲取一個Java虛擬機對象，其函數如下：

/**
 * 獲取Java虛擬機對象
 * @param env JNIEnv對象
 * @param vm 用來存放獲得的虛擬機的指針的指針
 * @return 成功返回0，失敗返回其他
 */
jint GetJavaVM(JNIEnv *env, JavaVM **vm);

在加載動態鏈接庫的時候，JVM會調用JNI_OnLoad(JavaVM* jvm, void* reserved)（如果定義了該函數），第一個參數會傳入JavaVM指針。可以在該函數中保存JavaVM指針來供全局使用。

JavaVM *javaVM = NULL;

jint JNI_OnLoad(JavaVM *vm, void *reserved) {
    javaVM = vm;
    ...
}

2. JNIEnv

JNIEnv類型是一個指向全部JNI方法的指針，JNIEnv 提供了大部分 JNI 函數。JNIEnv只在創建它的線程有效，不能跨線程傳遞，不能再線程之間共享 JNIEnv。

所有的本地接口函數都會以 JNIEnv 作爲第一個參數。不管是靜態註冊的本地C/C++函數接口，還是動態註冊的本地函數接口，函數的第一個參數都是JNIEnv。

靜態註冊的函數實例

JNIEXPORT jstring JNICALL Java_cc_ccbu_jnitest_Test_textFromJni
  (JNIEnv *, jobject) {
    return env->NewStringUTF("text from jni");
}

動態註冊的函數實例

jstring textFromJni(JNIEnv* env, jobject thiz) {
    return env->NewStringUTF("text from jni");
}

static JNINativeMethod gMethods[] = {
        {"textFromJni", "()Ljava/lang/String;", (void*)textFromJni}
};

int registerMethod(JNIEnv *env) {
    jclass test = env->FindClass("cc/ccbu/jnitest/Test");
    return env->RegisterNatives(test, gMethods, sizeof(gMethods)/ sizeof(gMethods[0]));
}

如果一段代碼無法通過其他方法獲取自己的 JNIEnv，可以通過全局有效的 JavaVM，然後使用 GetEnv 來獲取當前線程的 JNIEnv（如果該線程包含一個 JNIEnv）。

JNIEnv* env = NULL;
if (javaVM->GetEnv((void**) &env, JNI_VERSION_1_6) != JNI_OK) {
	return JNI_ERR;
}

GetEnv函數定義如下：

/**
 * 獲取當前線程JNIEnv
 * @param env 用來存放獲取JNIEnv對象的指針的指針
 * @param version JNI版本
 * @return 成功返回0，失敗返回其他
 */
jint GetEnv(void** env, jint version)

對於本地庫中創建的線程，需要使用AttachCurrentThread來附加到 JavaVM來獲取一個可用的JNIEnv。線程退出或不再需要使用JNIEnv時，必須通過調用DetachCurrentThread來解除連接。具體的會在線程篇進行詳細說明。

3. 兩種代碼格式

JavaVM 和 JNIEnv 在 C 語言環境下和 C++ 環境下調用是有區別的，以NewStringUTF函數爲例：’

C語言調用格式爲：

(*env)->NewStringUTF(env, “Hellow World!”);

C++調用格式爲：

env->NewStringUTF(“Hellow World!”);

建議使用 C++ 格式，這也是大部分代碼使用的形式。但C++ 格式其實只是封裝了 C 格式，使得調用更加簡介方便。

4.具體定義

JavaVM 和 JNIEnv 在 <jni.h> 中的定義如下

#if defined(__cplusplus)
typedef _JNIEnv JNIEnv;
typedef _JavaVM JavaVM;
#else
typedef const struct JNINativeInterface* JNIEnv;
typedef const struct JNIInvokeInterface* JavaVM;
#endif

這裏分了 C 和 C++。如果是 C++ 環境下，JNIEnv 和 JavaVM則只是對 _JNIEnv 和 _JavaVM 的一個重命名；如果是 C 環境下，則是指向 JNINativeInterface 結構體和 JNIInvokeInterface 結構體的指針。JNINativeInterface 和 JNIInvokeInterface的具體定義如下：

struct JNINativeInterface {
    void*       reserved0;
    void*       reserved1;
    void*       reserved2;
    void*       reserved3;

    jint        (*GetVersion)(JNIEnv *);

    jclass      (*DefineClass)(JNIEnv*, const char*, jobject, const jbyte*,
                        jsize);
    jclass      (*FindClass)(JNIEnv*, const char*);
    
    ... //此次省略大量函數指針定義
    
}

struct JNIInvokeInterface {
    void*       reserved0;
    void*       reserved1;
    void*       reserved2;

    jint        (*DestroyJavaVM)(JavaVM*);
    jint        (*AttachCurrentThread)(JavaVM*, JNIEnv**, void*);
    jint        (*DetachCurrentThread)(JavaVM*);
    jint        (*GetEnv)(JavaVM*, void**, jint);
    jint        (*AttachCurrentThreadAsDaemon)(JavaVM*, JNIEnv**, void*);
};

JNINativeInterface包含了很多的函數指針，JNI中常用的函數基本都在這個結構體中進行了定義。JNIInvokeInterface相對比較簡單。C++環境下的封裝_JNIEnv 和 _JavaVM具體定義如下：

struct _JNIEnv {
    /* do not rename this; it does not seem to be entirely opaque */
    const struct JNINativeInterface* functions;

#if defined(__cplusplus)

    jint GetVersion()
    { return functions->GetVersion(this); }

    jclass DefineClass(const char *name, jobject loader, const jbyte* buf,
        jsize bufLen)
    { return functions->DefineClass(this, name, loader, buf, bufLen); }

    jclass FindClass(const char* name)
    { return functions->FindClass(this, name); }
    
    ...//此次省略大量函數定義
    
#endif /*__cplusplus*/
};

struct _JavaVM {
    const struct JNIInvokeInterface* functions;

#if defined(__cplusplus)
    jint DestroyJavaVM()
    { return functions->DestroyJavaVM(this); }
    jint AttachCurrentThread(JNIEnv** p_env, void* thr_args)
    { return functions->AttachCurrentThread(this, p_env, thr_args); }
    jint DetachCurrentThread()
    { return functions->DetachCurrentThread(this); }
    jint GetEnv(void** env, jint version)
    { return functions->GetEnv(this, env, version); }
    jint AttachCurrentThreadAsDaemon(JNIEnv** p_env, void* thr_args)
    { return functions->AttachCurrentThreadAsDaemon(this, p_env, thr_args); }
#endif /*__cplusplus*/
};

由此可見，C++環境下只是對C語言環境下的結構體進行了簡單的封裝，使的調用習慣符合C++的調用風格。但由於C和C++環境下代碼格式不一樣，具體是哪種格式取決於引用的文件是C文件還是C++文件。