JavaVM 和 JNIEnv

初學(xué)者材泄,尤其是缺少C++開發(fā)經(jīng)驗(yàn)的初學(xué)者,經(jīng)常會對以下兩種寫法感到困惑:
NewStringUTF(env, "Hello from C++");
env->NewStringUTF("Hello from C++");
實(shí)際上吨岭,JNI的頭文件jni.h中同時(shí)聲明了C與C++兩種接口拉宗,通過#ifdef __cplusplus宏指令進(jìn)行區(qū)分。
如果你的工程沒有強(qiáng)制要求必須使用純C代碼辣辫,推薦使用C++實(shí)現(xiàn)旦事。

JNI 定義了兩個關(guān)鍵數(shù)據(jù)結(jié)構(gòu),即“JavaVM”和“JNIEnv”急灭。理論上在Java中每個進(jìn)程可以有多個 JavaVM姐浮,但 Android 只允許有一個

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

JNIEnv 提供了大部分 JNI 函數(shù)葬馋。每個線程都有獨(dú)立的JNIEnv卖鲤,通過“線程局部存儲”(ThreadLocal)存儲在線程對象上肾扰。因此無法在線程之間共享 JNIEnv。

線程

Java創(chuàng)建的線程自帶JNIEnv蛋逾,通過JavaVM的GetEnv方法可以直接獲取到對應(yīng)的JNIEnv指針集晚。而非Java線程則沒有JNIEnv,需要使用JavaVM的AttachCurrentThread附加JNIEnv区匣。以下是一個比較詳細(xì)的示例偷拔,使用pthread_create創(chuàng)建了一個pthread線程,然后在Run方法中反射調(diào)用Java的invokeFromJNI方法:

#include <jni.h>
#include <string>
#include <pthread.h>
#include <android/log.h>
#include "scoped_local_ref.h"

JavaVM* gJavaVM = NULL; // JavaVM 全局指針
jclass gClassMainActivity = NULL; //GlobalRef的jclass

/*
    // 要反射調(diào)用的Java方法
    public void invokeFromJNI(final String args) {

        mTextView.post(new Runnable() {
            @Override
            public void run() {
                mTextView.setText(args);
            }
        });
    }
 */

/**
 * pthread線程的Run方法
 */
void *Run(void *arg) {
    JNIEnv* env = NULL;
    if (gJavaVM->GetEnv(reinterpret_cast<void**>(&env), JNI_VERSION_1_6) != JNI_OK) {
        gJavaVM->AttachCurrentThread(&env, NULL);

        jobject weak = reinterpret_cast<jobject>(arg);
        // 判斷弱全局引用是否已經(jīng)被回收
        if (env->IsSameObject(weak, NULL)) {
            return NULL;
        }
        
        // 給弱全局引用提升引用級別
        jobject local = env->NewLocalRef(weak);
        
        jmethodID invokeFromJNI = env->GetMethodID(gClassMainActivity, "invokeFromJNI", "(Ljava/lang/String;)V");
        env->CallVoidMethod(local, invokeFromJNI, env->NewStringUTF("JNITutorial"));
        
        env->DeleteLocalRef(local);
        env->DeleteWeakGlobalRef(weak);
        gJavaVM->DetachCurrentThread();
    }
    return NULL;
}

jstring stringFromJNI(JNIEnv* env, jobject obj) {
    pthread_t thread;
    pthread_create(&thread, NULL, Run, env->NewWeakGlobalRef(obj)); //這里的obj其實(shí)是MainActivity亏钩,所以使用了弱全局引用
    __android_log_print(ANDROID_LOG_VERBOSE, "JNITutorial", "stringFromJNI");

    std::string hello = "Hello from C++ dynamic";
    return env->NewStringUTF(hello.c_str());
}

jint RegisterNatives(JNIEnv *env) {
    // 方法數(shù)組莲绰,分別為:
    // 方法名 | 方法簽名 | 函數(shù)指針
    JNINativeMethod methods_MainActivity[] = {
            {"stringFromJNI", "()Ljava/lang/String;", (void *) stringFromJNI},
    };

    jint nMethods = sizeof(methods_MainActivity) / sizeof(methods_MainActivity[0]);
    return env->RegisterNatives(gClassMainActivity, methods_MainActivity, nMethods);
}

JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void* reserved) {
    gJavaVM = vm;
    // 首先獲取JNIEnv
    JNIEnv* env = NULL;
    if (vm->GetEnv(reinterpret_cast<void**>(&env), JNI_VERSION_1_6) != JNI_OK) {
        return JNI_ERR;
    }

    // 反射Java類
    jclass classMainActivity = env->FindClass("com/jianshu/qianlang/jnitutorial/MainActivity");
    // 如果因修改了包名或者類不存在則反射失敗
    if (classMainActivity == NULL) {
        return JNI_ERR;
    }

    gClassMainActivity = reinterpret_cast<jclass>(env->NewGlobalRef(classMainActivity));
    env->DeleteLocalRef(classMainActivity);

    // 動態(tài)注冊方法
    if (RegisterNatives(env) != JNI_OK) {
        return JNI_ERR;
    }

    return JNI_VERSION_1_6;
}

線程中JNIEnv的高級玩法

使用線程局部存儲將JNIEnv直接存儲在當(dāng)前線程對象中。避免多次AttachCurrentThread和DetachCurrentThread調(diào)用姑丑。
Android Developer也提到了這種方法蛤签,只不過沒有詳細(xì)介紹,以下這個示意詳細(xì)演示了如何使用TLS彻坛。

//
// Created by 安秋亮 on 2020/6/11.
//
#include <jni.h>
#include <string>
#include <pthread.h>
#include <android/log.h>
#include "scoped_local_ref.h"

JavaVM* gJavaVM = NULL; // JavaVM 全局指針
jclass gClassMainActivity = NULL; //GlobalRef的jclass
pthread_key_t jenv_key;

/*
    // 要反射調(diào)用的Java方法
    public void invokeFromJNI(final String args) {

        mTextView.post(new Runnable() {
            @Override
            public void run() {
                mTextView.setText(args);
            }
        });
    }
 */

JNIEnv* getJNIEnv() {
    JNIEnv* env = reinterpret_cast<JNIEnv*>(pthread_getspecific(jenv_key));
    if (env) {
        __android_log_print(ANDROID_LOG_VERBOSE, "JNITutorial", "getJNIEnv from TLS: %p", env);
        return env;
    }

    if (gJavaVM->GetEnv(reinterpret_cast<void**>(&env), JNI_VERSION_1_6) != JNI_OK) {
        gJavaVM->AttachCurrentThread(&env, NULL);
        // 使用線程局部存儲顷啼,將JNIEnv存入當(dāng)前線程
        pthread_setspecific(jenv_key, env);
    }
    __android_log_print(ANDROID_LOG_VERBOSE, "JNITutorial", "getJNIEnv: %p", env);

    return env;
}

/**
 * pthread線程的Run方法
 */
void *Run(void *arg) {
    JNIEnv* env = getJNIEnv();

    jobject weak = reinterpret_cast<jobject>(arg);
    // 判斷弱全局引用是否已經(jīng)被回收
    if (env->IsSameObject(weak, NULL)) {
        return NULL;
    }

    env = getJNIEnv(); //這里故意調(diào)用 getJNIEnv 兩次,是為了測試第二次是從TLS中獲取的ENV
    // 給弱全局引用提升引用級別
    jobject local = env->NewLocalRef(weak);

    jmethodID invokeFromJNI = env->GetMethodID(gClassMainActivity, "invokeFromJNI", "(Ljava/lang/String;)V");
    env->CallVoidMethod(local, invokeFromJNI, env->NewStringUTF("JNITutorial"));

    env->DeleteLocalRef(local);
    env->DeleteWeakGlobalRef(weak);
    gJavaVM->DetachCurrentThread();

    return NULL;
}

void Destroy(void *arg) {
    JNIEnv* env = reinterpret_cast<JNIEnv*>(arg);
    __android_log_print(ANDROID_LOG_VERBOSE, "JNITutorial", "Destroy: %p", env);
    gJavaVM->DetachCurrentThread();
}

jstring stringFromJNI(JNIEnv* env, jobject obj) {
    pthread_t thread;
    pthread_create(&thread, NULL, Run, env->NewWeakGlobalRef(obj)); //這里的obj其實(shí)是MainActivity昌屉,所以使用了弱全局引用
    __android_log_print(ANDROID_LOG_VERBOSE, "JNITutorial", "stringFromJNI");

    std::string hello = "Hello from C++ dynamic";
    return env->NewStringUTF(hello.c_str());
}

jint RegisterNatives(JNIEnv *env) {
    // 方法數(shù)組钙蒙,分別為:
    // 方法名 | 方法簽名 | 函數(shù)指針
    JNINativeMethod methods_MainActivity[] = {
            {"stringFromJNI", "()Ljava/lang/String;", (void *) stringFromJNI},
    };

    jint nMethods = sizeof(methods_MainActivity) / sizeof(methods_MainActivity[0]);
    return env->RegisterNatives(gClassMainActivity, methods_MainActivity, nMethods);
}

JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void* reserved) {
    gJavaVM = vm;
    // 首先獲取JNIEnv
    JNIEnv* env = NULL;

    pthread_key_create(&jenv_key, Destroy);

    if (vm->GetEnv(reinterpret_cast<void**>(&env), JNI_VERSION_1_6) != JNI_OK) {
        return JNI_ERR;
    }

    // 反射Java類
    jclass classMainActivity = env->FindClass("com/jianshu/qianlang/jnitutorial/MainActivity");
    // 如果因修改了包名或者類不存在則反射失敗
    if (classMainActivity == NULL) {
        return JNI_ERR;
    }

    gClassMainActivity = reinterpret_cast<jclass>(env->NewGlobalRef(classMainActivity));
    env->DeleteLocalRef(classMainActivity);

    // 動態(tài)注冊方法
    if (RegisterNatives(env) != JNI_OK) {
        return JNI_ERR;
    }

    return JNI_VERSION_1_6;
}

本專題的其他內(nèi)容

- JavaVM 和 JNIEnv
- javap 獲取JNI方法簽名
- JNI靜態(tài)注冊和動態(tài)注冊

參考

IBM- JNI 對象引用概述

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市间驮,隨后出現(xiàn)的幾起案子躬厌,更是在濱河造成了極大的恐慌,老刑警劉巖竞帽,帶你破解...
    沈念sama閱讀 211,348評論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件扛施,死亡現(xiàn)場離奇詭異,居然都是意外死亡屹篓,警方通過查閱死者的電腦和手機(jī)疙渣,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,122評論 2 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來堆巧,“玉大人妄荔,你說我怎么就攤上這事〉簦” “怎么了啦租?”我有些...
    開封第一講書人閱讀 156,936評論 0 347
  • 文/不壞的土叔 我叫張陵,是天一觀的道長荒揣。 經(jīng)常有香客問我篷角,道長,這世上最難降的妖魔是什么系任? 我笑而不...
    開封第一講書人閱讀 56,427評論 1 283
  • 正文 為了忘掉前任恳蹲,我火速辦了婚禮虐块,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘阱缓。我一直安慰自己非凌,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,467評論 6 385
  • 文/花漫 我一把揭開白布荆针。 她就那樣靜靜地躺著敞嗡,像睡著了一般。 火紅的嫁衣襯著肌膚如雪航背。 梳的紋絲不亂的頭發(fā)上喉悴,一...
    開封第一講書人閱讀 49,785評論 1 290
  • 那天,我揣著相機(jī)與錄音玖媚,去河邊找鬼箕肃。 笑死,一個胖子當(dāng)著我的面吹牛今魔,可吹牛的內(nèi)容都是我干的勺像。 我是一名探鬼主播,決...
    沈念sama閱讀 38,931評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼错森,長吁一口氣:“原來是場噩夢啊……” “哼吟宦!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起涩维,我...
    開封第一講書人閱讀 37,696評論 0 266
  • 序言:老撾萬榮一對情侶失蹤殃姓,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后瓦阐,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體蜗侈,經(jīng)...
    沈念sama閱讀 44,141評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,483評論 2 327
  • 正文 我和宋清朗相戀三年睡蟋,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了踏幻。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,625評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡戳杀,死狀恐怖叫倍,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情豺瘤,我是刑警寧澤,帶...
    沈念sama閱讀 34,291評論 4 329
  • 正文 年R本政府宣布听诸,位于F島的核電站坐求,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏晌梨。R本人自食惡果不足惜桥嗤,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,892評論 3 312
  • 文/蒙蒙 一须妻、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧泛领,春花似錦荒吏、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,741評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至锡宋,卻和暖如春儡湾,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背执俩。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評論 1 265
  • 我被黑心中介騙來泰國打工徐钠, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人役首。 一個月前我還...
    沈念sama閱讀 46,324評論 2 360
  • 正文 我出身青樓尝丐,卻偏偏與公主長得像,于是被迫代替她去往敵國和親衡奥。 傳聞我的和親對象是個殘疾皇子爹袁,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,492評論 2 348