使用Java调取C++动态库

使用Java调取C++动态库

使用java调用C++动态库（Windows下为.dll文件，Linux为.so文件）。调用时需要一下步骤：

1. 编写C/C++文件。即实现的主要功能文件
2. 将编写的C/C++文件生成为动态库文件，并使用main函数验证动态库的正确性
3. 书写接口函数。即书写java与C/C++的数据映射函数
4. 将生成的动态库使用java调用

编写C/C++文件

本文只为表明较为简单的Java调用C++动态库方法，但网上博客大多使用int，float作为返回值，其意义不大。所以本文使用了结构体。即首先构建一个三维坐标的结构体，然后调用C++函数后使的三维坐标全部加1。具体代码如下。

// inter.h
#include
struct Point
{
    float x, y, z;
};


Point add(Point p);

// test.cpp
#include
#include"inter.h"

Point add(Point point){
    point.x += 1;
    point.y += 1;
    point.z += 1;
    return point;

}

上述函数可以将给的三维坐标点都加1。

生成动态库并验证正确性

本文开发环境为Ubuntu，所以生成的动态库为.so文件。但在Windows下生成动态库的验证方法应该大致相同。

首先将test.cpp生成.so文件

g++ test.cpp -fPIC -shared -o libadd.so

其中

-fPIC表示生成位置无关代码

-shared表示生成一个动态链接库

动态编译库必须为libXXX.so，其中XXX表示动态库名称

生成动态库时需要将库目录引用到当前目录，不然可能会编译出错

export LD_LIBRATY_PATH=./:$LD_LIBRATY_PATH

---

验证需要验证文件以及链接方法。验证文件如下所示

// main.cpp
#include
#include"inter.h"

int main(){
    Point point = {1,2,3};
    Point a = add(point);
    std::cout << a.x << ' ' << a.y << ' ' << a.z << std::endl;
    return 1;
}

需要将其编译并连接动态库

g++ main.cpp -L. -ladd -o main

-L 表示添加库文件的搜索路径

**-l **为指定需要链接的库，本文中指定链接库名为add

上述命令将生成main可执行文件，使用./main即可执行，结果为2 3 4。如下图所示

论证得出生成的动态库正确

可以使用nm -g libadd.so命令查看so文件的内部

书写Java接口并与Java对接

书写Java与C++对接的接口最终要的是数据的对接，其中int、float等返回相对简单，如果要返回array等数组、列表的形式，需要返回指针以及长度

java的工程结构如下图所示

将动态库拉入linux-x86-64中即可使用

java中需要添加jna依赖

    <dependencies>
        <dependency>
            <groupId>net.java.dev.jna</groupId>
            <artifactId>jna</artifactId>
            <version>5.3.1</version>
        </dependency>
    </dependencies>

首先是Java代码的编写

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

import java.awt.*;

public class test {
    // java
    public interface JnaLibrary extends Library {
        JnaLibrary INSTANCE = Native.load("add", JnaLibrary.class); // 引入add.so动态库

        Point jna_add(Point.ByValue ponit); // 定义使用方式

        @Structure.FieldOrder({"x", "y", "z"}) // 构建结构体
        public static class Point extends Structure {

            public Point() {}
            public static class UserValue extends Point implements Structure.ByValue {
                public UserValue(float x, float y, float z) {
                    super(x, y, z);
                }
            }

            public Point(float x, float y, float z) {
                this.x = x;
                this.y = y;
                this.z = z;
            }

            public float x;
            public float y;
            public float z;
        }
    }


    public static void main(String[] args) {
        JnaLibrary.Point.UserValue startPoint = new JnaLibrary.Point.UserValue(1, 2, 3);
        JnaLibrary.Point a = JnaLibrary.INSTANCE.jna_add(startPoint);
        
        System.out.println(a.x);
        System.out.println(a.y);
        System.out.println(a.z);
    }
}

Java中引入com.sun.jna.Structure是因为C++中坐标使用结构体表示。所以需要在Java中构建结构体。具体解释如文中注释所示

由于仅需要返回一个array，所以没有返回长度信息。如果要返回一个列表，需要返回长度方便输出

在C++中的java接口如下所示

#ifdef __cplusplus
extern "C"{	// 扩展为C
#endif

    Point* jna_add(Point point){
        Point a = add(point);
        Point *ans = new Point[1];
        for(int i = 0; i < 1; ++i){
            ans[i].x = a.x;
            ans[i].y = a.y;
            ans[i].z = a.z;
        }
        return ans;
    }

#ifdef __cplusplus
}
#endif

使用C扩展是因为C的函数名不会变，如果使用C++变量名会发生乱码现象

阅读代码可以看出，返回的是第一个结构体的指针，所以如果返回的为一个数组，需要返回长度信息才能输出结果。

在idea中运行java代码的结果如下图所示

参考

JNA 教程

Overview (JNA API)

gcc/g++ 链接库的编译与链接

g++编译详解

java调用动态库dll/so（二）jna结构体Structure介绍和使用

java高级用法之:JNA中的Structure

Linux下编译动态链接库与使用详解

export LD_LIBRARY_PATH 的使用