较具体的介绍JNI

JNI事实上是Java Native Interface的简称,也就是java本地接口。它提供了若干的API实现了和Java和其它语言的通信（主要是C&C++）。或许不少人认为Java已经足够强大，为什么要须要JNI这样的东西呢？我们知道Java是一种平台无关性的语言，平台对于上层的java代码来说是透明的，所以在多数时间我们是不须要JNI的，可是假如你遇到了例如以下的三种情况之中的一个呢？

1. 你的Java代码，须要得到一个文件的属性。可是你找遍了JDK帮助文档也找不到相关的API。
2. 在本地另一个别的系统，只是他不是Java语言实现的，这个时候你的老板要求你把两套系统整合到一起。
3. 你的Java代码中须要用到某种算法，只是算法是用C实现并封装在动态链接库文件（DLL）其中的。

对于上述的三种情况，假设没有JNI的话，那就会变得异常棘手了。就算找到解决方式了，也是费时费力。事实上说究竟还是会添加�开发和维护的成本。

说了那么多一通废话，如今进入正题。看过JDK源代码的人肯定会注意到在源代码里有非常多标记成native的方法。这些个方法仅仅有方法签名可是没有方法体。事实上这些naive方法就是我们说的 java native interface。他提供了一个调用（invoke）的接口，然后用C或者C++去实现。我们首先来编写这个“桥梁”.我自己的开发环境是 j2sdk1.4.2_15 + eclipse 3.2 + VC++ 6.0，先在eclipse里建立一个HelloFore的Javaproject，然后编写以下的代码。

package com.chnic.jni;

public class SayHellotoCPP {
	
	public SayHellotoCPP(){
	}
	public native void sayHello(String name);
}

 一般的第一个程序总是HelloWorld。今天换换口味，把world换成一个名字。我的native本地方法有一个String的參数。会传递一个name到后台去。本地方法已经完毕，如今来介绍下javah这种方法，接下来就要用javah方法来生成一个相相应的.h头文件。

javah是一个专门为JNI生成头文件的一个命令。CMD打开控制台之后输入javah回车就能看到javah的一些參数。在这里就不多介绍我们要用的是 -jni这个參数，这个參数也是默认的參数，他会生成一个JNI式的.h头文件。在控制台进入到project的根文件夹，也就是HelloFore这个文件夹，然后输入命令。

javah -jni com.chnic.jni.SayHellotoCPP

命令运行完之后在project的根文件夹就会发现com_chnic_jni_SayHellotoCPP.h 这个头文件。在这里有必要多句嘴，在运行javah的时候，要输入完整的包名+类名。否则在以后的測试调用过程中会发生java.lang.UnsatisfiedLinkError这个异常。

到这里java部分算是基本完毕了，接下来我们来编写后端的C++代码。（用C也能够，仅仅只是cout比printf用起来更快些，所以这里俺偷下懒用C++）打开VC++首先新建一个Win32 Dynamic-Link libraryproject，之后选择An empty DLL project空project。在这里我C++的project是HelloEnd，把刚刚生成的那个头文件复制到这个project的根文件夹里。随便用什么文本编辑器打开这个头文件，发现有一个例如以下的方法签名。

/*
 * Class:     com_chnic_jni_SayHellotoCPP
 * Method:    sayHello
 * Signature: (Ljava/lang/String;)V
 */
JNIEXPORT void JNICALL Java_com_chnic_jni_SayHellotoCPP_sayHello
  (JNIEnv *, jobject, jstring);

细致观察一下这种方法，在凝视上标注类名、方法名、签名（Signature），至于这个签名是做什么用的，我们以后再说。在这里最重要的是 Java_com_chnic_jni_SayHellotoCPP_sayHello这种方法签名。在Java端我们运行 sayHello(String name)这种方法之后，JVM就会帮我们唤醒在DLL里的Java_com_chnic_jni_SayHellotoCPP_sayHello这种方法。因此我们新建一个C++ source file来实现这种方法。

#include <iostream.h>
#include "com_chnic_jni_SayHellotoCPP.h"


JNIEXPORT void JNICALL Java_com_chnic_jni_SayHellotoCPP_sayHello 
  (JNIEnv* env, jobject obj, jstring name)
{
	const char* pname = env->GetStringUTFChars(name, NULL);
	cout << "Hello, " << pname << endl;
}

由于我们生成的那个头文件是在C++project的根文件夹不是在环境文件夹，所以我们要把尖括号改成单引號，至于VC++的环境文件夹能够在 Tools->Options->Directories里设置。F7编译project发现缺少jni.h这个头文件。这个头文件能够在%JAVA_HOME%/include文件夹下找到。把这个文件复制到C++project文件夹，继续编译发现还是找不到。原来是由于在我们刚刚生成的那个头文件中，jni.h这个文件是被 #include <jni.h>引用进来的，因此我们把尖括号改成双引號#include “jni.h”，继续编译发现少了jni_md.h文件，接着在%JAVA_HOME%/include/win32以下找到那个头文件，放入到project根文件夹，F7编译成功。在Debug文件夹里会发现生成了HelloEnd.dll这个文件。

这个时候后端的C++代码也已经完毕，接下来的任务就是怎么把他们连接在一起了，要让前端的java程序“认识并找到”这个动态链接库，就必须把这个DLL放在windows path环境变量以下。有两种方法能够做到：

1. 把这个DLL放到windows以下的sysytem32目录以下，这个是windows默认的path
2. 复制你project的Debug文件夹，我这里是C:/Program Files/Microsoft Visual Studio/MyProjects/HelloEnd/Debug这个文件夹，把这个文件夹配置到User variable的Path以下。重新启动eclipse，让eclipse在启动的时候又一次读取这个path变量。

比較起来，另外一种方法比較灵活，在开发的时候不用来回copy dll文件了，节省了非常多工作量，所以在开发的时候推荐用另外一种方法。在这里我们使用的也是另外一种，eclipse重新启动之后打开 SayHellotoCPP这个类。事实上我们上面做的那些是不是是让JVM能找到那些DLL文件，接下来我们要让我们自己的java代码“认识”这个动态链接库。添�System.loadLibrary(“HelloEnd”);这句到静态初始化块里。

package com.chnic.jni;

public class SayHellotoCPP {
	
	static{
		System.loadLibrary("HelloEnd");
	}
	public SayHellotoCPP(){
	}
	public native void sayHello(String name);
	
}

这样我们的代码就能认识并载入这个动态链接库文件了。万事俱备，仅仅欠測试代码了，接下来编写測试代码。

		SayHellotoCPP shp = new SayHellotoCPP();
		shp.sayHello("World");

我们不让他直接Hello，World。我们把World传进去，运行代码。发现控制台打印出来Hello, World这句话。就此一个最简单的JNI程序已经开发完毕。或许有朋友会对CPP代码里的

	const char* pname = env->GetStringUTFChars(name, NULL);

 这句有疑问，这个GetStringUTFChars就是JNI给developer提供的API，我们以后再讲。在这里不得不多句嘴。

1. 由于JNI有一个Native这个特点，一点有项目用了JNI，也就说明这个项目基本不能跨平台了。
2. JNI调用是相当慢的，在实际使用的之前一定要先想明确是否有这个必要。
3. 由于C++和C这种语言很灵活，一不小心就easy出错，比方我刚刚的代码就没有写析构字符串释放内存，对于java developer来说由于有了GC 垃圾回收机制，所以大多数人没有写析构函数这种概念。所以JNI也会添加�程序中的风险，增大程序的不稳定性。

事实上在Java代码中，除了对本地方法标注nativekeyword和加上要载入动态链接库之外，JNI基本上是对上层coder透明的，上层coder调用那些本地方法的时候并不知道这种方法的方法体到底是在哪里，这个道理就像我们用JDK所提供的API一样。所以在Java中使用JNI还是非常easy的，相比之下在C++中调用java，就比前者要复杂的多了。

如今来介绍下JNI里的数据类型。在C++里，编译器会非常据所处的平台来为一些主要的数据类型来分配长度，因此也就造成了平台不一致性，而这个问题在Java中则不存在，由于有JVM的缘故，所以Java中的基本数据类型在全部平台下得到的都是同样的长度，比方int的宽度永远都是32位。基于这方面的原因，java和c++的基本数据类型就须要实现一些mapping，保持一致性。以下的表能够概括：

上面的表格是我在网上搜的，放上来给大家对照一下。对于每一种映射的数据类型，JNI的设计者事实上已经帮我们取好了对应的别名以方便记忆。假设想了解一些更加仔细的信息，能够去看一些jni.h这个头文件，各种数据类型的定义以及别名就被定义在这个文件里。

了解了JNI中的数据类型，下面就来看这次的样例。这次我们用Java来实现一个前端的market（下面就用Foreground取代）用CPP来实现一个后端factory（下面用backend取代）。我们首先还是来编写包括本地方法的java类。

package com.chnic.service;

import com.chnic.bean.Order;

public class Business {
	static{
		System.loadLibrary("FruitFactory");
	}
	
	public Business(){
		
	}
	
	public native double getPrice(String name);
	public native Order getOrder(String name, int amount);
	public native Order getRamdomOrder();
	public native void analyzeOrder(Order order);
	
	public void notification(){
		System.out.println("Got a notification.");
	}
	
	public static void notificationByStatic(){
		System.out.println("Got a notification in a static method.");
	}
}

这个类里面包括4个本地方法，一个静态初始化块载入将要生成的dll文件。剩下的方法都是非常普通的java方法，等会在backend中回调这些方法。这个类须要一个名为Order的JavaBean。

package com.chnic.bean;

public class Order {
	
	private String name = "Fruit";
	private double price;
	private int amount = 30;
	
	public Order(){
		
	}

	public int getAmount() {
		return amount;
	}
 
	public void setAmount(int amount) {
		this.amount = amount;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public double getPrice() {
		return price;
	}

	public void setPrice(double price) {
		this.price = price;
	}
}

JavaBean中，我们为两个私有属性赋值，方便后面的样例演示。到此为止除了測试代码之外的Java端的代码就所有高调了，接下来进行生成.h 头文件、建立C++project的工作，在这里就一笔带过，不熟悉的朋友请回头看第一篇。在project里我们新建一个名为Foctory的C++ source file 文件，去实现那些native方法。详细的代码例如以下。

#include <iostream.h>
#include <string.h>
#include "com_chnic_service_Business.h"

jobject getInstance(JNIEnv* env, jclass obj_class);

JNIEXPORT jdouble JNICALL Java_com_chnic_service_Business_getPrice(JNIEnv* env, 
																   jobject obj, 
																   jstring name)
{
	const char* pname = env->GetStringUTFChars(name, NULL);
	cout << "Before release: "  << pname << endl;

	if (strcmp(pname, "Apple") == 0)
	{
		env->ReleaseStringUTFChars(name, pname);
		cout << "After release: " << pname << endl;
		return 1.2;
	} 
	else
	{
		env->ReleaseStringUTFChars(name, pname);
		cout << "After release: " << pname << endl;
		return 2.1;
	}	
}


JNIEXPORT jobject JNICALL Java_com_chnic_service_Business_getOrder(JNIEnv* env, 
																   jobject obj, 
																   jstring name, 
																   jint amount)
{
	jclass order_class = env->FindClass("com/chnic/bean/Order");
	jobject order = getInstance(env, order_class);
	
	jmethodID setName_method = env->GetMethodID(order_class, "setName", "(Ljava/lang/String;)V");
	env->CallVoidMethod(order, setName_method, name);

	jmethodID setAmount_method = env->GetMethodID(order_class, "setAmount", "(I)V");
	env->CallVoidMethod(order, setAmount_method, amount);

	return order;
}

JNIEXPORT jobject JNICALL Java_com_chnic_service_Business_getRamdomOrder(JNIEnv* env, 
																		 jobject obj)
{
	jclass business_class = env->GetObjectClass(obj);
	jobject business_obj = getInstance(env, business_class);

	jmethodID notification_method = env->GetMethodID(business_class, "notification", "()V");
	env->CallVoidMethod(obj, notification_method);

	jclass order_class = env->FindClass("com/chnic/bean/Order");
	jobject order = getInstance(env, order_class);
	jfieldID amount_field = env->GetFieldID(order_class, "amount", "I");
	jint amount = env->GetIntField(order, amount_field);
	cout << "amount: " << amount << endl;
	return order;
}


JNIEXPORT void JNICALL Java_com_chnic_service_Business_analyzeOrder (JNIEnv* env, 
																	 jclass cls, 
																	 jobject obj)
{
	jclass order_class = env->GetObjectClass(obj);
	jmethodID getName_method = env->GetMethodID(order_class, "getName", "()Ljava/lang/String;");
	jstring name_str = static_cast<jstring>(env->CallObjectMethod(obj, getName_method));
	const char* pname = env->GetStringUTFChars(name_str, NULL);

	cout << "Name in Java_com_chnic_service_Business_analyzeOrder: " << pname << endl;
	jmethodID notification_method_static = env->GetStaticMethodID(cls, "notificationByStatic", "()V");
	env->CallStaticVoidMethod(cls, notification_method_static);

}

jobject getInstance(JNIEnv* env, jclass obj_class)
{
	jmethodID construction_id = env->GetMethodID(obj_class, "<init>", "()V");
	jobject obj = env->NewObject(obj_class, construction_id);
	return obj;
}

能够看到，在我Java中的四个本地方法在这里所有被实现，接下来针对这四个方法来解释下，一些JNI相关的API的用法。先从第一个方法讲起吧：

1.getPrice(String name)

这种方法是从foreground传递一个类型为string的參数到backend，然后backend推断返回对应的价格。在cpp的代码中，我们用GetStringUTFChars这种方法来把传来的jstring变成一个UTF-8编码的char型字符串。由于jstring的实际类型是 jobject，所以无法直接比較。

GetStringUTFChars方法包括两个參数，第一參数是你要处理的jstring对象，第二个參数是否须要在内存中生成一个副本对象。将 jstring转换成为了一个const char*了之后，我们用string.h中带strcmp函数来比較这两个字符串，假设传来的字符串是“Apple”的话我们返回1.2。反之返回 2.1。在这里还要多说一下ReleaseStringUTFChars这个函数，这个函数从字面上不难理解，就是释放内存用的。有点像cpp里的析构函数，仅仅只是Sun帮我们已经封装好了。因为在JVM中有GC这个东东，所以多数java coder并没有写析构的习惯，只是在JNI里是必须的了，否则easy造成内存泄露。我们在这里在release之前和之后分别打出这个字符串来看一下效果。

粗略的解释完一些API之后，我们编写測试代码。

		Business b = new Business();		
		System.out.println(b.getPrice("Apple"));

执行这段測试代码，控制台上打出

Before release: Apple
After release: ??
1.2

在release之前打印出来的是我们“须要”的Apple，release之后就成了乱码了。因为传递的是Apple，所以得到1.2。測试成功。

2. getOrder(String name, int amount)

在foreground中能够通过这种方法让backend返回一个你“指定”的Order。所谓“指定”，事实上也就是指方法里的两个參数：name和amout，在cpp的代码在中，会依据传递的两个參数来构造一个Order。回到cpp的代码里。

jclass order_class = env->FindClass("com/chnic/bean/Order");

是不是认为这句代码似曾相识？没错，这句代码非常像我们java里写的Class.forName(className)反射的代码。事实上在这里 FindClass的作用和上面的forName是相似的。仅仅只是在forName中要用完整的类名，可是在这里必须用”/”来取代“.”。这种方法会返回一个jclass的对象，事实上也就是我们在Java中说的类对象。

jmethodID construction_id = env->GetMethodID(obj_class, "<init>", "()V");
jobject obj = env->NewObject(obj_class, construction_id);

拿到”类对象”了之后，依照Java RTTI的逻辑我们接下来就要唤醒那个类对象的构造函数了。在JNI中，包含构造函数在内的全部方法都被看成Method。每一个method都有一个特定的ID，我们通过GetMethodID这种方法就能够拿到我们想要的某一个java 方法的ID。GetMethodID须要传三个參数，第一个是非常显然jclass，第二个參数是java方法名，也就是你想取的method ID的那个方法的方法名（有些绕口 ），第三个參数是方法签名。

 在这里有必要单独来讲一讲这种方法签名，为什么要用这个东东呢？我们知道，在Java里方法是能够被重载的，比方我一个类里有public void a(int arg)和public void a(String arg)这两个方法，在这里用方法名来区分方法显然就是行不通的了。方法签名包含两部分：參数类型和返回值类型；详细的格式：(參数1类型签名參数2类型签名)返回值类型签名。以下是java类型和年名类型的对比的一个表

事实上除了自己对比手写之外，JDK也提供了一个非常好用的生成签名的工具javap,cmd进入控制台到你要生成签名的那个类的文件夹下。在这里用 Order类打例如，敲入： javap -s -private Order。全部方法签名都会被输出，关于javap的一些參数能够在控制台以下输入 javap -help查看。（做coder的 毕竟还是要认几个单词的）

啰嗦了一大堆，还是回到我们刚刚的getMethodID这种方法上。由于是调用构造函数，JNI规定调用构造函数的时候传递的方法名应该为<init> ,通过javap查看 我们要的那个无參的构造函数的方法签是()V。得到方法签名，最后我们调用NewObject方法来生成一个新的对象。

拿到了对象，之后我们開始为对象jobject填充数值，还是首先拿到setXXX方法的Method ID，之后调用Call<Type>Method来调用java方法。这里的<Type>所指的是方法的返回类型，我们刚刚调用的是set方法的返回值是void，因此这里的方法也就是CallVoidMethod，这种方法的參数除了前两个要传入jobject和 jmethodID之外还要传入要调用的那个方法的參数，并且要顺序必须一致，这点和Java的反射一模一样，在这里就不多解释。（看到这一步是不是对 java 反射又有了自己新的理解？）

最终介绍完了第二个方法，下来就是測试代码測试。

		Order o = b.getOrder("Watermelom", 100);
		System.out.println("java: " + o.getName());
		System.out.println("java: " + o.getAmount());

控制台打出

java: Watermelom
java: 100

就此，我们完毕了第二个方法的測试。

jclass business_class = env->GetObjectClass(obj);

	jfieldID amount_field = env->GetFieldID(order_class, "amount", "I");
	jint amount = env->GetIntField(order, amount_field);
	cout << "amount: " << amount << endl;

		Business b = new Business();				 
		Order o2 = b.getRamdomOrder();
		System.out.println(o2.getName());

	jstring name_str = static_cast<jstring>(env->CallObjectMethod(obj, getName_method));

		Business b = new Business();		
		Order o = b.getOrder("Watermelom", 100);
		Business.analyzeOrder(o);