「游戏引擎Mojoc」(10)Android NDK通用JNI调用Java代码封装

2024年4月16日 互联网

Mojoc提供了一个通用的工具类，来调用Android Java代码，以实现特定平台的功能。这个工具类封装了JNI使用的繁琐细和上下文对象的获取，提供了简单直接的API专注于Java类和方法的访问，并且实现了任意类型Java方法的调用。

本文将会介绍以下几点：

  • NDK NativeActivity的JNI上下文对象获取。
  • JNI中JNIEnv指针的使用和理解。
  • 根据路径获取Java类对象。
  • 调用任意类型的Java方法。
  • 一个简单的例子，使用上述封装，实现APK签名的获取。

JNI上下文对象

要使用JNI必须提供两个上下文变量，即JNIEnv与JavaVM。其中JavaVM直接来自于NativityActivity对象，JNIEnv就需要我们封装一个方法来获取。

extern ANativeActivity* nativeActivity;static inline JNIEnv* GetEnvPtr()
{static JNIEnv* envPtr = NULL;if (envPtr == NULL){(*nativeActivity->vm)->AttachCurrentThread(nativeActivity->vm, &envPtr, NULL);}return envPtr;
}

ANativeActivity是来自于NDK的接口，参看胶水层的实现NativeGlue.c。这里的函数GetEnvPtr从nativeActivity中获取了JNIEnv并缓存，可以理解为一个单例的实现方式。需要注意的是，JNIEnv*是和线程绑定的，所以需要在同一个线程获取并使用。

JNIEnv指针的使用和理解

typedef const struct JNINativeInterface* JNIEnv;

可以看到，JNIEnv是一个指针类型，其结构体包含了很多我们需要用的函数指针如下:

jobject  (*CallObjectMethod) (JNIEnv*, jobject, jmethodID, ...);
jobject  (*CallObjectMethodV)(JNIEnv*, jobject, jmethodID, va_list);
jobject  (*CallObjectMethodA)(JNIEnv*, jobject, jmethodID, jvalue*);
jboolean (*CallBooleanMethod)(JNIEnv*, jobject, jmethodID, ...);

由于C语言中没有this指针，所以这里所有的函数第一个参数，都是相当于this对象传入调用者。AttachCurrentThread函数，需要一个JNIEnv**二级指针变量，然后把JNIEnv*返回出来。由于JNIEnv本身是一个指针类型，那么这里的JNIEnv*其实是一个二级指针。所以，我们在调用其函数的时候，需要(*envPtr)先取地址的内存值，就是解引用。

这里，有一个问题，就是每次都要解引用(*envPtr)操作，写起来很麻烦，为什么我们不保留一个JNIEnv变量，直接当做指针使用呢。如下:

JNIEnv* envPtr = NULL;  (*nativeActivity->vm)->AttachCurrentThread(nativeActivity->vm, &envPtr, NULL); JNIEnv env = *envPtr;  env->FindClass(&env, "android/app/NativeActivity");  
// 而不是这样
// (*envPtr)->FindClass(envPtr, "android/app/NativeActivity");

这样的写法，会在运行的时候崩溃掉。语法层面是没有问题的，出错的是&env参数不正确。FindClass并不能正确使用这个参数。FindClass第一个参数需要一个JNIEnv*的参数，这里传递的也是JNIEnv*类型的参数。为什么就不对了 ？

这里涉及到一个，对库函数对指针操作的一个深层的理解问题，有以下几点:

  • AttachCurrentThread函数返回的JNIEvn* 无论是几级指针，本质都是一个指针，我们并不知道这个指针是malloc出来的独立内存，还是一个连续内存的一部分。但是库函数的实现者知道。并且，这个返回的evnPtr与&env并不一样，虽然都是JNIEvn* 类型。&env是env的地址，env的值和* envPtr一样，但&env和&(*envPtr)值不一样。

  • 很明显，FindClass等一系列JNIEnv的函数，需要的都是envPtr的值，就是AttachCurrentThread返回的。可见这里参数，重点并不是JNIEnv* 这个类型，如果仅仅是操作JNIEnv这个类型所能访问的数据，*(&env)就可以。

  • 回到第一点说的，JNIEvn* 的地址，拥有我们未知的访问能力。库的实现者在AttachCurrentThread返回出来，就是需要在后面的函数用使用这个地址，访问这个地址所关联的内存数据。所以，必须要传入返回的地址才行。

根据路径获取Java类对象

static inline jclass GetClass(char *className)
{JNIEnv* envPtr                   = GetEnvPtr();// 缓存类加载器对象static  jobject   classLoaderObj = NULL;// 缓存类加载方法对象static  jmethodID loadClassId    = NULL;if (classLoaderObj == NULL){// NDK内置的Java类jclass    activityCls      = (*envPtr)->FindClass(envPtr, "android/app/NativeActivity");// 默认的类加载器jclass    loaderCls        = (*envPtr)->FindClass(envPtr, "java/lang/ClassLoader");jmethodID getClassLoaderId = (*envPtr)->GetMethodID(envPtr,activityCls,"getClassLoader","()Ljava/lang/ClassLoader;");classLoaderObj             = (*envPtr)->CallObjectMethod(envPtr, nativeActivity->clazz, getClassLoaderId);loadClassId                = (*envPtr)->GetMethodID(envPtr,loaderCls,"loadClass","(Ljava/lang/String;)Ljava/lang/Class;");}jstring classNameStr = (*envPtr)->NewStringUTF             (envPtr, className);jclass  cls          = (jclass) (*envPtr)->CallObjectMethod(envPtr, classLoaderObj, loadClassId, classNameStr);ALog_A(cls != NULL, "AJniTool GetClass can not load class = %s", className);// New出来的需要Delete(*envPtr)->DeleteLocalRef(envPtr, classNameStr);return cls;
}

调用任意类型的java方法

这里我们封装一个通用的方法，直接调用任意类型的Java方法，并获得返回值。


// 调用Java对象方法
static jvalue CallObjectMethod(jobject object, char* methodName, char* paramCode, ...)
{JNIEnv*   envPtr    = GetEnvPtr();jclass    cls       = (*envPtr)->GetObjectClass(envPtr, object);jmethodID methodId  = (*envPtr)->GetMethodID   (envPtr, cls, methodName, paramCode);ALog_A(methodId != NULL,"AJniTool CallObjectMethod can not get methodID, methodName = %s, paramCode = %s",methodName,paramCode);char* p = paramCode;// 解析参数字符串获得返回值标识// skip '()' to find out the return typewhile (*p != ')'){p++;}// skip ')'p++;va_list  args;va_start(args, paramCode);jvalue   value;// 根据返回值调用方法switch (*p){case 'V':(*envPtr)->CallVoidMethodV             (envPtr, object, methodId, args);break;case '[':case 'L':value.l = (*envPtr)->CallObjectMethodV (envPtr, object, methodId, args);break;case 'Z':value.z = (*envPtr)->CallBooleanMethodV(envPtr, object, methodId, args);break;case 'B':value.b = (*envPtr)->CallByteMethodV   (envPtr, object, methodId, args);break;case 'C':value.c = (*envPtr)->CallCharMethodV   (envPtr, object, methodId, args);break;case 'S':value.s = (*envPtr)->CallShortMethodV  (envPtr, object, methodId, args);break;case 'I':value.i = (*envPtr)->CallIntMethodV    (envPtr, object, methodId, args);break;case 'J':value.j = (*envPtr)->CallLongMethodV   (envPtr, object, methodId, args);break;case 'F':value.f = (*envPtr)->CallFloatMethodV  (envPtr, object, methodId, args);break;case 'D':value.d = (*envPtr)->CallDoubleMethodV (envPtr, object, methodId, args);break;default:ALog_A(false, "AJniTool CallObjectMethod paramCode = %s, illegal", paramCode);}va_end(args);return value;
}// 调用Java静态方法
static inline jvalue CallClassMethodV(jclass cls, char* methodName, char* paramCode, va_list args)
{JNIEnv*   envPtr    = GetEnvPtr();jmethodID methodId  = (*envPtr)->GetStaticMethodID(envPtr, cls, methodName, paramCode);ALog_A(methodId != NULL,"AJniTool CallClassMethodV can not get methodID, methodName = %s, paramCode = %s",methodName,paramCode);char* p = paramCode;// 解析参数字符串获得返回值标识// skip '()' to find out the return typewhile (*p != ')'){p++;}// skip ')'p++;// 根据不同的返回值调用方法jvalue value;switch (*p){case 'V':(*envPtr)->CallStaticVoidMethodV             (envPtr, cls, methodId, args);break;case '[':case 'L':value.l = (*envPtr)->CallStaticObjectMethodV (envPtr, cls, methodId, args);break;case 'Z':value.z = (*envPtr)->CallStaticBooleanMethodV(envPtr, cls, methodId, args);break;case 'B':value.b = (*envPtr)->CallStaticByteMethodV   (envPtr, cls, methodId, args);break;case 'C':value.c = (*envPtr)->CallStaticCharMethodV   (envPtr, cls, methodId, args);break;case 'S':value.s = (*envPtr)->CallStaticShortMethodV  (envPtr, cls, methodId, args);break;case 'I':value.i = (*envPtr)->CallStaticIntMethodV    (envPtr, cls, methodId, args);break;case 'J':value.j = (*envPtr)->CallStaticLongMethodV   (envPtr, cls, methodId, args);break;case 'F':value.f = (*envPtr)->CallStaticFloatMethodV  (envPtr, cls, methodId, args);break;case 'D':value.d = (*envPtr)->CallStaticDoubleMethodV (envPtr, cls, methodId, args);break;default:ALog_A(false, "AJniTool CallClassMethod paramCode = %s, illegal", paramCode);}return value;
}// 调用Java静态方法，根据类对象
static inline jvalue CallClassMethod(jclass cls, char* methodName, char* paramCode, ...)
{va_list args;va_start(args, paramCode);jvalue value = CallClassMethodV(cls, methodName, paramCode, args);va_end(args);return value;
}// 调用Java静态方法，根据类路径
static jvalue CallStaticMethod(char* className, char* methodName, char* paramCode, ...)
{va_list args;va_start(args, paramCode);jvalue value = CallClassMethodV(GetClass(className), methodName, paramCode, args);va_end(args);return value;
}

说明几点:

  • 参数使用了变参，因为调用的Java方法不确定参数个数和类型，需要依次传入。
  • 返回值当然也是不确定类型的，所以使用了jValue这个union类型存放。
  • 这两个方法，只需要给出字符串类型的，类路径，方法名，参数列表。

APK签名的获取

利用前面的函数封装，实现非常清晰明了，并且简洁。

static int GetSignHashCode()
{JNIEnv*     envPtr          = GetEnvPtr();jobject     packageManager  = CallObjectMethod(nativeActivity->clazz,"getPackageManager","()Landroid/content/pm/PackageManager;").l;jstring      packageName    = (jstring) CallObjectMethod(nativeActivity->clazz,"getPackageName","()Ljava/lang/String;").l;jobject      packageInfo    = CallObjectMethod(packageManager,"getPackageInfo","(Ljava/lang/String;I)Landroid/content/pm/PackageInfo;",packageName,64).l;jclass       packageInfoCls = (*envPtr)->GetObjectClass(envPtr, packageInfo);jfieldID     signaturesFid  = (*envPtr)->GetFieldID(envPtr,packageInfoCls,"signatures","[Landroid/content/pm/Signature;");jobjectArray signatureArr   = (*envPtr)->GetObjectField       (envPtr, packageInfo,  signaturesFid);jobject      signature      = (*envPtr)->GetObjectArrayElement(envPtr, signatureArr, 0);return CallObjectMethod(signature, "hashCode", "()I").i;
}

可以看到，函数的实现，就是使用jni调用各种Java已有的代码来实现的，当然也可以获得签名的md5值。另外，需要注意的是，JNI提供的New开头的函数，都需要调用Delete开头的函数释放内存。比如，NewStringUTF，DeleteLocalRef。

最后

完整代码还有更多的功能，在这里：JniTool.h 和 JniTool.c。

「简单实用」

最新文章