
本文介绍了如何使用 Go 语言编写 Ruby 扩展。利用 Go 1.5 及以上版本提供的构建共享库的功能,我们可以直接将 Go 函数暴露给 Ruby,无需编写额外的 C 语言胶水层。通过一个简单的加法函数示例,详细讲解了 Go 代码的编写、编译以及 Ruby 中调用 Go 函数的步骤,帮助开发者快速上手,利用 Go 的高性能和并发特性来增强 Ruby 应用的功能。
使用 Go 构建 Ruby 扩展
Go 1.5 版本之后,Go 提供了构建可以从 C 代码调用的共享库的支持,这使得使用 Go 编写 Ruby 扩展变得更加容易。 相比于之前的版本,现在无需编写 C 语言胶水层,并且可以使用 Go 运行时,这使得在 Ruby 扩展中使用 goroutine 和内存分配成为可能。
1. 编写 Go 代码
首先,我们需要编写 Go 代码,其中包含我们想要暴露给 Ruby 的函数。
package main
import "C"
//export GoAdd
func GoAdd(a, b C.int) C.int {
return a + b
}
func main() {} // Required but ignored代码解释:
- package main: 声明包名为 main,这是构建共享库所必需的。
- import "C": 导入 C 包,允许 Go 代码与 C 代码交互。
- //export GoAdd: 这是一个特殊的注释,用于告诉 Go 编译器导出 GoAdd 函数。export 关键字后面的符号是函数导出的名称。
- func GoAdd(a, b C.int) C.int: 定义了一个名为 GoAdd 的函数,它接受两个 C 语言的整数作为参数,并返回它们的和。 注意,参数和返回值的类型必须是 C 语言兼容的类型,例如 C.int。
- func main() {}: main 函数是必需的,但是会被忽略。
2. 编译 Go 代码为共享库
使用以下命令将 Go 代码编译为共享库:
go build -buildmode=c-shared -o goFuncs.so goFuncs.go
命令解释:
- go build: Go 编译命令。
- -buildmode=c-shared: 指定构建模式为 c-shared,这会生成一个可以从 C 代码调用的共享库。
- -o goFuncs.so: 指定输出文件的名称为 goFuncs.so。
- goFuncs.go: Go 源代码文件。
3. 在 Ruby 中调用 Go 函数
接下来,我们需要编写 Ruby 代码来加载共享库并调用 Go 函数。
require 'ffi' module GoFuncs extend FFI::Library ffi_lib './goFuncs.so' attach_function :GoAdd, [:int, :int], :int end puts GoFuncs.GoAdd(41, 1)
代码解释:
- require 'ffi': 导入 ffi 库,它提供了在 Ruby 中调用 C 函数的功能。
- module GoFuncs: 定义一个名为 GoFuncs 的模块,用于封装 Go 函数。
- extend FFI::Library: 扩展 FFI::Library 模块,使其具有加载共享库和调用 C 函数的功能。
- ffi_lib './goFuncs.so': 指定要加载的共享库的路径。
- attach_function :GoAdd, [:int, :int], :int: 将 GoAdd 函数附加到 GoFuncs 模块。第一个参数是 Ruby 中使用的函数名称,第二个参数是参数类型列表,第三个参数是返回值类型。
- puts GoFuncs.GoAdd(41, 1): 调用 GoAdd 函数,并将结果打印到控制台。
4. 运行 Ruby 脚本
运行 Ruby 脚本,将会输出 Go 函数的计算结果:
ruby goFromRuby.rb
输出结果:
42
注意事项:
- 确保 Go 编译器版本在 1.5 及以上。
- 在编译 Go 代码时,必须使用 -buildmode=c-shared 标志。
- 在 Ruby 代码中,必须使用 ffi 库来加载共享库和调用 Go 函数。
- Go 函数的参数和返回值类型必须是 C 语言兼容的类型。
- //export 注释是必需的,用于告诉 Go 编译器导出函数。
总结:
通过以上步骤,我们成功地使用 Go 编写了一个 Ruby 扩展。 这种方法允许我们利用 Go 的高性能和并发特性来增强 Ruby 应用的功能。 随着 Go 语言的不断发展,我们可以期待更多使用 Go 编写 Ruby 扩展的场景。









