在 JNI 中,如何根据 IBM 的性能建议缓存类、方法 ID 和字段 ID?

我在IBM上读到

要访问 Java 对象的字段并调用它们的方法,本机代码必须调用 FindClass()、GetFieldID()、GetMethodId() 和 GetStaticMethodID()。在 GetFieldID()、GetMethodID() 和 GetStaticMethodID() 的情况下,为给定类返回的 ID 在 JVM 进程的生存期内不会更改。但是,调用获取字段或方法可能需要在 JVM 中执行大量工作,因为字段和方法可能是从超类继承的,这使得 JVM 在类层次结构中向上移动以查找它们。由于给定类的 ID 是相同的,因此应查找一次 ID,然后重用它们。同样,查找类对象可能很昂贵,因此它们也应该被缓存。

如何在 JNI 中缓存 、 和 对象?是否有必须遵循的内置方法或特定过程?methodIDfieldIDclass


答案 1

没有内置的方法可以遵循,但是这里有一个有点标准,干净和可重复的实现,展示了我如何实践IBM的建议。

我将假设您正在从 Java 调用 DLL,并且您在整个应用程序生命周期中多次引用它。

示例 Native Java 类被命名为 ,它将实现 2 个内置的 JNI 方法和 。org.stackoverflow.jni.NativeClazzJNI_OnLoad()JNI_OnUnload()

void JNI_OnLoad(JavaVM *vm, void *reserved):此方法将用于将类 ID 注册为全局变量,并将方法 ID 和字段 ID 分配给静态变量。当驱动程序由 Java VM 加载时,将自动调用该方法。在驱动程序生命周期中,它只被调用一次。

void JNI_OnUnload(JavaVM *vm, void *reserved):此方法将用于释放 由 注册的任何全局变量。VM 将在应用程序关闭之前立即自动调用。JNI_OnLoad()JNI_OnUnload()

理由:我的理解是,类 ID 必须注册为全局引用,以保持任何关联的方法 ID/字段 ID 的可行性。如果未执行此操作,并且从 JVM 中卸载了类,则在类重新装入时,方法 ID/字段 ID 可能会有所不同。如果将类 ID 注册为全局引用,则不需要将关联的方法 ID 和字段 ID 注册为全局引用。将类 ID 注册为全局引用可防止卸载关联的 Java 类,从而稳定方法 ID/字段 ID 值。应在 中删除全局引用,包括类 ID。JNI_OnUnload()

方法 ID 和字段 ID 不是由本机代码管理的;它们由虚拟机管理,在卸载关联的类之前一直有效。在虚拟机卸载定义类之前,无法显式删除字段 ID 和方法 ID;它们可以留给 VM 在卸载后处理。

示例代码

以下C++代码部分中的注释说明了全局注册变量。

下面是表示数据对象的 Java 类 BeanObject

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);
}

以下是在 NativeClazz 上使用 javah 生成的C++头文件“org_stackoverflow_jni_NativeClazz.h”:

/* 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);
}

答案 2

以下是我如何实践IBM的建议。考虑像这样的演示Java类:

public class SimpleClazz {

    public int value = 10;

    public native int getValue();

    static {
        // Load Native Library
        System.loadLibrary("The native library name");
    }
}

相应的 jni 头文件如下所示:

/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class SimpleClazz */

#ifndef _Included_SimpleClazz
#define _Included_SimpleClazz
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     SimpleClazz
 * Method:    getValue
 * Signature: ()I
 */
JNIEXPORT jint JNICALL Java_SimpleClazz_getValue
  (JNIEnv *, jobject);

#ifdef __cplusplus
}
#endif
#endif

根据IBM的建议,我们需要缓存对象成员的已用类和字段ID。SimpleClazzvalue

在学习了这篇好文章之后,我将 缓存在函数中,该函数在加载本机库时调用(例如,通过 System.loadLibrary)。在 中,我们确实找到了类,并将此 j 类存储为全局字段。SimpleClazzJNI_OnLoadJNI_Onload

此外,在 的本机实现中,我们使用静态局部变量来缓存 的字段 id。此设计是为了确保此字段 ID 可以位于更好的范围内,而不是全局范围内。这种设计的缺点是每次调用此函数时都需要与 NULL 进行比较。我从《Java Native Interface: Programmer's Guide and Specification》一书的 4.4.1 节中学到了这个设计。getValuevalue

最后,我们还需要编写函数 ,当包含本机库的类装入器被垃圾回收时调用该函数。在此函数中,我们发布 jclass 的全局引用。JNI_OnUnload

我的cpp实现如下所示:

#include <jni.h>
#include <SimpleClazz.h>

static jclass simpleCls;

// According to http://docs.oracle.com/javase/1.5.0/docs/guide/jni/spec/invocation.html#JNI_OnLoad
// The VM calls JNI_OnLoad when the native library is loaded (for example, through System.loadLibrary).
jint JNI_OnLoad(JavaVM* vm, void* reserved) {
    JNIEnv* env;
    if ((*vm)->GetEnv(vm, (void **) &env, JNI_VERSION_1_6) != JNI_OK) {
        return JNI_ERR;
    } else {
        jclass localSimpleCls = (*env)->FindClass("SimpleClazz");

        if (localSimpleCls == NULL) {
            return JNI_ERR;
        }
        simpleCls = (jclass) (*env)->NewGlobalRef(env, localSimpleCls);
    } 
    return JNI_VERSION_1_6;
}



JNIEXPORT jint JNICALL Java_SimpleClazz_getValue(JNIEnv * env, jobject thiz){
    static jfieldID valueID = NULL;
    if (valueID == NULL) {
        valueID = (*env)->GetFieldID(env, simpleCls, "value", "I");
        if (valueID == NULL){
            return JNI_ERR;         // Exception thrown
        }
    }
    jint value = (*env)->GetIntField(env, thiz, valueID);
    return value;
}

// According to http://docs.oracle.com/javase/1.5.0/docs/guide/jni/spec/invocation.html#JNI_OnUnload
// The VM calls JNI_OnUnload when the class loader containing the native library is garbage collected.
void JNI_OnUnload(JavaVM *vm, void *reserved) {
    JNIEnv* env;
    if ((*vm)->GetEnv(vm, (void **) &env, JNI_VERSION_1_6) != JNI_OK) {
        // Something is wrong but nothing we can do about this :(
        return;
    } else {
        if (0 != NULL){
            (*env)->DeleteGlobalRef(env, simpleCls);
        }
    }
}

推荐