使用Cgo让go调用C的代码

使用Cgo让go调用C的代码

官方文档地址：https://golang.org/cmd/cgo

package rand

/*
#include <stdlib.h>
*/
import "C"

func Random() int {
	return int(C.random)
}

func Seed(i int) {
	C.srandom(C.uint(i))
}

观察这段代码的特点

• C包：C包是一个伪包，Go中并没有这个包，Cgo会将C这个名字作为C语言的名称空间
• rand包包含了四个C包的引用，调用C.random，调用C.uint(i)，数据转换C.uint(i)，和import语句
• Random方法调用了标准C库的random方法，并返回了一个结果，在C中，random返回一个C类型的long，在cgo中用C.long表示，C类型的变量在被传递给该包外部使用前一定要转换为go自己的类型

下面的这个写法使用了一个临时变量，这种转换写法更加明确

func Random() int {
	var r C.long = C.random()
	return int(r)
}

Seed方法进行了逆向操作（从go的类型转换为C的类型），将一个普通的Go int类型转换为C中的unsigned int类型，并将其传入C的srandom方法

func Seed(i int) {
	C.srandom(C.uint(i))
}

需要注意的是cgo中unsigned int是C.uint，关于cgo中数字类型的名称的完整列表请参阅https://golang.org/cmd/cgo

这个例子中尚未解释的一个细节是在import语句上面的注释

/*
#include <stdlib.h>
*/
import "C"

cgo会识别这些注释，所有以#cgo开头后跟随一个空格符的行被称为cgo指令，在这个例子中，这些C代码仅有一行#include语句，但这里可以是任意的C代码，#cgo指令被用来提供各种flag给编译器和连接器

需要注意的是：如果你的程序中使用了 “//export”来实现一个函数，在C代码中可以这样声明“extern int f();”，只需要声明，不需要定义，这样便可以让C代码调用到Go的函数
#go 和 //export 指令参考cgo的文档https://golang.org/cmd/cgo

String

不同于go，C并没有一个明确的string类型，字符串在C中使用结尾为0的char数组来表示
接下来的例子实现了一个Print方法，通过使用C标准库中的fputs方法向标准输出输出一个字符串

package print
// #include <stdio.h>
// #include <stdlib.h>
import "C"
import "unsafe"
func Print(s string) {
	cs := C.CString(s)
	C.fputs(cs, (*C.FILE)(C.stdout))
	C.free(unsafe.Pointer(cs)) // 释放分配在C中的内存，否则会造成内存泄露
}

需要注意的是C.CString方法会分配C内存，这些内存无法被go的内存管理器识别，当你使用了C.CString或其他方式分配了C内存，一定更要记得使用C.free进行释放

调用 C.CString 返回一个指向数组开始的指针，所以需要在方法结束前，将其转换为一个unsafe.Pointer并且使用C.free进行内存释放，在使用cgo时更加习惯性的做法是通过defer进行延迟调用，尤其是当之后的代码是一长串复杂的代码，而不是一句简单的调用。

func Print(s string) {
	cs := C.String(s)
	defer C.free(unsafe.Pointer(cs))
	C.fputs(cs, (*C.FILE)(C.stdout))
}

构建

构建 cgo 包通常仅需要使用 go build 或者 go install，go工具会识别特殊的“C”包，并自动使用cgo

更多信息

更多信息官方文档