JavaVM 和 JNIEnv

作者: 千浪 | 来源:发表于2020-06-16 13:54 被阅读0次

    初学者,尤其是缺少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方法:

    //
    // 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
    
    /*
        // 要反射调用的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 对象引用概述

    相关文章

      网友评论

        本文标题:JavaVM 和 JNIEnv

        本文链接:https://www.haomeiwen.com/subject/fdalxktx.html