初學(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)注冊