java - 在 JNI 中，如何根据 IBM 的性能建议缓存类、方法 ID 和字段 ID？

Question

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

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

score 51 · Accepted Answer

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

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

示例 Native Java 类名为org.stackoverflow.jni.NativeClazz，它将实现 2 个内置 JNI 方法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 可能不同。如果 Class ID 注册为全局引用，则关联的 Method IDs 和 Field IDs 不需要注册为全局引用。将类 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++ 头文件“ ” ：javahNativeClazz

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

score 8 · Accepted Answer

以下是我如何实践 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 的建议，我们需要缓存使用的类SimpleClazz和对象成员的字段 id value。

学习了这篇好文章SimpleClazz后，我在函数中缓存了JNI_OnLoad，加载原生库时调用（例如通过System.loadLibrary）。在中JNI_Onload，我们确实找到了 class 并将这个 jclass 存储为全局字段。

此外，在的原生实现中getValue，我们使用静态局部变量来缓存的字段 id value。这种设计是为了确保这个归档的 id 可以在更好的范围内，而不是在全局范围内。这种设计的缺点是每次调用这个函数都需要和NULL进行比较。我从The Java Native Interface: Programmer's Guide and Specification一书的第 4.4.1 节学到了这种设计。

最后，我们还需要编写函数JNI_OnUnload，当包含本机库的类加载器被垃圾回收时调用。在这个函数中，我们释放了 jclass 的全局引用。

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

score 2 · Accepted Answer

你可以有一些这样的实用程序结构：

typedef struct MYVARIANT_FID_CACHE {
    int cached;
    jclass clazz;
    jfieldID pAddress;
} MYVARIANT_FID_CACHE;

MYVARIANT_FID_CACHE VARIANTFc;

void cacheMYVARIANTFields(JNIEnv *env, jobject lpObject)
{
    if (VARIANTFc.cached) return;
    VARIANTFc.clazz = env->GetObjectClass(lpObject);
    VARIANTFc.pAddress = env->GetFieldID(VARIANTFc.clazz, "pAddress", "I");
    VARIANTFc.cached = 1;
}

VARIANT *getMYVARIANTFields(JNIEnv *env, jobject lpObject, VARIANT *lpStruct)
{
    if (!VARIANTFc.cached) cacheVARIANT2Fields(env, lpObject);

    lpStruct = (VARIANT*)(env->GetIntField(lpObject, VARIANTFc.pAddress));

    return lpStruct;
}

这取自我的问题：https ://stackoverflow.com/questions/10617714/how-to-extend-swt-com-support

对于一些好的示例，请查看os_structs.c它与 eclipse SWT 实现捆绑在一起。

注意：上面的代码只是一个例子，可以适应不同的操作系统。它也只是显示“如何访问 java 字段”；对于方法，您可以遵循相同的方法。

score 1 · Accepted Answer

参考@JoshDM给出的答案

用于此的 C 接口与上面给出的 C++ 接口略有不同。你必须这样写：-

/**************************************************************
 * 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(vm, (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(env, "org/stackoverflow/data/BeanObject");

    // STEP 2/3 : Assign the ClassId as a Global Reference
    JC_BeanObject = (jclass) (*env)->NewGlobalRef(env, tempLocalClassRef);

    // STEP 3/3 : Delete the no longer needed local reference
    (*env)->DeleteLocalRef(env, tempLocalClassRef);

    // Load the method id
    JMID_BeanObject_getFoo = (*env)->GetMethodID(env, 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;
}

score 0 · Accepted Answer

对于简单的情况，我在 C 代码中使用静态字段，使用从我的 java 类调用的 initId 方法进行初始化：

package demo;
public class WithNatives {

 static {
   initIDs();
 }

 private static native void initIDs();

}

在 C 中：

static jmethodID methodId;

void JNICALL Java_demo_WithNatives_initIDs(JNIEnv *env, jclass clazz)
{
   // initialize methodId
}

java - 在 JNI 中，如何根据 IBM 的性能建议缓存类、方法 ID 和字段 ID？

5 回答 5

Related

Reference