本文原名《使用JNA方便地调用原生函数》发表于2009年3月的“程序员”杂志上。感谢程序员杂志的许可，使这篇文章能够成为免费的电子版，发布于网络上。

程序员杂志发表此文时，略有裁剪，因此本文比程序员上的文章内容更多。

JNA的API参考手册和最新版本的pdf文档，可以在如下地址下载：

http://code.google.com/p/shendl/downloads/list

PDF格式文档可在http://download.csdn.net/source/1503487免费下载。

和许多解释执行的语言一样，Java提供了调用原生函数的机制，以加强Java平台的能力。Java™ Native Interface (JNI)就是Java调用原生函数的机制。

事实上，很多Java核心代码内部就是使用JNI实现的。这些Java功能实际上是通过原生函数提供的。

但是，使用JNI对Java开发者来说简直是一场噩梦。

如果你已经有了原生函数，使用JNI，你必须使用C语言再编写一个动态链接库，这个动态链接库的唯一功能就是使用Java能够理解的C代码来调用目标原生函数。

这个没什么实际用途的动态链接库的编写过程令人沮丧。同时编写Java和C代码使开发难度大大增加。

因此，在Java开发社区中，人们一直都视JNI为禁地，轻易不愿涉足。

缺少原生函数的协助使Java的使用范围大大缩小。

反观.NET阵营，其P/Invoke技术调用原生函数非常方便，不需要编写一行C代码，只需要写Annotation就可以快速调用原生函数。因此，与硬件有关的很多开发领域都被.NET所占据。

介绍

JNA(Java NativeAccess)框架是一个开源的Java框架，是SUN公司主导开发的，建立在经典的JNI的基础之上的一个框架。

JNA项目地址：https://jna.dev.java.net/

JNA使Java调用原生函数就像.NET上的P/Invoke一样方便、快捷。

JNA的功能和P/Invoke类似，但编写方法与P/Invoke截然不同。JNA没有使用Annotation，而是通过编写一般的Java代码来实现。

P/Invoke是.NET平台的机制。而JNA是Java平台上的一个开源类库，和其他类库没有什么区别。只需要在classpath下加入jna.jar包，就可以使用JNA。

JNA使Java平台可以方便地调用原生函数，这大大扩展了Java平台的整合能力。

实现原理

JNI 是Java调用原生函数唯一的机制。JNA也是建立在JNI技术之上的。它简化了Java调用原生函数的过程。

JNA提供了一个动态的C语言编写的转发器，可以自动实现Java和C的数据类型映射。你不再需要编写那个烦人的C动态链接库。

当然，这也意味着，使用JNA技术比使用JNI技术调用动态链接库会有些微的性能损失。可能速度会降低几倍。但对于绝大部分项目来说，影响不大。

调用原生函数

让我们先看一个JNA调用原生函数的例子。

使用JNA调用原生函数

假设我们有一个动态链接库，发布了这样一个C函数：

void  say(wchar_t* pValue){

std::wcout.imbue(std::locale('chs'));

std::wcout<

}

它需要传入一个Unicode编码的字符数组。然后在控制台上打印出一段中文字符。

为了调用这个原生函数，使用JNA，我们需要编写这样的Java代码：

publicinterface TestDll1 extends Library {

TestDll1 INSTANCE =(TestDll1)Native.loadLibrary('TestDll1', TestDll1.class);

public void say(WString value);

}

这里，如果动态链接库是以stdcall方式输出函数，那么就继承StdCallLibrary。

然后就可以像普通的Java程序那样调用这个接口：

public static void main(String[] args) {

TestDll1.INSTANCE.say(newWString('Hello World!'));

System.out.println('Java输出。');

}

执行，可以看到控制台下如下输出：

原生函数说：Hello World!

Java输出。

调用原生函数的模式

JNA不使用native关键字。

JNI使用native关键字，使用一个个Java方法来代表外部的原生函数。

而JNA使用一个Java接口来代表一个动态链接库发布的所有函数。

对于不需要的原生函数，你可以不在Java接口中声明Java方法原型。

如果使用JNI，你需要使用System.loadLibrary方法，把我们专为JNI编写的动态链接库载入进来。这个动态链接库实际上是我们真正需要的动态链接库的代理。

上例中使用JNA类库的Native类的loadLibrary方法 ，是直接把我们需要的动态链接库载入进来。使用JNA，我们不需要编写作为代理的动态链接库，不需要编写一行原生代码。

上面的JNA代码使用了单例，接口的静态变量返回的是接口的唯一实例，这个Java对象是JNA通过反射动态创建的。通过这个对象，我们可以调用动态链接库发布的函数。

和原生代码的类型映射

跨平台、跨语言调用的最大难点，就是不同语言之间数据类型不一致造成的问题。绝大部分跨平台调用的失败，都是这个问题造成的。

JNA使用的数据类型是Java的数据类型。而原生函数中使用的数据类型是原生函数的编程语言使用的数据类型。可能是C,Delphi,汇编等语言的数据类型。因此，不一致是在所难免的。

JNA提供了Java和原生代码的类型映射。

和操作系统数据类型的对应表

支持常见的数据类型的映射

尽量使用基本、简单的数据类型；

尽量少跨平台、跨语言传递数据！

如果有复杂的数据类型需要在Java和原生函数中传递，那么我们就必须在Java中模拟大量复杂的原生类型。这将大大增加实现的难度，甚至无法实现。

如果在Java和原生函数间存在大量的数据传递，那么一方面，性能会有很大的损失。更为重要的是，Java调用原生函数时，会把数据固定在内存中，这样原生函数才可以访问这些Java数据。这些数据，JVM的GC不能管理，会造成内存碎片。

如果在你需要调用的动态链接库中，有复杂的数据类型和庞大的跨平台数据传递。那么你应该另外写一些原生函数，把需要传递的数据类型简化，把需要传递的数据量简化。

模拟结构体

在原生代码中，结构体是经常使用的复杂数据类型。这里我们研究一下怎样使用JNA模拟结构体。

使用JNA调用使用Struct的C函数

假设我们现在有这样一个C语言结构体

struct UserStruct{

long id;

wchar_t*  name;

int age;

};

使用上述结构体的函数

#define MYLIBAPI  extern   'C'     __declspec( dllexport )

MYLIBAPI void sayUser(UserStruct* pUserStruct);

对应的Java程序中，在例1的接口中添加下列代码：

Java中的调用代码：

说明

现在，我们就在Java中实现了对C语言的结构体的模拟。

这里，我们继承了Structure类，用这个类来模拟C语言的结构体。

必须注意，Structure子类中的公共字段的顺序，必须与C语言中的结构的顺序一致。否则会报错！

因为，Java调用动态链接库中的C函数，实际上就是一段内存作为函数的参数传递给C函数。

动态链接库以为这个参数就是C语言传过来的参数。

同时，C语言的结构体是一个严格的规范，它定义了内存的次序。因此，JNA中模拟的结构体的变量顺序绝对不能错。

如果一个Struct有2个int变量。  Int a, int b

如果JNA中的次序和C中的次序相反，那么不会报错，但是数据将会被传递到错误的字段中去。

Structure类代表了一个原生结构体。当Structure对象作为一个函数的参数或者返回值传递时，它代表结构体指针。当它被用在另一个结构体内部作为一个字段时，它代表结构体本身。

另外，Structure类有两个内部接口Structure.ByReference和Structure.ByValue。这两个接口仅仅是标记，如果一个类实现Structure.ByReference接口，就表示这个类代表结构体指针。如果一个类实现Structure.ByValue接口，就表示这个类代表结构体本身。

使用这两个接口的实现类，可以明确定义我们的Structure实例表示的是结构体的指针还是结构体本身。

上面的例子中，由于Structure实例作为函数的参数使用，因此是结构体指针。所以这里直接使用了UserStruct userStruct= new UserStruct ();

也可以使用UserStruct userStruct= new UserStruct.ByReference ();

明确指出userStruct对象是结构体指针而不是结构体本身。

模拟复杂结构体

C语言最主要的数据类型就是结构体。结构体可以内部可以嵌套结构体，这使它可以模拟任何类型的对象。

JNA也可以模拟这类复杂的结构体。

结构体内部可以包含结构体对象的数组

JNA中可以这样模拟：

这里，必须给users字段赋值，否则不会分配100个UserStruct结构体的内存，这样JNA中的内存大小和原生代码中结构体的内存大小不一致，调用就会失败。

结构体内部可以包含结构体对象的指针的数组

JNA中可以这样模拟：

测试代码：