使用JNA，让java调用原生代码

Posted 2020-10-24 zhchoutai

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了使用JNA，让java调用原生代码相关的知识，希望对你有一定的参考价值。

JNA定义：

JNA：java Native Access，是SUN公司开发的基于JNI的框架。JNI使得Java可以调用原生的c或者c++代码。

JNA与JNI(Java Native Interface)的差别：

性能：JNA在性能上不如JNI。由于JNA是在JNI的基础上封装了一层。
移植性：JNA的可移植性要好于JNI，由于开发人员不须要再编写作为代理的动态链接库。
使用：JNI使用native关键字，使用一个个java方法映射原生方法，利用System.loadLibrary；JNA使用一个java借口来代表动态链接库。使用Native.loadLibrary

JNA使用环境安装：

原生代码：使用C++或者C编写原生代码，或者使用已有的原生代码。在准备在java中使用的函数或者class前注明extern “C” __declspec(dllexport)。然后打包成动态链接库dll
Java代码：下载jna.jar，https://github.com/java-native-access/jna。然后把dll文件放在详细的project以下。

JNA使用：

1. 准备dll(这部分针对刚開始学习的人。可直接浏览第2部分)
我们从生成dll到利用JNA，使用Java调用dll一步一步解说。
首先生成dll。为了学习JNA。最好我们自己动手生成dll，我是使用Dev C++(http://sourceforge.net/projects/orwelldevcpp/) 这个工具来编写c++代码的。安装Dev C++之后，我们创建一个dllproject。
技术分享图片
然后我们创建一个.h文件以及一个.cpp文件。我们须要在.h里面define：

#if BUILDING_DLL
#define DLLIMPORT extern "C" __declspec(dllexport)
#else
#define DLLIMPORT extern "C" __declspec(dllimport)
#endif

然后我们在.h定义两个Struct以及两个函数function:

struct UserStruct{
    long id;
    wchar_t* name;
    int age;
};
DLLIMPORT
void sayUser(UserStruct* pUserStruct);
struct CompanyStruct{
    long id;
    wchar_t* name;
    UserStruct* users[100];
    int count;
};
DLLIMPORT
void sayCompany(CompanyStruct* pCompanyStruct);

这里须要注意，函数声明前须要加DLLIMPORT，这里DLLIMPORT等于extern “C” __declspec(dllexport)，Struct前不须要做特殊的处理。
在.cpp文件里实现sayUser以及sayCompany两个函数：

void sayUser(UserStruct* pUserStruct)
{
    std::wcout<<L"hello:"<<pUserStruct->name<<std::endl;
}

sayUser函数的功能是把UserStruct结构体中的的name打印出来

void sayCompany(CompanyStruct* pCompanyStruct)
{
    std::wcout<<L"hello:"<<pCompanyStruct->name<<std::endl;
    for(int i=0;i<pCompanyStruct->count;i++)
    {
        UserStruct* user=pCompanyStruct->users[i];
        sayUser(user);
    }
}

SayCompany函数的功能是把Company结构体中的name打印出来，同一时候把里面全部UserStruct成员的name打印出来。
然后我们在cpp文件里实现

BOOL WINAPI DllMain(HINSTANCE hinstDLL,DWORD fdwReason,LPVOID lpvReserved)
{
    return TRUE;
}

然后编译生成dll文件，由于我定义的project名字叫做JNATest，所以生成的dll文件叫做JNATest.dll。

2. Java使用JNA调用dll
我们须要创建一个interface，这里我们取名TestDll1，然后extends Library。我们须要把UserStruct和CompanyStruct两个结构体映射到java中，代码例如以下：

public class UserStruct extends Structure {
        public static class ByReference extends UserStruct implements Structure.ByReference{};
        public static class ByValue extends UserStruct implements Structure.ByValue{}
        public NativeLong id;
        public WString name;
        public int age;
}

当中ByReference指的是指针，ByValue指的是值，然后以下三个字段分别相应.h文件里UserStruct中的三个字段，当中顺序一定不能错。由于作为内存传给c函数调用，读取时依照c中结构体的顺序来读，所以顺序一定不能错。

同理CompanyStruct在java中的映射例如以下：

public class CompanyStruct extends Structure{
        public static class ByReference extends CompanyStruct implements Structure.ByReference{};
        public static class ByValue extends CompanyStruct implements Structure.ByValue{};
        public NativeLong id;
        public WString name;
        //须要使用toArray。由于java中的内存空间是不连续的。所以使用JNA提供的toArray方法生成连续的内存空间
        public UserStruct.ByReference[] users=(UserStruct.ByReference[]) new UserStruct.ByReference().toArray(100);
        public int count;
}

这里面有个须要特别注意的地方。否则会NULL错误。就是public UserStruct.ByReference[] users=(UserStruct.ByReference[]) new UserStruct.ByReference().toArray(100);这句话，假设改为public UserStruct.ByReference[] users=new UserStruct.ByReference[100]，之后调用就会报错。原因是java的内存空间通常是不连续的，而我们须要连续的内存空间，这里须要使用JNA提供的toArray函数生成数组。
以下一段代码非常重要就是加载dll：

TestDll1 INSTANCE=(TestDll1) Native.loadLibrary("JNATest",TestDll1.class);

然后声明我们要在java中调用的原生函数：

public void sayUser(UserStruct userStruct);
public void sayCompany(CompanyStruct companyStruct);

然后我们创建一个Test.java，然后在main函数中測试能否调用原生函数。

首先測试sayUser：

UserStruct.ByReference userStruct=new UserStruct.ByReference();
userStruct.id=new NativeLong(100);
userStruct.age=30;
userStruct.name=new WString("SBY");
TestDll1.INSTANCE.sayUser(userStruct);

然后执行。会打印出hello:SBY
再測试sayCompany：

CompanyStruct.ByReference companyStruct=new CompanyStruct.ByReference();
companyStruct.id=new NativeLong(2);
companyStruct.name=new WString("hehe");
companyStruct.count=10;
UserStruct.ByReference pUserStruct=new UserStruct.ByReference();
pUserStruct.id=new NativeLong(90);
pUserStruct.age=99;
pUserStruct.name=new WString("sby");
//pUserStruct.write();
for(int i=0;i<companyStruct.count;i++){
    companyStruct.users[i]=pUserStruct;
}
TestDll1.INSTANCE.sayCompany(companyStruct);

会输出一个hello:hehe和10个hello:sby
有些地方会说须要pUserStruct.write()这行代码，目的是把内存固定住，而不被GC释放掉，然而在我測试的时候没有加这一行也能准确执行。预计这个JNA提供的toArray函数有关。

以上就是我的JNA学习心得。之所以会在machine learning的博客中插入这样一篇，基本的目的是大多数的machine leanring的代码都是使用c或者c++编写。而一些场景会须要编写java程序。此时我们须要使用java来调用已经写好的c或者c++函数。
以上源码传送门：http://yun.baidu.com/share/link?

shareid=2278504517&uk=3977203577