项目实践-SpringBoot项目集成JNA实现C接口调用

项目实践-SpringBoot项目集成JNA实现C接口调用

**书山有路勤为径，学海无涯苦作舟**
记录程序员生活点点滴滴，希望记录的内容能帮助到努力爬山的各位伙伴！

标签：SpringBoot/Jna/C++

前言

1. 业务场景：在项目开发过程中，会存在Java服务需要调用C++服务的业务场景，或者是同一类产品，开发人员希望只维护C++版本的产品，Java应用可以对C++版本的产品进行封装使用，避免在产品中因增加不同语言逻辑而导致产品的复杂度和维护成本增加，因此采用Jna的方式实现需求。

JNA是什么？

JNA（Java Native Access ）提供一组Java工具类用于在运行期间动态访问系统本地库（native library：如Window的dll）而不需要编写任何Native/JNI代码。开发人员只要在一个java接口中描述目标native library的函数与结构，JNA将自动实现Java接口到native function的映射。
JNA调用C++过程：

SpringBoot集成Jna

1. Maven地址pom依赖

 <dependency>
     <groupId>net.java.dev.jna</groupId>
     <artifactId>jna-jpms</artifactId>
     <version>5.11.0</version>
 </dependency>

2. 加载动态链接库文件（dll文件）
   SpringBoot项目中加载C++动态链接库文件.这里需要注意的是,不仅需要加载业务相关的动态链接库文件,其依赖的动态库文件要一并引入,否则调用无法执行.

SpringBoot使用Jna

• C结构体定义

//C++结构体
typedef struct _BsSubTagResult
{
    const char*             name;       // 
    uint64_t                subId;      // 
    uint32_t                result;     // 
} Struct;

package com.supcon.mare.structure.bsRtdStructure;
 
import com.sun.jna.Pointer;
import com.sun.jna.Structure;
 
/**
 * @author Timao
 * @Description Java中结构体定义
 * @packageName com.structure
 * @date 2022-05-16 17:35
 * @Version 1.0.0
 */
@Structure.FieldOrder({"name", "subId", "result"})
public class Struct extends Structure {
    //name
    public String name;
    //subId
    public long subId;
    // result
    public int result;
 
    public Struct () {
    }
 
    public Struct (Pointer pointer) {
        super(pointer);
        read();
    }
 
    //定义值传递和指针传递类
    public static class ByReference extends Struct implements Structure.ByReference {
        //指针和引用的传递使用ByReference
        public ByReference() {
        }
    }
 
    public static class ByValue extends Struct Struct implements Structure.ByValue {
        //拷贝参数传递使用ByValue
        public ByValue() {
        }
    }
}

• C回调函数定义

/****************************************************
* 函 数 名 ：callBack
* 说    明    ：Timao C++中回调函数定义
* 参    数    ：
* [userHandle]              - [out] 
* [result]                  - [out] 
* [groupName]               - [out] 
* [groupId]                 - [out] 
* [clientId]                - [out] 
*****************************************************/
typedef void (*callBack)(void* userHandle,uint32_t result, const char * groupName, uint32_t groupId,uint64_t clientId);

/**
 * @Description Timao Java中对应回调函数定义
 * @Author Timao
 * @Date 2022/5/16 16:51
 */
interface callBack extends StdCallLibrary.StdCallCallback {
    void JavaCallBack(Pointer userHandle, int result, String groupName, int groupId, long clientId);
}

/**
 * @Description Timao Java中回调函数实现
 * @Author Timao
 * @Date 2022/5/23 14:50
 */
  public class CallbackClear implements callBack{
     @Override
     public void JavaCallBack(Pointer userHandle, int result, String groupName, int groupId, long clientId) {
         RequestCallBack callBack = new RequestCallBack();
     }
 }

常见问题

• 回调函数持续回调出现回调失败（类似进程阻塞）
  问题描述：Java通过Jna方式请求C接口后，会持续请求回调函数，Java侧表现现象为回调函数在回调一次或者几次后就失败，类似进程阻塞。
  原因分析：Java侧在声明回调函数对象是通过下述方式声明：
  CallBack cakkBack = new CallBack();并将声明回调函数传入回调实现类中执行，这种声明方式会导致JVM回收此对象，导致动态链接库文件在请求回调时找不到回调函数对象。
  解决方式：回调函数声明应修改为：
  public static CallBack callbBack;并将callBack传入回调实现类中使用，static声明会让回调函数对象持续存活，避免系统GC，这样才能保证持续回调。
• Java侧回调函数接收C结构体数组并转换处理
  问题描述：针对C动态链接库文件在回调函数中传参为结构体数组的场景，Java侧应该怎么来接收并处理？
  原因分析：传参为结构体数组
  解决方式：C回调函数传递结构体数组，本质上传递的是单个结构体的内存地址，需要根据结构体占用的字节大小及内存首地址来计算偏移量，从而获得数组中的其他结构体对象；
  Java侧接收应该用Pointer来接收；
  若结构体占用的字节数为36，则需要考虑字节对齐的概念，将偏移量设置为40进行计算；
  Java侧的结构体定义增加读结构体：

public BsRtdSubTagResult (Pointer pointer) {
super(pointer);
read();
}

根据传值的指针计算偏移量
Pointer pointer = data.share(i*40);（data为Java侧接收的指向结构体数组的指针，i为获取第几个元素，40为偏移量）
转换成结构体：
Structure structure = new Structure(pointer);
最终会得到对应结构体数组长度的多个结构体对象，继续向下进行业务处理。

• Java通过Jna请求C接口，传参为结构体数组
  问题描述：C接口请求入参为结构体数组，要求Java在通过Jna发送请求是要先组装结构体数组；
  原因分析：C接口入参为结构体数组；
  解决方式：Java侧通常以List方式传参，需要将集合转换成结构体数组

// 结构体数组长度
int length = JavaDto.size();
// 定义结构体数组
Struct[] struct = (Struct[])new Struct().toArray(length);
// 处理参数
for (int i = 0; i < length; i ++) {
    JavaDtocell = JavaDto.get(i);
    struct [i].devName = cell.getDevName();
    struct [i].ioAddr = cell.getIoAddr();
    struct [i].clientHandle = cell.getClientHandle();
}

其中subIOAddrsDto为List<bean>集合，这个地方采用Structure.toArray(length)
注意：这里创建数组使用JNA的toArray()方法，而不是常规创建数组的方法，是因为Java中内存地址是不连续的，JNA定义数组需要使用toArray()方法，这样实例化出来的数组内存空间是连续的。

总结

登山路上的慕码人，理解不透的地方还请各位指点！
欢迎大家多多指正交流！