JavaVM 和 JNIEnv

初学者，尤其是缺少C++开发经验的初学者，经常会对以下两种写法感到困惑：
NewStringUTF(env, "Hello from C++");
env->NewStringUTF("Hello from C++");
实际上，JNI的头文件jni.h中同时声明了C与C++两种接口，通过#ifdef __cplusplus宏指令进行区分。
如果你的工程没有强制要求必须使用纯C代码，推荐使用C++实现。

JNI 定义了两个关键数据结构，即“JavaVM”和“JNIEnv”。理论上在Java中每个进程可以有多个 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 函数。每个线程都有独立的JNIEnv，通过“线程局部存储”（ThreadLocal）存储在线程对象上。因此无法在线程之间共享 JNIEnv。

线程

Java创建的线程自带JNIEnv，通过JavaVM的GetEnv方法可以直接获取到对应的JNIEnv指针。而非Java线程则没有JNIEnv，需要使用JavaVM的AttachCurrentThread附加JNIEnv。以下是一个比较详细的示例，使用pthread_create创建了一个pthread线程，然后在Run方法中反射调用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

/*
    // 要反射调用的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);
        // 判断弱全局引用是否已经被回收
        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其实是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) {
    // 方法数组，分别为：
    // 方法名 | 方法签名 | 函数指针
    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);

    // 动态注册方法
    if (RegisterNatives(env) != JNI_OK) {
        return JNI_ERR;
    }

    return JNI_VERSION_1_6;
}

线程中JNIEnv的高级玩法

使用线程局部存储将JNIEnv直接存储在当前线程对象中。避免多次AttachCurrentThread和DetachCurrentThread调用。
Android Developer也提到了这种方法，只不过没有详细介绍，以下这个示意详细演示了如何使用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;

/*
    // 要反射调用的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存入当前线程
        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);
    // 判断弱全局引用是否已经被回收
    if (env->IsSameObject(weak, NULL)) {
        return NULL;
    }

    env = getJNIEnv(); //这里故意调用 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其实是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) {
    // 方法数组，分别为：
    // 方法名 | 方法签名 | 函数指针
    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);

    // 动态注册方法
    if (RegisterNatives(env) != JNI_OK) {
        return JNI_ERR;
    }

    return JNI_VERSION_1_6;
}

本专题的其他内容

- JavaVM 和 JNIEnv
- javap 获取JNI方法签名
- JNI静态注册和动态注册

参考

IBM- JNI 对象引用概述

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 160,108评论 4赞 364
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,699评论 1赞 296
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 109,812评论 0赞 244
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 44,236评论 0赞 213
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,583评论 3赞 288
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,739评论 1赞 222
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,957评论 2赞 315
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,704评论 0赞 204
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,447评论 1赞 246
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,643评论 2赞 249
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,133评论 1赞 261
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,486评论 3赞 256
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,151评论 3赞 238
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,108评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,889评论 0赞 197
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,782评论 2赞 277
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,681评论 2赞 272