SWIG是一款开源的接口编译器,它可以根据C++头文件自动生成多种高级编程语言的调用包装代码,让不同语言能够直接调用C++实现的功能,省去手动编写胶水代码的工作量。本文将以Python、Java、C#三个目标语言为例,完整演示使用SWIG生成绑定的全流程。

SWIG核心工作原理
SWIG的工作流程主要分为两步,首先解析开发者编写的接口文件(后缀为.i),提取其中的C++函数、类、变量等声明信息,然后根据指定的目标语言,生成对应的包装代码。这些包装代码会处理不同语言之间的类型转换、参数传递等细节,最终编译后就能在目标语言中调用C++的功能。
环境准备
在使用SWIG之前需要先完成环境配置,不同操作系统的安装方式略有差异:
- Windows系统:前往SWIG官方网站下载编译好的二进制包,解压后将bin目录添加到系统环境变量PATH中
- Linux系统:使用包管理器安装,比如Ubuntu可以执行
sudo apt install swig - macOS系统:使用Homebrew安装,执行
brew install swig
同时需要准备好对应目标语言的开发环境,比如Python需要安装对应版本的Python解释器和开发头文件,Java需要安装JDK,C#需要安装.NET SDK。
编写C++核心代码
首先我们编写一个简单的C++功能模块,作为后续生成绑定的基础,示例代码如下:
// math_func.h #ifndef MATH_FUNC_H #define MATH_FUNC_H // 计算两个整数的和 int add(int a, int b); // 计算两个整数的乘积 int multiply(int a, int b); #endif
// math_func.cpp
#include "math_func.h"
int add(int a, int b) {
return a + b;
}
int multiply(int a, int b) {
return a * b;
}
编写SWIG接口文件
接口文件是SWIG工作的核心输入,后缀为.i,我们需要在文件中声明要导出的C++内容,示例代码如下:
// math_func.i
%module math_func // 定义模块名称,生成的目标语言模块会使用该名称
%{
// 这部分内容会直接复制到生成的包装代码中,用于包含头文件
#include "math_func.h"
%}
// 声明要导出的函数,SWIG会自动处理这些函数的包装
int add(int a, int b);
int multiply(int a, int b);
生成Python绑定
生成Python绑定的步骤如下:
第一步:生成Python包装代码
在终端中执行以下命令,SWIG会生成math_func_wrap.cxx和math_func.py两个文件:
swig -python -c++ math_func.i
第二步:编译生成扩展模块
使用Python的distutils工具编译生成可导入的扩展模块,编写setup.py文件:
# setup.py
from distutils.core import setup, Extension
# 定义扩展模块,包含C++源文件和SWIG生成的包装文件
math_module = Extension(
'_math_func',
sources=['math_func.cpp', 'math_func_wrap.cxx'],
)
setup(
name='math_func',
version='1.0',
description='C++数学功能Python绑定',
ext_modules=[math_module],
py_modules=['math_func'],
)
执行编译命令:
python setup.py build_ext --inplace
第三步:测试Python绑定
在Python交互式环境中测试生成的绑定:
import math_func
# 调用C++实现的加法函数
result1 = math_func.add(3, 5)
print(f"3 + 5 = {result1}")
# 调用C++实现的乘法函数
result2 = math_func.multiply(4, 6)
print(f"4 * 6 = {result2}")
生成Java绑定
生成Java绑定的操作如下:
第一步:生成Java包装代码
执行以下命令,SWIG会生成math_func_wrap.cxx、math_func.java、math_funcJNI.java等文件:
swig -java -c++ math_func.i
第二步:编译C++包装代码为动态库
使用g++编译生成Java可调用的动态库,Linux系统下命令如下:
g++ -c -fPIC -I"$JAVA_HOME/include" -I"$JAVA_HOME/include/linux" math_func.cpp math_func_wrap.cxx g++ -shared -o libmath_func.so math_func.o math_func_wrap.o
Windows系统下需要生成dll文件,命令调整为:
g++ -c -I"%JAVA_HOME%include" -I"%JAVA_HOME%includewin32" math_func.cpp math_func_wrap.cxx g++ -shared -o math_func.dll math_func.o math_func_wrap.o
第三步:测试Java绑定
编写Java测试类:
// Test.java
public class Test {
static {
// 加载生成的动态库,Linux下为libmath_func.so,Windows下为math_func.dll
System.loadLibrary("math_func");
}
public static void main(String[] args) {
// 调用C++实现的加法函数
int result1 = math_func.add(3, 5);
System.out.println("3 + 5 = " + result1);
// 调用C++实现的乘法函数
int result2 = math_func.multiply(4, 6);
System.out.println("4 * 6 = " + result2);
}
}
编译并运行测试类:
javac Test.java java -Djava.library.path=. Test
生成C#绑定
生成C#绑定的步骤如下:
第一步:生成C#包装代码
执行以下命令,SWIG会生成math_func_wrap.cxx、math_func.cs等文件:
swig -csharp -c++ math_func.i
第二步:编译生成动态库
Linux系统下编译命令:
g++ -c -fPIC math_func.cpp math_func_wrap.cxx g++ -shared -o libmath_func.so math_func.o math_func_wrap.o
Windows系统下使用Visual Studio的cl编译器生成dll:
cl /LD /EHsc math_func.cpp math_func_wrap.cxx /Fe:math_func.dll
第三步:测试C#绑定
编写C#测试程序:
// Test.cs
using System;
using System.Runtime.InteropServices;
class Test {
[DllImport("math_func", CallingConvention = CallingConvention.Cdecl)]
// 声明要调用的C++函数
public static extern int add(int a, int b);
[DllImport("math_func", CallingConvention = CallingConvention.Cdecl)]
public static extern int multiply(int a, int b);
static void Main() {
// 调用C++实现的加法函数
int result1 = add(3, 5);
Console.WriteLine($"3 + 5 = {result1}");
// 调用C++实现的乘法函数
int result2 = multiply(4, 6);
Console.WriteLine($"4 * 6 = {result2}");
}
}
编译并运行测试程序:
csc Test.cs mono Test.exe # Linux下使用mono运行,Windows下直接执行Test.exe
常见问题与解决方案
- 如果函数参数包含复杂类型比如std::string,需要在接口文件中添加
%include "std_string.i"来让SWIG支持对应的类型转换 - 生成Java绑定时如果提示找不到jni.h,需要检查JAVA_HOME环境变量是否正确配置,确保路径包含include目录
- 生成C#绑定时如果出现调用约定错误,需要在DllImport特性中指定正确的CallingConvention,一般C++编译的动态库默认使用Cdecl约定
- 如果要导出C++类,只需要在接口文件中声明类的完整定义,SWIG会自动生成对应的目标语言类包装
SWIGc++_bindingPythonJavaC#修改时间:2026-07-11 12:12:16