Java通过JNA调用dll或so

前言

场景：某些功能已有C语言实现，现有Java业务系统需要引入。

这种情况下，如果用Java重写一遍可能更加费时费力，不如将此C语言功能编译为一个系统库，供Java调用。

1 引入JNA

pom文件添加依赖

<!-- https://mvnrepository.com/artifact/net.java.dev.jna/jna -->
<dependency>
	<groupId>net.java.dev.jna</groupId>
	<artifactId>jna</artifactId>
	<version>4.5.2</version>
</dependency>

2 Windows系统调用dll

设dll文件名为libtest.dll，将其放置于此Java文件同文件夹下或项目resources目录。

调用demo代码

import com.sun.jna.Library;
import com.sun.jna.Native;

public class JavaCallDllDemo {

    public interface CLibrary extends Library {
        // DLL文件默认路径为项目根目录，若DLL文件存放在项目外，请使用绝对路径
    	CLibrary INSTANCE = (CLibrary) Native.load("libtest", CLibrary.class);
        // 声明将要调用的DLL中的方法（可以是多个方法）
        int add(int a, int b);
    }

    public static void main(String[] args) {
        int result = JavaCallDllDemo.CLibrary.INSTANCE.add(200, 300);
        System.out.println("result: " + result);
    }

}

注意这里代码加载库文件不需要带dll后缀

3 Linux系统调用so

设so文件名为libtest.so，将其放置于/usr/lib下，或者自定义目录，如/usr/local/lib。

自定义目录需要额外将其添加到环境变量

vim /etc/profile

在末尾添加

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib

刷新环境变量，使改动生效

source /etc/profile

调用demo代码

import com.sun.jna.Library;
import com.sun.jna.Native;

public class JavaCallSoDemo {

    public interface CLibrary extends Library {
        // SO文件默认路径为/usr/lib
    	CLibrary INSTANCE = (CLibrary) Native.load("test", CLibrary.class);
        // 声明将要调用的so中的方法（可以是多个方法）
        int add(int a, int b);
    }

    public static void main(String[] args) {
        int result = JavaCallSoDemo.CLibrary.INSTANCE.add(200, 300);
        System.out.println("result: " + result);
    }

}

注意这里代码加载库文件不需要带lib前缀和so后缀

4 兼容Windows和Linux调用

由上可以将代码整合一下，自动判断环境以决定调用名

import com.sun.jna.Library;
import com.sun.jna.Native;
import com.sun.jna.Platform;

public class JavaCallDllSoDemo {

    public interface CLibrary extends Library {
        
    	CLibrary INSTANCE = (CLibrary) Native.load(Platform.isWindows() ? "libtest" : "test", CLibrary.class);
        
        int add(int a, int b);
    }

    public static void main(String[] args) {
        int result = JavaCallDllSoDemo.CLibrary.INSTANCE.add(200, 300);
        System.out.println("result: " + result);
    }

}

5 附，生成简单dll/so

下面简要说明如何自己生成dll/so，以供测试。

这里使用工具为Dev C++。

5.1 Windows下生成dll

自行下载Dev C++， 打开，点击文件 -> 新建 -> 项目，选择dll,C项目，名称输入libtest，确定。

之后会生成一个dllmain.c文件和dll.h文件。

修改内容并保存：

dllmain.c文件

#include "dll.h"

DLLIMPORT int add(int a, int b)
{
	return a+b;
}

dll.h文件

#ifndef _DLL_H_
#define _DLL_H_

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

DLLIMPORT int add(int a, int b);

#endif

如此，就声明了一个方法，方法两个int参数，返回两数之和。

之后点击运行 -> 编译，会在项目目录下生成libtest.dll文件。

5.2 Linux下生成so

将以上dllmain.c和dll.h文件稍作修改：

dllmain.c文件

#include "dll.h"

int add(int a, int b)
{
	return a+b;
}

dll.h文件

#ifndef _DLL_H_
#define _DLL_H_

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

int add(int a, int b);

#endif

将两个文件复制到linux中，执行gcc命令

gcc dllmain.c -fPIC -shared -o libtest.so

即在当前目录下生成libtest.so文件。