Android Jni调用浅述

╰+攻爆jí腚メ 2022-07-14 09:37 188阅读 0赞

转自：http://blog.csdn.net/flydream0/article/details/7371692

## 1 简述    ##

JNI是Java Native Interface的缩写，中文为JAVA本地调用。从Java1.1开始，Java Native Interface(JNI)标准成为java平台的一部分，它允许Java代码和其他语言写的代码进行交互。JNI一开始是为了本地已编译语言，尤其是C和C++而设计的，但是它并不妨碍你使用其他语言，只要调用约定受支持就可以了。

由于Android的应用层的类都是以Java写的，这些Java类编译为Dex型式的字节码之后，必须依靠Dalvik虚拟机来运行，在Android中Dalvik虚拟机扮演很重要的角色.而Android中间件是由C/C++写的，这些C/C+＋写的组件并不是在Dalvik虚拟机上运行的。那么应用层上的Java代码又是如何与C/C＋＋写的组件之间又是如何沟通的？

## 2 载入.so文件 ##

System.loadLibrary(\*.so文件);

在java代码中，可以通过loadLibrary要求VM装载so文件，java代码一般如下形式：

public class jnitest {
        static {
            System.loadLibrary("jnitest");
        }
        //...
    }

上述代码运行时将会在/system/lib/目录下查找libjnitest.so文件，将载入VM,这样，java代码和C组件之间就构成了联系，接下来就可以通过一些方法可以相互调用了.

## 3 JNI\_OnLoad与JNI\_OnUnload ##

在Android中，当程序在java层运行System.loadLibrary("jnitest");这行代码后，程序会去载入libjnitest.so文件，与此同时，产生一个"Load"事件，这个事件触发后，程序默认会在载入的.so文件的函数列表中查找JNI\_OnLoad函数并执行，与"Load"事件相对，当载入的.so文件被卸载时，“Unload”事件被触发，此时，程序默认会去在载入的.so文件的函数列表中查找JNI\_OnUnload函数并执行，然后卸载.so文件。需要注意的是，JNI\_OnLoad与JNI\_OnUnload这两个函数在.so组件中并不是强制要求的，用户也可以不去实现，java代码一样可以调用到C组件中的函数，在接下来的章节中会讲到这点.

之所以在C组件中去实现这两个函数（特别是JNI\_OnLoad函数），往往是做一个初始化工作或“善后”工作。可以这样认为，将JNI\_ONLoad看成是.so组件的初始化函数，当其第一次被装载时被执行（window下的dll文件也可类似的机制，在\_DLL\_Main()函数中，通过一个swith case语句来识别当前是载入还是卸载）。将JNI\_OnUnload函数看成是析构函数，当其被卸载时被调用。

由此看来，就不难明白为什么很多jni C组件中会实现JNI\_OnLoad这个函数了。 一般情况下，在C组件中的JNI\_OnLoad函数用来实现给VM注册接口，以方便VM可以快速的找到Java代码需要调用的C函数。（此外，JNI\_OnLoad函数还有另外一个功能，那就是告诉VM此C组件使用那一个JNI版本，如果未实现JNI\_OnLoad函数，则默认是JNI 1.1版本）。

## 4 显式注册native方法 ##

### 4.1 显式注册的作用: ###

应用层的Java类别通过VM而调用到native函数。一般是通过VM去寻找\*.so里的native函数。如果需要连续呼叫很多次，每次都需要寻找一遍，会多花许多时间。此时，C组件开发者可以将本地函数向VM进行注册,以便能加快后续调用native函数的效率.可以这么想象一下，假设VM内部一个native函数链表，初始时是空的，在未显式注册之前此native函数链表是空的，每次java调用native函数之前会首先在此链表中查找需要查找需要调用的native函数，如果找到就直接使用，如果未找到，得再通过载入的.so文件中的函数列表中去查找，且每次java调用native函数都是进行这样的流程，因此，效率就自然会下降，为了克服这样现象，我们可以通过在.so文件载入初始化时，即JNI\_OnLoad函数中，先行将native函数注册到VM的native函数链表中去，这样一来，后续每次java调用native函数时都会在VM中的native函数链表中找到对应的函数，从而加快速度.

注：在Android 源码开发环境下，大多采用显式注册native方法.

### 4.2 在Android源码开发模式下有两种方法可以实现显示注册native方法: ###

#### 方法一: 使用JNIHelp.h头文件中定义的jniRegisterNativeMethods来实现.    ####

如~/WORKING\_DIRECTORY/frameworks/base/services/jni/com\_android\_server\_location\_GpsLocationProvider.cpp：

注:此文件同级目录中的其它cpp文件大多采用此种方法进行native方法显式注册.

static JNINativeMethod sMethods[] = {
         /* name, signature, funcPtr */
        {"class_init_native", "()V", (void *)android_location_GpsLocationProvider_class_init_native},
        {"native_is_supported", "()Z", (void*)android_location_GpsLocationProvider_is_supported},
        {"native_init", "()Z", (void*)android_location_GpsLocationProvider_init},
        {"native_cleanup", "()V", (void*)android_location_GpsLocationProvider_cleanup},
        {"native_set_position_mode", "(IIIII)Z", (void*)android_location_GpsLocationProvider_set_position_mode},
        {"native_start", "()Z", (void*)android_location_GpsLocationProvider_start},
        {"native_stop", "()Z", (void*)android_location_GpsLocationProvider_stop},
        {"native_delete_aiding_data", "(I)V", (void*)android_location_GpsLocationProvider_delete_aiding_data},
        {"native_read_sv_status", "([I[F[F[F[I)I", (void*)android_location_GpsLocationProvider_read_sv_status},
        {"native_read_nmea", "([BI)I", (void*)android_location_GpsLocationProvider_read_nmea},
        {"native_inject_time", "(JJI)V", (void*)android_location_GpsLocationProvider_inject_time},
        {"native_inject_location", "(DDF)V", (void*)android_location_GpsLocationProvider_inject_location},
        {"native_supports_xtra", "()Z", (void*)android_location_GpsLocationProvider_supports_xtra},
        {"native_inject_xtra_data", "([BI)V", (void*)android_location_GpsLocationProvider_inject_xtra_data},
        {"native_agps_data_conn_open", "(Ljava/lang/String;)V", (void*)android_location_GpsLocationProvider_agps_data_conn_open},
        {"native_agps_data_conn_closed", "()V", (void*)android_location_GpsLocationProvider_agps_data_conn_closed},
        {"native_agps_data_conn_failed", "()V", (void*)android_location_GpsLocationProvider_agps_data_conn_failed},
        {"native_agps_set_id","(ILjava/lang/String;)V",(void*)android_location_GpsLocationProvider_agps_set_id},
        {"native_agps_set_ref_location_cellid","(IIIII)V",(void*)android_location_GpsLocationProvider_agps_set_reference_location_cellid},
        {"native_set_agps_server", "(ILjava/lang/String;I)V", (void*)android_location_GpsLocationProvider_set_agps_server},
        {"native_send_ni_response", "(II)V", (void*)android_location_GpsLocationProvider_send_ni_response},
        {"native_agps_ni_message", "([BI)V", (void *)android_location_GpsLocationProvider_agps_send_ni_message},
        {"native_get_internal_state", "()Ljava/lang/String;", (void*)android_location_GpsLocationProvider_get_internal_state},
        {"native_update_network_state", "(ZIZZLjava/lang/String;Ljava/lang/String;)V", (void*)android_location_GpsLocationProvider_update_network_state },
    };
    
    int register_android_server_location_GpsLocationProvider(JNIEnv* env)
    {
        return jniRegisterNativeMethods(env, "com/android/server/location/GpsLocationProvider", sMethods, NELEM(sMethods));
    }

其中jniRegisterNativeMethods和NELEM都是在头文件JNIHelp.h定义的，得:

#include "JNIHelp.h"

在Android.mk文件中得加上:

LOCAL_SHARED_LIBRARIES +=libnativehelper

#### 方法二:使用AndroidRuntime::registerNativeMethods    ####

如~/WORKING\_DIRECTORY/frameworks/base/media/jni/android\_media\_MediaPlayer.cpp：

注：当前目录下其它cpp文件大多采用此种方法进行显式native注册.

static JNINativeMethod gMethods[] = {
        {"setDataSource",       "(Ljava/lang/String;)V",            (void *)android_media_MediaPlayer_setDataSource},
    
        {
            "_setDataSource",
            "(Ljava/lang/String;[Ljava/lang/String;[Ljava/lang/String;)V",
            (void *)android_media_MediaPlayer_setDataSourceAndHeaders
        },
    
        {"setDataSource",       "(Ljava/io/FileDescriptor;JJ)V",    (void *)android_media_MediaPlayer_setDataSourceFD},
        {"_setVideoSurface",    "(Landroid/view/Surface;)V",        (void *)android_media_MediaPlayer_setVideoSurface},
        {"prepare",             "()V",                              (void *)android_media_MediaPlayer_prepare},
        {"prepareAsync",        "()V",                              (void *)android_media_MediaPlayer_prepareAsync},
        {"_start",              "()V",                              (void *)android_media_MediaPlayer_start},
        {"_stop",               "()V",                              (void *)android_media_MediaPlayer_stop},
        {"getVideoWidth",       "()I",                              (void *)android_media_MediaPlayer_getVideoWidth},
        {"getVideoHeight",      "()I",                              (void *)android_media_MediaPlayer_getVideoHeight},
        {"seekTo",              "(I)V",                             (void *)android_media_MediaPlayer_seekTo},
        //...
    }
    // This function only registers the native methods
    static int register_android_media_MediaPlayer(JNIEnv *env)
    {
        return AndroidRuntime::registerNativeMethods(env,
                    "android/media/MediaPlayer", gMethods, NELEM(gMethods));
    }

其中AndroidRuntime::registerNativeMethods是在头文件android\_runtime/AndroidRuntime.h中定义，使用时得:

#include "android_runtime/AndroidRuntime.h"

且得在Android.mk文件中加上:

LOCAL_SHARED_LIBRARIES += \
        libandroid_runtime

有关函数命名，请参考博客内另一篇文章： [Android下如何通过JNI方法向上提供接口总结][Android_JNI]。

注：以上两种显式注册native方法都只是适用于Android源码开发环境下，至于在Android NDK环境下如何显式注册native方法，暂时还没有研究过，且此两种方法目前NDK还不支持,NDK开发模式下一般采用隐式注册native函数，即接下来要讲的内容.

## 5 隐式注册native方法 ##

前面第3节已经讲到，JNI\_OnLoad和JNI\_OnUnload函数并不是强制要求实现的，在这种情况下，就相当于在载入.so文件时，没有了初始化函数，既然没有了初始化函数，那显式注册native方法也行不通了。那这个时候又该如何让应用层的java代码调用下层的C函数呢?

幸运地是，即使我们不使用任何代码做native函数显式注册，应用层的java代码在调用native函数时，也会采用默认的方法到转入的.so文件中的函数列表中查找对应的native 函数，只不过，这个native函数与java类型中声明的native函数的名字之前有一种默认的对应关系。如:

java类的native成员函数:public native int socket\_send(int cmdid,String argus);默认会在.so文件中的函数列表中查找jint JNICALL Java\_com\_hase\_bclm\_bclm\_socket\_1send(JNIEnv \*env, jobject obj, jint cmdid, jstring argus);函数，一旦找到此对应的函数，VM就会将此native函数自动注册到VM内部的native函数链表中，以便加快后续相同jni调用.

可接下来的问题是，作为码农的我们，又是如何知道java native成员函数对应着C组件中的native 函数的名字呢?简单地函数名字也许我们能搞定，复杂一点的就要傻眼了。同样幸运地是，JDK提供了一个javah工具，可以用这个工具来自动通过.class文件来生成C组件的头文件.

比如你用java写了一个xxx.java文件，里边的java类型里面声明了一些native成员函数，此xxx.java文件编译后会生成xxx.class文件，那么就在你生成的xxx.class包所在目录输入命令行:

$javah -jni com.packagename.yourclassname

就会在当前目录下生成一个头文件。

比如：

javah -jni com.test.example

则在当前目录下生成 com\_test\_example.h头文件.

当前目录下的com结构为:com/test/example.class

再将此头文件拷贝到你的C组件工程内，实现其中声明的native函数即可.

之前在显式注册native函数的相关章节中已经说明，显式注册是将native函数添加到VM内部的native函数链表中，以加快后续jni调用的效率，其实在隐性native 注册时，每一次执行某个jni调用时，VM在.so函数列表中找到对应的native函数后，同样也会将其注册到VM内部的native函数链表中，由此看到，隐式native注册的方法除了第一次执某个jni调用时会稍微速度慢点外，后续同样的调用就会直接在VM内部的native函数链表中找到对应的native函数，这样看来，显式与隐式注册native方法，其实效率相差无几.

OK,到此结束!

[Android_JNI]: http://blog.csdn.net/flydream0/article/details/7088514