引言
在实际项目开发中，文件解析是高频且核心的业务场景，而我们近期遇到了一个典型的技术挑战：核心的文件解析逻辑需依赖第三方以 C 语言编写的底层接口，无法直接通过 Java 代码实现。为了高效复用这套成熟的 C 接口能力，同时兼顾 SpringBoot 项目的整体技术架构，我们最终选择基于 JNA（Java Native Access）技术实现 Java 与 C 代码的跨语言调用，既规避了重复开发的成本，也保证了接口调用的稳定性。
引入依赖
| JDK 版本 | 推荐 JNA 版本 | 可选 JNA 版本 |
|---|---|---|
| JDK 6/7 | 4.5.2（生产推荐） | 4.0.0 ~ 4.5.2 |
| JDK 8 | 5.13.0（生产推荐） | 5.0.0 ~ 5.15.0 |
| JDK 9/10/11 | 5.15.0（生产推荐） | 5.8.0 ~ 5.19.0 |
| JDK 17+（LTS） | 5.19.0（生产推荐） | 5.15.0 ~ 最新 5.x |
<!-- JNA核心 -->
<dependency>
<groupId>net.java.dev.jna</groupId>
<artifactId>jna</artifactId>
<version>5.13.0</version> <!-- 稳定版，兼容JDK8，不踩null坑 -->
</dependency>
<!-- JNA平台适配（跨系统必备，自动识别win/linux库） -->
<dependency>
<groupId>net.java.dev.jna</groupId>
<artifactId>jna-platform</artifactId>
<version>5.13.0</version>
</dependency>
环境变量
- 概念介绍：.dll是 Windows 系统的动态链接库（存 C 写的接口），.so 文件是 Linux 系统的同款文件，Java 通过 JNA 就能调用这两个文件里的 C 接口实现文件解析。
- 由于第三方提供的可能是
- 单个.dll文件（或单个.so文件）
- 也有可能是一整个文件夹，文件夹里面有要使用的.dll动态链接库文件，还有很多其他的dll依赖（Qt5Gui.dll、QtSvg.dll等）还有很多文件夹（iconengines、imageformats、platforms、styles、translations等文件夹）
- 如果这个.dll动态链接库是用QT写的代码的话，可能就会是第二种情况，这种情况需要我们配置QT插件环境变量（尝试过用代码解决，耗时两天，解决不了配置环境变量问题，所以还是需要我们手动配一下QT插件的环境变量）
- 假设上图的文件夹名为library，路径为D:\library
- QT_QPA_PLATFORM_PLUGIN_PATH 该环境变量配置主要是为了让QT打包的C代码去找到他所需要的依赖，告诉动态库文件的
- 注意：后续这整个文件夹都会拉到项目里面，所以最后配置的路径还要改的
代码实现
- 我们需要在项目根目录下创建 static 文件夹并放入 library，这样做能避免该文件夹被打包进 jar 包；部署时将 static 文件夹放在 jar 包同级目录，可方便配置 QT 依赖的环境变量。
- 注意：如果假设有两个动态链接库的话，下方的接口映射区就要写两个接口，接口里面对应各自的动态库的方法，三个动态库也是同理
public class ClibraryService{
private static ObjectMapper objectMapper = new ObjectMapper();
private static final TypeReference<Map<String, Object>> MAP_TYPE_REF = new TypeReference<Map<String, Object>>() {};
// =========== 静态代码块动态库地址配置区 ===========
static {
// 1、拼接路径
String path = System.getProperty("user.dir")+File.separator+"static"+File.separator+"library";
// 2、告诉jna去哪里找动态库
// 写法一：这种写法在jna5.0+的时候被标记为已过时，这么写如果有多个动态库就需要写好几行的这个add
NativeLibrary.addSearchPath("ProcessLib",path); // 找ProcessLib这个动态库的时候去这个文件夹路径下找（就是接口文件）
// 写法二：直接告诉jna所有的动态库都去这个路径下找
System.setProperty("jna.library.path",path);
// 拓展：如果多个dll在不同路径下
// String path1 = System.getProperty("user.dir")+File.separator+"static"+File.separator+"library1";
// String path2 = System.getProperty("user.dir")+File.separator+"static"+File.separator+"library2";
// String allPaths = path1 + File.pathSeparator + path2;
// System.setProperty("jna.library.path",allPaths);
}
// =========== 内嵌接口区 ===========
private interface ProcessLib extends Library{
ProcessLib INSTANCE = Native.load( // 参数一 动态库名称，参数二：接口字节码我就
"ProcessLib", // jna在windows环境会用ProcessLib.dll，linux的会用ProcessLib.so的动态库
ProcessLib.class // 本接口的字节码我就
);
// 获取phy文件信息
boolean getPhyBaseInfo(String phyFilePath,Memory outResult);
// phy转csv
boolean exportFileCsv(String fileName,String outPath);
}
// =========== 接口映射区 ===========
// 获取phy文件信息
public static Map<String,Object> getPhyBaseInfo(String phyFilePath){
Memory memory = new Memory(4*1024*1024); // 缓冲区
boolean b = ProcessLib.INSTANCE.getPhyBaseInfo(phyFilePath,memory);
if(!b) return Collections.emptyMap();
String result = memory.getString(0,StandardCharsets.UTF_8.name()).trim();
try {
return objectMapper.readValue(result, MAP_TYPE_REF);
} catch (IOException e) {// 记录原始内容便于排查
System.err.println("Invalid JSON from native call: [" + result + "]");
return Collections.emptyMap(); // 或抛业务异常
}
}
// phy转csv
public static boolean exportFileCsv(String fileName,String outPath){
boolean b = ProcessLib.INSTANCE.exportFileCsv(fileName,outPath);
return b;
}
}
部署目录结构（jar 同级）：
your-app/
├── your-app.jar
├── static/
│ └── library/
│ ├── ProcessLib.dll
│ ├── Qt5Core.dll
│ ├── platforms/
│ │ └── qwindows.dll
│ └── ...
└── start.bat ← 设置 QT_QPA_PLATFORM_PLUGIN_PATH（其实一般会给部署人员一个配置QT环境变量的脚本）
- 注意：可以对第三方接口的返回结果进行JSON转Map的原因是因为行业内规范规定：当给第三方提供接口调用时，需遵循RESTful规范，使用资源化URL和HTTP方法，数据返回格式统一使用json格式。
参数类型对应
| C 表达式 | Java 类型（JNA） | 说明 |
|---|---|---|
const char*（输入字符串） | String | JNA 自动转换为 UTF-8（可配置）的 C 字符串 |
char*（输出字符串） | byte[] 或 Pointer | 若函数写入缓冲区，用 byte[]；若返回新指针，用 Pointer + getString() |
int | int | 用于模拟 C 中的 &var |
bool (C99) | boolean | 1 字节的布尔类型 |
- 这里主要说明一下输出字符串：
public class ClibraryService{
private static ObjectMapper objectMapper = new ObjectMapper();
private static final TypeReference<Map<String, Object>> MAP_TYPE_REF = new TypeReference<Map<String, Object>>() {};
... 省略一些代码 ...
// char*对应方式一，byte[]:
public static Map<String,Object> getPhyBaseInfo(String phyFilePath){
byte[] buf = new byte[4*1024*1024]; // 注意如果缓冲区给的大小不够的话，会截断返回值内容
Arrays.fill(buf, (byte) 0); // 可选，这么做可以确保不会读到旧数据
boolean b = ProcessLib.INSTANCE.getPhyBaseInfo(phyFilePath,buf); // 调用C代码
if(!b) return Collections.emptyMap(); // 如果接口返回false，我们可以处理一下
// 如果是true，那么我们要将缓冲区中返回的数据处理一下
String result = Native.toString(buf,"UTF-8").trim(); // 遇到第一个 \0（null 字节）就停止
try {
return objectMapper.readValue(result, MAP_TYPE_REF); // 返回的内容是JSON字符串，我们可以转成java的map来使用，我一般喜欢用Jackson
} catch (IOException e) {// 记录原始内容便于排查
System.err.println("Invalid JSON from native call: [" + result + "]");
return Collections.emptyMap(); // 或抛业务异常
}
}
// char*对应方式二，Pointer:
public static Map<String,Object> getPhyBaseInfo(String phyFilePath){
Memory memory = new Memory(4*1024*1024); // 缓冲区（Memory是Pointer的子类）
boolean b = ProcessLib.INSTANCE.getPhyBaseInfo(phyFilePath,memory);
if(!b) return Collections.emptyMap();
String result = memory.getString(0,StandardCharsets.UTF_8.name()).trim();
try {
return objectMapper.readValue(result, MAP_TYPE_REF); // 返回的内容是JSON字符串，我们可以转成java的map来使用，我一般喜欢用Jackson
} catch (IOException e) {// 记录原始内容便于排查
System.err.println("Invalid JSON from native call: [" + result + "]");
return Collections.emptyMap(); // 或抛业务异常
}
}
}
注意事项
- 64位的jdk只能运行64位的动态库文件，32位的jdk只能运行32位的动态库文件，如果jdk和dll位数没对应上，用jna调用的话就会报错
- dll动态库要放到library文件夹直属下级中，不能再继续嵌套子文件夹（就是放在上图的文件夹中，和Qt5Gui.dll这些依赖放一起就好了）
- 不要将动态库放在
src/main/resources下因为打包后它会被打进 JAR，我们就没法配置QT的环境变量了 - 静态代码块里面由于jvm加载机制问题，建议不要使用Paths工具类，File创建路径，可能会导致路径出错
- JNA 自身的库搜索路径 ≠ Qt 插件路径！所以我们既要处理JNA路径搜索（静态代码块内容），也要指定QT插件路径（我们配的环境变量）
286
扫一扫
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
