Linux下JAVA使用JNA调用C++的动态链接库（g++或者gcc编译的.so文件）

目录

前言        

一、准备工作

二、JAVA项目加载JNA

三、JNA的使用 

3.1 生成.so文件

        3.1.1 gcc生成的.so

         3.1.2 g++生成的.so

3.2 JNA调用.so       

四、JAVA与C++的类型对应

五、总结

---

前言        

        在没上班之前，我曾在CSDN写过《程序员的自我修养》的读书笔记，那真是一段难以忘记的时光，封控在学校里，也没法出去玩，无聊到只能看书打发时间，说多了。这本书是关于Linux的下程序的如何编译、链接的，真的推荐大家去看看，虽然我也没看完，读书笔记也才更到一半，真是遗憾，愿我能抽出时间把它啃完吧，我愿意用我的头发来换一点点知识，谁让我的头发很多掉不完呢，哈哈哈哈。

        转眼间到了工作，时间过的非常快，真是体会到了人生越过越快。这期间也装模作样的参加了公司的培训，接触到了很多非常优秀的人，觉得自己什么也不是，什么也没有，意难平。但其实每个人都有自己的命格，不属于你的永远不要强求，没必要给自己添堵，北方人的性格和思想大致就是这样吧。

        说了这么多，有什么关联呢？那就是我接到了工作后的首个Linux下的任务，曾经在学校搭建服务器、跑模型、给学弟学妹们建用户、维护等等都是在Linux下，本人对这个操作系统有较深的了解，而这次的任务是使用JAVA语言调用C++编译连接好的so动态链接库，Linux下的动态链接库就相当于Windows下的dll文件例如：msvcruntime.dll和Kernal32.dll，所以非常重要，是程序run起来后随时要加载的模块。

        工作的朋友可能会知道一个团队里有许许多多的角色，有产品、测试、开发、管理、HR等等，而开发可根据不同语言分为JAVA、C++、Python等等，他们之间也需要互相支撑，比如JAVA需要调用我们C++的方法，我的任务不就来了么。说实话，这方面的内容网上的资料真的很少，而且有错误、不统一、不全面、不明了，所以我决定更这一篇。

一、准备工作

        1. Linux操作系统，可以是Ubuntu、Centos、银河麒麟国产化系统等。可以在虚拟机上搞。

        2. JNA包，他在JNI上封了一层，可以使用封装好的方法调用so。

        JNA介绍：JNA提供工具用于调用c/c++动态函数库（如Window的dll以及linux的so）而不需要编写任何Native/JNI代码。开发人员只要在一个java接口中描述目标函数库的函数与结构，JNA将自动实现Java接口方法到函数的映射。

JNA github地址：

                        GitHub - java-native-access/jna: Java Native Access

嫌github慢可以在Gitcode镜像里下载：

                        mirrors / java-native-access / jna · GitCode

        3. JAVA的IDE，我是用的是JetBrains IntelliJ IDEA，下个Linux社区版就可以了。具体如何配置看下面链接（一定按里面要求来）：

Java小白必会！Intellij IDEA安装、配置及使用详细教程_一一哥Sun的博客-CSDN博客_idea安装配置教程

        4. JAVA11，并安装到Linux系统上，配置好环境变量，具体可以看一下链接：

推荐：LINUX 安装 JAVA11_dubhe_zhao的博客-CSDN博客_linux安装java11

二、JAVA项目加载JNA

        我默认你已经搭载好了在Linux下的JAVA环境。那么开始加载JNA吧。

        我们在github或者gitcode上下载好的JNA如下图，为jna-5.12.1.jar，你放然可以下载其他版本，不过我没试过较低的版本是否能行。

        接下来创建一个JAVA项目，可以参考上面的链接如何创建JAVA项目，这个就不贴了，太麻烦了。然后，选择file下的Project Structure，如下：

        

        接着按照步骤选择Modules->Dependences->JAR or Directories

         

        接着选择自己下载好的JNA：

        接着点击加载的jna，点击ok即可。

         

        我们可以在External Libraries中看到加载好的.jar格式的JNA包，点开里面有两个文件夹：com.sun.jna和META-INF，我们要import的方法全在com.sun.jna中，我们只关注这个就好了。

        加载成功，庆祝一下，真不容易。

三、JNA的使用 

3.1 生成.so文件

        3.1.1 gcc生成的.so

        在JNA使用前我们需要制造一个.so文件，先随便写一个gcc可以编译过的代码，gcc不链接的话仅仅可以处理简单的C语言代码，如果想使用gcc编译C++代码，需要加extern “C”字段或者链接到需要使用的库，这个就很麻烦了，但我还是说说吧，毕竟自己卡在这块很久，需要给后来者清除这坑爹的障碍。

#include <stdio.h>
#include <stdlib.h>

int add(int a,int b);
int add3(int a,int b,int c);


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

int add3(int a,int b,int c)
{
  return a+b+c;
}

        接着分别运行：

        

gcc -fpic -c Hello.c

gcc -shared -o libHello.so Hello.o

        这样就完成了gcc生成so文件，我们的文件为libHello.so。 

      

         3.1.2 g++生成的.so

        g++这里我们重新写一份cpp代码，新建一个文件夹分别建立test.h和test.cpp：

        test.h:

#ifndef TEST_H_
#define TEST_H_
int add(int a, int b);
#endif

       test.cpp:

#include <stdio.h>
int add(int a, int b)
{
	printf("test_func ==> a = %d, b = %d\n", a, b);
	return (a+b);
}

       

        使用如下命令来生成g++的so：         

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

3.2 JNA调用.so       

        到这里我们使用JNA库里的两个文件即可，Native和Library。Native主要负责.so文件的加载，我们可以调用Native.load()来加载生成好的so文件。Library负责声明so中的方法供后续调用。下面我们使用一个具体的代码片段来说明。

        以下调用gcc生成的so文件：

import com.sun.jna.Library;
import com.sun.jna.Native;
/**
 * 一个java类
 * 运行环境是linux,需要打包生成jar文件放到linux环境运行
 */
public class HelloJNA {

    /**
     * 定义一个接口，默认的是继承Library ，如果动态链接库里的函数是以stdcall方式输出的，那么就继承StdCallLibrary
     * 这个接口对应一个动态链接(SO)文件
     */
    public interface LibraryAdd extends Library {
        LibraryAdd LIBRARY_ADD = Native.load("/home/bowen/Desktop/testhello/libHello.so", LibraryAdd.class);

        /**
         * 接口中只需要定义你要用到的函数或者公共变量，不需要的可以不定义
         * 映射libadd.so里面的函数，注意类型要匹配
         */
        int add(int a, int b);
    }

    public static void main(String[] args) {
        // 调用so映射的接口函数
        int add = LibraryAdd.LIBRARY_ADD.add(10, 15);
      
        System.out.println("a,b相加结果：" + add);

    }
}

        下面来解析这段代码，前面两个import引入JNA中的方法，如果成功加载JNA是没有问题的。接着声明了HelloJNA，与.class文件名同名。在HelloJNA类中首先声明了一个接口方法，这个接口继承Library，那就继承了JNA的Library里面的方法。这个接口主要任务为加载so文件并将内部需要使用的函数导出，不要忘了加载so后还要声明一下函数名，这个和C++中.h声明函数一致，后续需要这个函数名去查找其在so中的地址，通过地址偏移锁定到方法。在Main中我们可以调用这个接口，为这个接口传入指定参数，它会回传一个返回值，到这调用so成功。

        同样调用g++却报错，错误如下：

Exception in thread "main" java.lang.UnsatisfiedLinkError: Error looking up function 'add': /home/bowen/Desktop/testhello1/libHello.so: undefined symbol: add
	at com.sun.jna.Function.<init>(Function.java:252)
	at com.sun.jna.NativeLibrary.getFunction(NativeLibrary.java:604)
	at com.sun.jna.NativeLibrary.getFunction(NativeLibrary.java:580)
	at com.sun.jna.NativeLibrary.getFunction(NativeLibrary.java:566)
	at com.sun.jna.Library$Handler.invoke(Library.java:243)
	at com.sun.proxy.$Proxy0.add(Unknown Source)
	at HelloJNA.main(HelloJNA.java:29)

        这个问题可以这样描述。gcc和g++编译后的so文件不太一样，具体就是so内部的函数Symbol不一样。gcc编译过后so里的函数名或者方法名就是我们声明的那样，具体如下：

使用命令：nm -g libHello.so

获得：        

[bowen@localhost testhello]$ nm -g libHello.so 
0000000000000675 T add
0000000000000689 T add3
0000000000201028 B __bss_start
                 w __cxa_finalize@@GLIBC_2.2.5
0000000000201028 D _edata
0000000000201030 B _end
00000000000006a8 T _fini
                 w __gmon_start__
0000000000000540 T _init
                 w _ITM_deregisterTMCloneTable
                 w _ITM_registerTMCloneTable
                 w _Jv_RegisterClasses

        这个是64位Linux的so文件内部地址与符号的对应关系，想搞懂这个得看候捷老师的“程序的生前死后”，简直了。从这个结果我们能获得到函数add和add3，这个符号就是我们之前定义的函数名，那么我们在java中声明int add（）当然没问题，可以调用起来。 

        但是我们看看g++生成的so内部长什么样：

        [bowen@localhost testhello1]$ nm -g libHello.so 
0000000000201030 B __bss_start
                 w __cxa_finalize@@GLIBC_2.2.5
0000000000201030 D _edata
0000000000201038 B _end
0000000000000708 T _fini
                 w __gmon_start__
0000000000000588 T _init
                 w _ITM_deregisterTMCloneTable
                 w _ITM_registerTMCloneTable
                 w _Jv_RegisterClasses
                 U printf@@GLIBC_2.2.5
00000000000006d5 T _Z3addii     

        它的add函数的符号变为_Z3addii，这个是g++为了防止符号重名给它生成的新名字，它的明明规则在《程序员的自我修养》里有说明，比如_Z、3、add、i、i这些都是根据原函数的特性而形成的。

        那么我们将代码中的add替换为_Z3addii可不可以呢？

a,b相加结果：25
test_func ==> a = 10, b = 15

        成功了，我们的猜测是正确的。

四、JAVA与C++的类型对应

        Java与C++类型对照表：

java类型	c++类型	原生表现
boolean	int	32位整数
byte	char	8位整数
char	wchar_t	平台依赖
short	short	16位整数
int	int	32位整数
long	long long，__int64	64位整数
float	float	32位浮点数
double	double	64位浮点数
Buffer/Pointer	pointer	平台依赖（32或64位指针）
<T>[]（基本数据类型数组）	pointer/array	32位或64位指针（参数、返回值）邻接内存（结构体成员）
String	char*	\0结束的数组（native encoding or jna.encoding）
WString	wchar_t*	\0结束的数组（Unicode）
String[]	char**	\0结束的数组的数组
WString[]	wchar_t**	\0结束的宽字符数组的数组
Structure	struct*/struct	指向结构体的指针（参数或返回值）（或者明确指定是结构体指针）、结构体（结构体的成员）（或明确指定是结构体）
Union	union	等同于结构体
Structure[]	struct[]	结构体的数组，邻接内存
Callback	（*fp）()	Java函数指针或原生函数指针
NativeLong	long	平台依赖（32或64位整数）

        demo展示：
        待更新。。。

五、总结

        总的来说java使用JNA调用C++生成的so库没有问题，后续需要java调用更加复杂的C++代码，如类中的方法、vector等。java在调用so时主要使用symbol来定位方法，另外，我们在C++代码中加入extern “C”到底改变了什么也需要探究。祝大家周末愉快，疫情期间享受世界杯。