如何 Golang 代码编译成 C 语言兼容的静态库和头文件

Go 语言支持使用 go build -buildmode=c-archive 编译命令将 Go 代码编译成 C 语言兼容的静态库 (.a 文件) 和对应的 C 头文件 (.h 文件)。这使得 Go 代码可以被其他语言（如 C/C++、Python、Java 等）通过 C 接口调用，实现了 Go 和其他语言的互操作性。

介绍

• 目的：主要用于创建可被 C 语言或 C 兼容语言调用的 Go 库
• 输出：
  • .a 文件 (静态库): 包含编译后的 Go 代码，可以链接到 C/C++ 项目中
  • .h 文件 (头文件): 声明了 Go 导出函数的 C 语言签名，供其他语言调用时使用
• 工作原理：Go 会生成一个 C 语言的包装器，将 Go 函数暴露为 C 函数，并处理 Go 运行时 (runtime) 的初始化和管理
• 适用场景：
  • 将现有 Go 库集成到非 Go 项目中
  • 为其他语言提供高性能的 Go 模块
  • 在需要与 C/C++ 代码进行深度交互的场景

使用示例

下面通过一个简单的例子来演示如何使用 go build -buildmode=c-archive。

创建 Go 库文件

• mylib.go

package main

import "C" // 必须导入 "C" 包，即使不直接使用 C 语言代码，它也负责 Go 和 C 语言之间的桥接

import "fmt"

// SayHello 是一个导出的 Go 函数，在 C 语言中可以通过 SayHello 调用
//export SayHello
func SayHello(name *C.char) {
	goName := C.GoString(name) // 将 C 字符串转换为 Go 字符串
	fmt.Printf("Hello, %s from Go!\n", goName)
}

// Add 是一个导出的 Go 函数，接受两个整数并返回它们的和
//export Add
func Add(a, b C.int) C.int {
	return a + b
}

// Go 包中的 main 函数在这里是空的，因为我们是构建库，而不是可执行程序
func main() {
	// 这个 main 函数在构建 c-archive 时不会被执行
	// 它的存在是为了让 Go 编译器认为这是一个可以被编译的包
}

关键点：

• package main: 即使是库，也需要 package main
• import "C": 必需的，用于 Go 和 C 之间的互操作性
• //export FunctionName: Go 的一个特殊注释，用于标记 Go 函数可以被 C 语言导出
  • 被 //export 注释的函数必须在紧随其后的 Go 文件的顶部，并且必须是顶级函数，参数和返回值类型也需要是 C 兼容的类型

编译 Go 库

在 mylib.go 文件所在的目录下，打开终端并运行以下命令：

go build -buildmode=c-archive -o mylib.a mylib.go

• -buildmode=c-archive: 指定编译模式为生成 C 静态库
• -o mylib.a: 指定输出的静态库文件名为 mylib.a
• mylib.go: 指定要编译的 Go 源文件

执行该命令后，你会看到当前目录下生成了两个文件：

• mylib.a (静态库文件)
• mylib.h (C 头文件)

mylib.h 文件的内容大致如下：

// Code generated by gobind. DO NOT EDIT.

#ifndef __GO_MYLIB_H__
#define __GO_MYLIB_H__

#include <stddef.h> // for size_t
#include <stdint.h> // for intptr_t

// #include "mylib.h"
// This is an example of a Go package that exports functions for C.

extern void SayHello(char* name);

extern int Add(int a, int b);

#endif

可以看到，SayHello 和 Add 函数都被声明为 C 兼容的函数签名

创建 C 语言调用示例

现在，我们创建一个 C 语言文件来调用 Go 库中的函数。文件名 main.c：

#include <stdio.h>
#include <stdlib.h> // For malloc and free (if using C strings converted from Go)
#include "mylib.h"  // 包含 Go 生成的头文件

int main() {
    char* myName = "World";
    SayHello(myName); // 调用 Go 导出的 SayHello 函数

    int sum = Add(10, 20); // 调用 Go 导出的 Add 函数
    printf("Sum from Go: %d\n", sum);

    return 0;
}

编译和链接 C 语言程序

在 main.c 和 mylib.a、mylib.h 文件所在的目录下，使用 C 编译器 (如 GCC) 编译并链接：

gcc main.c mylib.a -o myapp

• gcc: C 编译器
• main.c: C 语言源文件
• mylib.a: Go 编译生成的静态库
• -o myapp: 指定输出的可执行文件名为 myapp

注意：在某些系统上，你可能需要添加 -pthread 或其他与 Go 运行时相关的链接选项。例如，在 Linux 上，你可能需要 gcc main.c mylib.a -o myapp -pthread

运行 C 语言程序

$ ./myapp
Hello, World from Go!
Sum from Go: 30

这表明你已经成功地将 Go 代码编译成了 C 兼容的库，并通过 C 程序调用了 Go 函数。

总结

go build -buildmode=c-archive 提供了一个强大的机制，使 Go 语言能够作为 胶水 语言，与其他语言进行高效集成。它在构建跨语言的应用或将 Go 的优势引入现有非 Go 项目时非常有用。