SWIG初体验
SWIG是什么
SWIG,Simplified Wrapper and Interface Generator,这是一个封装C/C++动态库供其他编程语言调用的神器。
以Java为例,想通过JAVA程序调用C/C++动态库的话,就必须先通过SWIG生成一堆JAVA接口,这堆JAVA接口的方法实现就通过native方法去调用相应的C/C++动态库接口。例如笔者这个量化交易平台项目,由于交易所提供的接口全是用C++写的,但笔者只熟JAVA不熟C++,于是就要借助SWIG做了一层转换:
路径northstar-gateway-ctp/src/main/java/xyz/redtorch/gateway/ctp/x64v6v3v15v/api下的全是SWIG生成出来的JAVA接口。
SWIG的安装
在官网下载相应的安装包。笔者的系统是Linux的。
解压安装包后,进入到swig目录,复制以下命令进行编译:
./configure --prefix=/usr \
--without-maximum-compile-warnings &&
make
编译后,复制以下命令进行安装(要用root用户)
make install &&
install -v -m755 -d /usr/share/doc/swig-4.0.2 &&
cp -v -R Doc/* /usr/share/doc/swig-4.0.2
文件准备
假设我们要封装的C/C++文件如下,命名为example.c :
/* File : example.c */
#include <time.h>
double My_variable = 3.0;
int fact(int n) {
if (n <= 1) return 1;
else return n*fact(n-1);
}
int my_mod(int x, int y) {
return (x%y);
}
char *get_time()
{
time_t ltime;
time(<ime);
return ctime(<ime);
}
另外,我们还要定义一个接口定义脚本i文件:
/* example.i */
%module example
%{
/* Put header files here or function declarations like below */
extern double My_variable;
extern int fact(int n);
extern int my_mod(int x, int y);
extern char *get_time();
%}
extern double My_variable;
extern int fact(int n);
extern int my_mod(int x, int y);
extern char *get_time();
开始封装
执行以下命令,SWIG会根据example.i接口定义脚本生成出若干个文件:
swig -java example.i
从JAVA的角度讲,接口的封装已经完成,但native方法要调用相应的动态库要通过以下命令来打包。注意,这里是坑点。以下命令不能照搬,因为以下命令是要通过本地的JAVA环境的include目录中的动态库来进行编译,不同的环境要自己改成适合的路径。
gcc -c -fPIC example.c example_wrap.c -I/usr/lib/jvm/jdk-11.0.9/include -I/usr/lib/jvm/jdk-11.0.9/include/linux
再执行以下命令,进行链接打包
gcc -shared -o example.so example.o example_wrap.o
验证
写个main程序验证一下。注意这里也有坑,动态库的加载有两种方法,一是System.load加载绝对路径中的文件,一是System.loadLibrary加载系统库的默认路径。
public class main {
public static void main(String argv[]) {
System.load("/home/kevin/Documents/Cpp/example.so");
System.out.println(example.getMy_variable());
System.out.println(example.fact(5));
System.out.println(example.get_time());
}
}
编译JAVA文件,执行
javac main.java
java main
可以见到执行成功
后语
大概两年前,我看SWIG时有点完全看不懂的感觉。现在重新看觉得也不是特别难懂,只要明白JAVA调用动态库的原理,加上理解C/C++编译过程,便可以轻松上手SWIG,用熟悉的语言来调用动态库了。
参考资料
https://www.linuxfromscratch.org/blfs/view/cvs/general/swig.html