JNI教程

一、什么是JNI

JNI(Java Native Interface ),它是Java SDK的一部分，主要用于实现Java对其他语言编写的代码和库的调用，比如C和C++。JNI提供的API也能让JVM嵌入其他的本地代码，实现本地代码对Java代码的调用。本教程主要讲解的就是Java和本地代码的互调，以及C/C++中的数据类型与Java中的数据类型的关系。

二、需要的工具和库

• Java编译器：javac.exe
• Java虚拟机：java.exe
• C头文件产生器：javah.exe
• JNI的库文件（jvm.lib 或jvm.dll(.so)）和头文件 (jni.h)
• 一个C和C++编译器

前面四个是JDK自带的放在%JAVA_HOME%in目录下面，最后一个工具根据你的平台不同有不同的选择。比如在Windows平台我们可以使用Mircosoft的编译器，在基于UNIX的系统下则可以使用GCC

三、Java调用C++

• 使用场景

1. 对代码运行效率要求比较的，你可以采用稍底层更快的语言来编写，比如C/C++这样的本地代码（native code）。
2. 你想要复用以前C/C++写的代码库
3. 你需要一个平台相关的但是Java标准库又不支持的

• 使用步骤

通常我们完成Java调用C++需要以下6步

1. 编写Java代码。这Java代码需要做3件事情：声明要调用的本地方法；加载包含了本地代码的共享库；调用本地方法。
2. 编译Java代码。
3. 创建C/C++头文件。这个C/C++头文件用于去声明将要调用的本地方法的签名，这个头文件使用C/C++去实现，并生产动态库。
4. 编写C/C++的实现。实现第三步生成的头文件。
5. 创建一个共享库。
6. 运行Java代码。检测它是否正确工作。

• 示例代码

由于本示例只是测试Jni的调用，所以只写几个简单的方法。

1. 编写Java代码

public class Sample1
{
    public native int intMethod(int n);
    public native boolean booleanMethod(boolean bool);
    public native String stringMethod(String text);
    public native int intArrayMethod(int[] intArray);
    public static void main(String[] args)
    {
        System.loadLibrary("Sample1");
        Sample1 sample = new Sample1();
        int square = sample.intMethod(5);
        boolean bool = sample.booleanMethod(true);
        String text = sample.stringMethod("JAVA");
        int sum = sample.intArrayMethod(
        new int[]{1,1,2,3,5,8,13} );
        System.out.println("intMethod: " + square);
        System.out.println("booleanMethod: " + bool);
        System.out.println("stringMethod: " + text);
        System.out.println("intArrayMethod: " + sum);
    }
}

PS:native关键字表示此方法由外部实现。

2.编译Java代码

3.创建C/C++头文件

头文件分析：

JNIEXPORT：导出函数表示符号，JNICALL是调用约定（默认是stdcall）,函数名是由Java前缀加类名在加方法名。jint，jboolean, jstring, jintarray和jobect是Java映射到C/C++中的类型，所有对应数据类型列表参加附录。JNIEnv：是Java虚拟机给我们提供的可调用的API。如下图

更多的常见jni.h

PS：参数中的jobject形参传递的是一个当前类对象的引用

4.编写C/C++的实现

#include "Sample1.h"
#include <string.h>

/*
 * Class:     Sample1
 * Method:    intMethod
 * Signature: (I)I
 */
JNIEXPORT jint JNICALL Java_Sample1_intMethod
  (JNIEnv * env, jobject obj, jint num)
{
    return num * num;
}

/*
 * Class:     Sample1
 * Method:    booleanMethod
 * Signature: (Z)Z
 */
JNIEXPORT jboolean JNICALL Java_Sample1_booleanMethod
  (JNIEnv * env, jobject obj, jboolean boolValue)
{
    return !boolValue;
}

/*
 * Class:     Sample1
 * Method:    stringMethod
 * Signature: (Ljava/lang/String;)Ljava/lang/String;
 */
JNIEXPORT jstring JNICALL Java_Sample1_stringMethod
  (JNIEnv * env, jobject obj, jstring strValue)
{
    const char* str = (*env)->GetStringUTFChars(env, strValue, 0);
    char cap[128];
    strcpy(cap, str);
    (*env)->ReleaseStringUTFChars(env, strValue, str);
    return (*env)->NewStringUTF(env, strupr(cap));
}

/*
 * Class:     Sample1
 * Method:    intArrayMethod
 * Signature: ([I)I
 */
JNIEXPORT jint JNICALL Java_Sample1_intArrayMethod
  (JNIEnv * env, jobject obj, jintArray arrayValue )
{
    int i, sum = 0;
    jsize len = (*env)->GetArrayLength(env, arrayValue);
    jint* data = (*env)->GetIntArrayElements(env, arrayValue, 0);
    for (i = 0; i < len; ++i)
    {
        sum += data[i];
    }
    (*env)->ReleaseIntArrayElements(env, arrayValue, data, 0);
    return sum;
}

5.创建一个共享库

如果对使用cl命令生产动态库不熟悉，可以使用VS生成动态库。

6.运行Java代码

四、C/C++调用Java

• 使用场景

1. 在开发Android平台的游戏时，也需要通过Jni来调用第三方平台SDK。
2. 你想要去实现一个平台无关的代码。
3. 你想在本地代码中使用Java编写的代码。
4. 你想使用Java标准库带来的好处。

• 使用步骤

通常我们完成C/C++调用Java需要以下4步

1. 编写Java代码。使用Java代码去完成我们需要完成的功能 。
2. 编译Java代码。 将编写好的Java代码生成字节码。
3. 编写C/C++代码。用于去调用我们Java编写的代码
4. 运行本地代码。

• 示例代码

1. 编写Java代码,如下：

import java.lang.String;

public class Sample2
{
    public Sample2(String strValue)
    {
        _strValue = strValue;
    }
    public static int intMethod(int n)
    {
        return n*n;
    }

    public static boolean booleanMethod(boolean bool)
    {
        return !bool;
    }

    public void SetString(String str)
    {
        _strValue = str;
    }

    public String GetString()
    {
        return _strValue;
    }

    private String _strValue ;
}

2. 编译Java代码

   

3. 编写C/C++代码

这一步也是最关键的一步，因为这里牵涉到Jni API的调用，比如创建JVM,在JVM中查找类，查找方法和调用方法。更多的API可以参见jni.h头文件。

所有Java的字节码都必须在JVM中执行，所有我们的第一件事情就是要创建JVM。如何创建呢？调用JDK提供的库文件（jvm.dll或jvm.so）中的函数。

// CCallJava.cpp : Defines the entry point for the console application.
//

#include "stdafx.h"

#include <jni.h>
#include <string.h>
#include <exception>

int _tmain(int argc, _TCHAR* argv[])
{
    //构造初始化参数
    JavaVMOption options;
    JavaVMInitArgs vm_args;
    JNIEnv* env;
    JavaVM* jvm;
    long status;
    jclass cls;
    jmethodID mid;
    jint square;
    jboolean not;

    options.optionString = "-Djava.class.path=./../../";
    memset(&vm_args, 0, sizeof(vm_args));
    vm_args.version = JNI_VERSION_1_2;
    vm_args.nOptions = 1;
    vm_args.options = &options;

    //创建JVM
    status = JNI_CreateJavaVM(&jvm, (void**)&env, &vm_args);
    if (status != JNI_ERR)
    {
        cls = env->FindClass("Sample2");
        if (cls != 0 )
        {
            //获取构造函数
            jmethodID cstrctMid = env->GetMethodID(cls, "<init>", "(Ljava/lang/String;)V");
            jobject obj = 0;
            if (cstrctMid != 0)
            {
                jstring strValue = env->NewStringUTF("This is testing string.");
                obj = env->NewObject(cls, cstrctMid, strValue);
            }

            mid = env->GetStaticMethodID( cls, "intMethod", "(I)I");
            if (mid != 0 )
            {
                square = env->CallStaticIntMethod(cls, mid, 5);
                printf("Result of intMethod: %d
", square);
            }

            mid = env->GetStaticMethodID(cls, "booleanMethod", "(Z)Z");
            if (mid != 0 )
            {
                not = env->CallStaticBooleanMethod(cls, mid, 1);
                printf("Result of booleanMethod: %d
", not);
            }

            mid = env->GetMethodID(cls, "SetString", "(I)V");
            if (mid != 0)
            {
                env->CallVoidMethod(obj, mid, 100);
            }

            mid = env->GetMethodID(cls, "GetString", "()Ljava/lang/String;");
            if (mid != 0)
            {
                jstring str = (jstring)(env->CallObjectMethod(obj, mid));
                const char* strResult = env->GetStringUTFChars(str, false);
                printf("Result of GetString: %s
", strResult);
            }
        }
        jvm->DestroyJavaVM();
    }
    getchar();
}

Ps:

（1）如果你的是64的JDK在变编译C++的时候务必选择x64位的程序。

（2）在使用C++中使用java的非基础数据类型时，请注意在后面加上分号。例如：

一个public String GetString()Java函数，对应的C++的签名则是这样的："()Ljava/lang/String;"

五、高级

六、附录

附录A:JNI的类型

附录B:JNI方法的签名的组成规则

注意：

（1）class类型的最后一个分号不是分割符号，而是这个类型的结束标志。

（2）必须使用（/）代替(.)来作为包之间的分割。