CGO:让Go程序调用C函数的神器

CGO:让Go程序调用C函数的神器

在现代软件开发中，多语言编程已经成为了一种趋势。而在多语言编程中，Go语言作为一种高效、简洁、安全的语言，越来越受到开发者的青睐。但是，由于Go语言本身并不支持直接调用C函数，因此需要借助CGO这个工具来实现这一功能。本文将详细介绍如何使用CGO来调用C函数，让你的Go程序更加强大！

一、引入C库

要使用CGO调用C函数，首先需要引入C库。在Go中，可以使用import "C"语句来引入C库。例如，我们想要调用C标准库中的printf函数，可以这样写：

// hello.go
package main

import "C"

func main() {
    println("hello cgo")
}

代码通过import "C"语句启用CGO特性，主函数只是通过Go内置的println函数输出字符串，其中并没有任何和CGO相关的代码。虽然没有调用CGO的相关函数，但是go build命令会在编译和链接阶段启动gcc编译器，这已经是一个完整的CGO程序了。

二、C库路径设置

在使用CGO调用C函数时，需要指定C库的路径。可以通过以下两种方式来设置C库路径：

2.1. 在编译时指定路径

可以在编译命令中使用-L选项来指定C库的路径。例如：

go build -o myapp -L/path/to/clib myapp.go

其中，-L/path/to/clib表示将/path/to/clib目录添加到链接器的搜索路径中。如果有多个目录需要添加，可以用空格隔开。
本人不建议这样使用，因为不适合项目开发。

2.2. 在代码中指定路径

也可以在代码中使用#cgo语句函数来指定C库的路径。例如：

// #cgo CFLAGS: -DPNG_DEBUG=1 -I./lib
// #cgo LDFLAGS: -L${SRCDIR}/lib -lTassAPI4KMS
// #include "TassAPI4KMS.h"
// #include <stdlib.h>
import "C"

上面的代码中，CFLAGS部分，-D部分定义了宏PNG_DEBUG，值为1；-I定义了头文件包含的检索目录。LDFLAGS部分，-L指定了链接时库文件检索目录，-l指定了链接时需要链接png库。

因为C/C++遗留的问题，C头文件检索目录可以是相对目录，但是库文件检索目录则需要绝对路径。在库文件的检索目录中可以通过${SRCDIR}变量表示当前包目录的绝对路径：

// #cgo LDFLAGS: -L${SRCDIR}/libs -lfoo

#cgo语句主要影响CFLAGS、CPPFLAGS、CXXFLAGS、FFLAGS和LDFLAGS几个编译器环境变量。LDFLAGS用于设置链接时的参数，除此之外的几个变量用于改变编译阶段的构建参数(CFLAGS用于针对C语言代码设置编译参数)。

三、本地GCC环境设置

要使用CGO特性，需要安装C/C++构建工具链，在macOS和Linux下是要安装GCC，在windows下是需要安装MinGW工具或VS工具。同时需要保证环境变量CGO_ENABLED被设置为1，这表示CGO是被启用的状态。在本地构建时CGO_ENABLED默认是启用的，当交叉构建时CGO默认是禁止的。比如要交叉构建ARM环境运行的Go程序，需要手工设置好C/C++交叉构建的工具链，同时开启CGO_ENABLED环境变量。然后通过import "C"语句启用CGO特性。具体的安装步骤可以参考官方文档。

3.1window安装MinGW工具或VS工具

官网下载安装即可，有需要安装包的私信我，发你。

3.2 环境变量CGO_ENABLED被设置为1

//命令行设置环境变量
go env -w CGO_ENABLED=1

四、CGO代码编写

在编写CGO代码时，需要注意以下几点：

4.1. 数据类型

确保传递给C函数的参数类型和返回值类型与C函数定义一致。例如，如果C函数接受一个整数参数并返回一个整数值，那么在Go代码中也需要传递一个整数参数并返回一个整数值。否则，可能会导致编译错误或运行时错误。

4.2. 指针类型

如果需要传递指针参数给C函数，可以使用unsafe.Pointer()函数将其转换为指向void类型的指针。完整代码如下：

package main

// #cgo CFLAGS: -DPNG_DEBUG=1 -I./lib
// #cgo LDFLAGS: -L${SRCDIR}/lib -lTassAPI4KMS
// #include "TassAPI4KMS.h"
// #include <stdlib.h>
import "C"
import (
	"fmt"
	"unsafe"
)

func main() {
	//将配置文件路径转为C字符串
	var cfg = C.CString("D:/goproject/gotest/gocfgKMS.ini")
	//分配设备句柄指针内存
	var phDevice unsafe.Pointer
	//释放设备句柄指针内存
	defer C.free(unsafe.Pointer(cfg))
	//调用C函数并将结果转换为Go整数类型
	result := int(C.Tass_KMS_Initialize(cfg, &phDevice))
	//打印调用的结果
	fmt.Printf("Result: %d\n", result)
}

五、注意事项

window环境需要同时将c库放到C:\Windows\System32路径下才能生效，切记，否则将报错：找不到文件。

Process finished with the exit code -1073741515 (0xC0000135)

从今天开始，go语言知识持续分享中，期待各位一起学习。