使用SWIG自动生成JNI代码

### 使用 SWIG 自动生成 JNI 代码 #### 一、SWIG 简介 SWIG（Simplified Wrapper and Interface Generator）是一个编译时软件开发工具，可生成必要的代码，将用 C/C++ 编写的本地模块与包括 Java 在内的其他编程语言连接起来。它是一个接口编译器，只是一个代码生成器，不定义新协议，也不是组件框架或专门的运行时库。 SWIG 最初于 1995 年为科学应用而开发，现在已发展成为一个通用工具，并在 GNU GPL 开源许可证下分发。更多信息可在 [www.swig.org](www.swig.org) 上找到。 #### 二、SWIG 安装 SWIG 可在所有主要平台上运行，包括 Windows、Mac OS X 和 Linux。以下是在不同平台上的安装步骤： 1. **Windows 系统安装** - 访问 [www.swig.org/download.html](www.swig.org/download.html) 下载 SWIG 安装包（ZIP 格式）。 - 下载完成后，右键点击 ZIP 文件，选择“Extract All”，使用“Browse”按钮选择目标目录（如 `C:\android`），点击“Extract”开始安装。 - 为方便使用，需将 SWIG 安装目录添加到系统可执行搜索路径。打开“System Properties”中的“Environment Variables”对话框，点击“New”，设置变量名 `SWIG_HOME`，变量值为 SWIG 安装目录（如 `C:\android\swigwin - 2.0.7`）。 - 双击系统变量中的 `PATH` 变量，在变量值后追加 `;%SWIG_HOME%`。 - 安装成功后，在命令行输入 `swig -version` 可看到 SWIG 版本号。 2. **Mac OS X 系统安装** - 由于 SWIG 官网未提供 Mac OS X 安装包，需使用 Homebrew 包管理器进行安装。首先安装 Homebrew，从 Homebrew 安装页面复制安装命令，打开终端窗口，在命令提示符处粘贴命令并按回车键开始安装。 - 安装完 Homebrew 后，在终端窗口执行 `brew install swig` 安装 SWIG。 - 安装成功后，在新终端窗口执行 `swig -version` 验证安装。 3. **Ubuntu Linux 系统安装** - 打开终端窗口，在命令提示符处执行 `sudo apt - get install swig`，系统包管理器将自动下载并安装 SWIG 及其依赖项。 - 安装成功后，在新终端窗口执行 `swig -version` 验证安装。 #### 三、通过示例体验 SWIG 在学习 SWIG 详细内容之前，通过一个示例应用来了解其工作原理。此示例将使用 `hello - jni` 示例项目作为测试平台。 1. **编写 SWIG 接口文件** - SWIG 接口文件包含函数原型、类和变量声明，语法与普通 C/C++ 头文件相同，还可包含 SWIG 特定的预处理器指令。 - 在 `hello - jni` 项目的 `jni` 目录下创建一个名为 `Unix.i` 的接口文件，内容如下： ```c /* Module name is Unix. */ %module Unix %{ /* Include the POSIX operating system APIs. */ #include <unistd.h> %} /* Tell SWIG about uid_t. */ typedef unsigned int uid_t; /* Ask SWIG to wrap getuid function. */ extern uid_t getuid(void); ``` - 下面对接口文件进行简要说明： - **注释**：以 `/*` 开头，以 `*/` 结尾的 C 风格注释行，SWIG 不处理注释行，仅用于为开发者注释接口文件。 - **模块名**：每次调用 SWIG 都需指定模块名，用于命名生成的包装文件。使用 `%module` 预处理器指令指定，应出现在每个接口文件的开头。 - **用户定义代码**：SWIG 生成包装代码时，将其分为五个部分。可使用预处理器指令指定要包含在这些部分中的代码片段，语法如下： ```c % <section> %{ ... This code block will be included into generated code as is. ... %} ``` `<section>` 部分可取以下值： | 取值 | 说明 | | ---- | ---- | | `begin` | 将代码块放在生成的包装文件开头，常用于定义文件后续部分使用的预处理器宏。 | | `runtime` | 将代码块放在 SWIG 的内部类型检查和其他支持函数旁边。 | | `header` | 将代码块放在头文件和其他辅助函数旁边的头部分，是注入代码到生成文件的默认位置，`%{ ... %}` 也可作为简写形式使用。 | | `wrapper` | 将代码块放在生成的包装函数旁边。 | | `init` | 将代码块放在加载模块时初始化模块的函数中。 | - **类型定义**：SWIG 能理解所有 C/C++ 数据类型，但会将其他类型视为对象并包装为指针。`getuid` 函数的返回类型 `uid_t` 不是标准 C/C++ 数据类型，为避免 SWIG 将其视为对象，使用 `typedef` 告知 SWIG 其实际返回类型。 - *