従うべき組み込みの方法論はありませんが、IBM の推奨事項を私がどのように実践しているかを示す、やや標準的でクリーンで反復可能な実装を次に示します。
Java から DLL を呼び出しており、アプリケーションのライフサイクル全体で何度も参照していると仮定します。
サンプルのネイティブ Java クラスの名前は で、2 つの組み込み JNI メソッドとorg.stackoverflow.jni.NativeClazz
を実装します。JNI_OnLoad()
JNI_OnUnload()
void JNI_OnLoad(JavaVM *vm, void *reserved)
: このメソッドは、クラス ID をグローバル変数として登録し、メソッド ID とフィールド ID を静的変数に割り当てるために使用されます。このメソッドは、ドライバが Java VM によってロードされるときに自動的に呼び出されます。ドライバーのライフサイクル中に一度だけ呼び出されます。
void JNI_OnUnload(JavaVM *vm, void *reserved)
: このメソッドは、によって登録されたすべてのグローバル変数を解放するために使用されJNI_OnLoad()
ます。JNI_OnUnload()
VM は、アプリケーションのシャットダウンの直前に自動的に呼び出します。
根拠:関連するメソッド ID/フィールド ID の実行可能性を維持するために、クラス ID をグローバル参照として登録する必要があることを理解しています。これが行われず、クラスが JVM からアンロードされた場合、クラスのリロード時に、メソッド ID / フィールド ID が異なる場合があります。クラス ID がグローバル参照として登録されている場合、関連するメソッド ID とフィールド ID をグローバル参照として登録する必要はありません。クラス ID をグローバル参照として登録すると、関連する Java クラスがアンロードされなくなり、メソッド ID / フィールド ID の値が安定します。クラス ID を含むグローバル参照は、 で削除する必要がありますJNI_OnUnload()
。
メソッド ID とフィールド ID はネイティブ コードでは管理されません。それらは仮想マシンによって管理され、関連するクラスがアンロードされるまで有効です。仮想マシンが定義クラスをアンロードする前に、フィールド ID とメソッド ID を明示的に削除することはできません。アンロード後に VM が処理できるようにしておくことができます。
サンプルコード
次の C++ コード セクションのコメントでは、変数をグローバルに登録する方法について説明しています。
BeanObject
以下は、データ オブジェクトを表すJava クラスです。
package org.stackoverflow.data;
public class BeanObject {
String foo = "";
public String getFoo() {
return foo;
}
}
スケルトン Java クラスは次のNativeClazz
とおりです。
package org.stackoverflow.jni;
import org.stackoverflow.data.BeanObject;
public class NativeClazz {
// Static area for forced initialization
static {
// Load Native Library (C++); calls JNI_OnLoad()
System.loadLibrary("Native_Library_File_Name");
}
/**
* A static native method you plan to call.
*/
public static native void staticNativeMethod(BeanObject bean);
/**
* A non-static native method you plan to call, to show this also works with
* Java class instances.
*/
public native void instanceNativeMethod(BeanObject bean);
}
onorg_stackoverflow_jni_NativeClazz.h
を使用して生成された C++ ヘッダー ファイル " " は次のとおりです。javah
NativeClazz
/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class org_stackoverflow_jni_NativeClazz */
#ifndef _Included_org_stackoverflow_jni_NativeClazz
#define _Included_org_stackoverflow_jni_NativeClazz
#ifdef __cplusplus
extern "C" {
#endif
/*
* Class: org_stackoverflow_jni_NativeClazz_staticNativeMethod
* Method: staticNativeMethod
* Signature: ()V
*/
JNIEXPORT void JNICALL Java_org_stackoverflow_jni_NativeClazz_staticNativeMethod
(JNIEnv *, jclass, jobject);
/*
* Class: org_stackoverflow_jni_NativeClazz_instanceNativeMethod
* Method: instanceNativeMethod
* Signature: ()V
*/
JNIEXPORT void JNICALL Java_org_stackoverflow_jni_NativeClazz_instanceNativeMethod
(JNIEnv *, jobject, jobject);
#ifdef __cplusplus
}
#endif
#endif
ヘッダー ファイルを実装する C++ .cpp ファイルを次に示します。
#include "org_stackoverflow_jni_NativeClazz.h"
using namespace std;
/**************************************************************
* Static Global Variables to cache Java Class and Method IDs
**************************************************************/
static jclass JC_BeanObject; // declare for each class
static jmethodID JMID_BeanObject_getFoo; // declare for each class method
/**************************************************************
* Declare JNI_VERSION for use in JNI_Onload/JNI_OnUnLoad
* Change value if a Java upgrade requires it (prior: JNI_VERSION_1_6)
**************************************************************/
static jint JNI_VERSION = JNI_VERSION_1_8;
/**************************************************************
* Initialize the static Class and Method Id variables
**************************************************************/
jint JNI_OnLoad(JavaVM* vm, void* reserved) {
// Obtain the JNIEnv from the VM and confirm JNI_VERSION
JNIEnv* env;
if (vm->GetEnv(reinterpret_cast<void**>(&env), JNI_VERSION) != JNI_OK) {
return JNI_ERR;
}
// Temporary local reference holder
jclass tempLocalClassRef;
// STEP 1/3 : Load the class id
tempLocalClassRef = env->FindClass("org/stackoverflow/data/BeanObject");
// STEP 2/3 : Assign the ClassId as a Global Reference
JC_BeanObject = (jclass) env->NewGlobalRef(tempLocalClassRef);
// STEP 3/3 : Delete the no longer needed local reference
env->DeleteLocalRef(tempLocalClassRef);
// Load the method id
JMID_BeanObject_getFoo = env->GetMethodID(JC_BeanObject, "getFoo", "(Ljava/lang/String;)V");
// ... repeat prior line for any other methods of BeanObject
// ... repeat STEPS 1-3 for any other classes; re-use tempLocalClassRef.
// Return the JNI Version as required by method
return JNI_VERSION;
}
/**************************************************************
* Destroy the global static Class Id variables
**************************************************************/
void JNI_OnUnload(JavaVM *vm, void *reserved) {
// Obtain the JNIEnv from the VM
// NOTE: some re-do the JNI Version check here, but I find that redundant
JNIEnv* env;
vm->GetEnv(reinterpret_cast<void**>(&env), JNI_VERSION);
// Destroy the global references
env->DeleteGlobalRef(JC_BeanObject);
// ... repeat for any other global references
}
/**************************************************************
* A Static Native Method
**************************************************************/
JNIEXPORT void JNICALL Java_org_stackoverflow_jni_NativeClazz_staticNativeMethod
(JNIEnv * env, jclass clazz, jobject jBeanObject) {
// Retrieve jstring from the Java Object
jstring jFoo = (jstring)env->CallObjectMethod(jBeanObject, JMID_BeanObject_getFoo);
// Make accessible to C++
const char * cFoo = env->GetStringUTFChars(jFoo, NULL);
// Do something with cFoo...
// Release Resources
env->ReleaseStringUTFChars(jFoo, cFoo);
env->DeleteLocalRef(jFoo);
}
/**************************************************************
* Instance / Non-Static Native Method
**************************************************************/
JNIEXPORT void JNICALL Java_org_stackoverflow_jni_NativeClazz_instanceNativeMethod
(JNIEnv * env, jobject selfReference, jobject jBeanObject) {
// Retrieve jstring from the Java Object
jstring jFoo = (jstring)env->CallObjectMethod(jBeanObject, JMID_BeanObject_getFoo);
// Make accessible to C++
const char * cFoo = env->GetStringUTFChars(jFoo, NULL);
// Do something with cFoo...
// Release Resources
env->ReleaseStringUTFChars(jFoo, cFoo);
env->DeleteLocalRef(jFoo);
}