简介
在许多情况下，我们可能需要调用一些用 C 或其他语言编写的库函数。这通常是为了访问底层系统功能，或是为了利用已经存在的高性能代码。Ruby 提供了一种名为 FFI（Foreign Function Interface）的机制，使得开发者可以直接在 Ruby 代码中调用这些外部函数。
FFI 是一种允许 Ruby 代码直接调用 C 函数的接口。它允许 Ruby 程序员使用标准 C 库中的函数，而无需编写或理解复杂的 C 扩展。这大大简化了与 C 代码的交互，并使 Ruby 成为一个更加强大和灵活的编程环境。
安装 FFI
首先，你需要安装 ffi gem。你可以通过运行以下命令来安装：
gem install ffi
或者，如果你正在使用 Bundler，可以在你的 Gemfile 中添加：
gem 'ffi'
然后运行 bundle install 来安装该 gem。
基本使用
加载库
在 Ruby 中使用 FFI 的第一步是加载你想要使用的库。例如，如果你想加载 libc（这是大多数 Unix 系统上的标准 C 库），你可以这样做：
require 'ffi' module CLib extend FFI::Library ffi_lib :c end
这里，我们定义了一个名为 CLib 的模块，并将其扩展为 FFI::Library。然后，我们通过 ffi_lib :c 来指定我们要加载 libc 库。
调用函数
一旦你加载了库，你就可以调用库中的函数。例如，libc 中有一个非常著名的函数叫做 puts，我们可以这样调用它：
result = CLib.puts("Hello, world!")请注意，puts 函数的返回值是你传递给它的字符串的长度。因此，上述代码将输出字符串 "Hello, world!" 的长度。
设置参数类型
有时，你需要明确指定函数参数的类型。例如，假设你想调用 strlen 函数，这个函数接受一个指向 C 字符串的指针，并返回该字符串的长度。你可以这样做：
-- -------------------- ---- ------- ------ ---- ------ ------------ ------- -- --------------- -------- ---------- ------- --- ------ - -------------------- ---- ------ - ----
在这个例子中，我们使用 attach_function 方法来声明 strlen 函数。我们指定了第一个参数是一个字符串 (:string)，并且函数返回一个无符号长整型 (:size_t)。
返回值类型
除了设置参数类型外，你还可以指定函数返回值的类型。例如，如果你调用一个返回整数的函数，你可以这样设置：
-- -------------------- ---- ------- ------ ---- ------ ------------ ------- -- --------------- -------- --- ---- --- --- - ------------- ---- ---
这里，我们指定了 getuid 函数没有参数 ([]) 并且返回一个整数 (:int)。
处理错误
在使用 FFI 时，处理错误非常重要。例如，如果一个函数失败，它可能会返回一个特殊的错误码。你可以通过检查返回值来判断函数是否成功执行。例如，假设你想调用 open 函数打开一个文件，但该文件不存在，那么 open 可能会返回 -1，并设置 errno 变量来指示错误原因。你可以这样处理错误：
-- -------------------- ---- ------- ------ ---- ------ ------------ ------- -- - -- ---- -- --------------- ------ --------- ------ ---- - -- ----- --------------- -------- ---------- ----- --- -------- - ---------------------- ----- - - -- - ------------------- ------ -- -- -- -- ------------------- ---
在这个例子中，如果 open 函数失败，我们通过调用 perror 函数来打印错误信息。
高级使用
结构体
有时，你可能需要传递或接收结构体作为函数的参数。FFI 支持定义和使用 C 结构体。例如，假设你想使用 struct sockaddr_in 结构体，你可以这样定义并使用它：
-- -------------------- ---- -------
------ ----
------ ------------
------- --
- -----
----- ---------- - -----------
------ ------------ -------------
---------- -----------
---------- ------- ---
---------- ------- --
---
- ----
--------------- ------ ------ -------------------- ------------ ----
---
- ---------
------- - --------------------
-------------------- - ------------
------------------ - ----
- -- ---- --
------ - -------------------- -------- --------------------------在这个例子中，我们定义了一个名为 SockaddrIn 的结构体，并使用 attach_function 方法来声明 bind 函数。
回调函数
FFI 还支持使用回调函数。回调函数是一种由外部函数调用的函数。例如，假设你想调用一个需要传递回调函数的函数，你可以这样定义和使用回调：
-- -------------------- ---- ------- ------ ---- ------ ------------ ------- -- - -------- -------- ------------ ------- ---- - ---- --------------- -------------------- -------------- ---- --- - ------ --- -------------- ---- --------- ------ ---- ----- - - - --- - -------- --- -- ------------ - ----------------------- ------- ---------------------- - --------- ------ - ------------------------------------- ---- ------
在这个例子中，我们定义了一个名为 call_with_callback 的函数，它接受一个回调函数作为参数。我们定义了一个简单的回调函数 my_callback，并通过 FFI::Function.new 方法将其转换为 FFI 类型。
自定义类型
FFI 允许你定义自己的类型，以便更好地封装和重用代码。例如，假设你想创建一个表示日期的自定义类型，你可以这样做：
-- -------------------- ---- -------
------ ----
------ ------------
------- --
- -------
----- ---- - -----------
------ ------ -----
------- -----
----- ----
---
- ----
--------------- ---------- ---------------- -----
---
- --------
---- - --------------
----------- - ----
------------ - --
---------- - -
- ----
-------------------在这个例子中，我们定义了一个名为 Date 的结构体，并使用 attach_function 方法来声明 set_date 函数。
总结
通过使用 FFI，Ruby 开发者可以轻松地与 C 库进行交互，从而实现更强大的功能。从加载库、调用函数到处理复杂的数据结构和回调函数，FFI 提供了一系列工具来简化这一过程。希望这篇教程能够帮助你在 Ruby 中更有效地使用 FFI。