CGO编程基础快速入门

CGO（C语言调用Go语言）是Go语言特有的一种特性，它能够获得C语言等其他语言的优势，能够对现有的一些C程序进行利用或是与其他语言共同编写应用。CGO编程需要对C语言的基础有一定的了解，但是对于初学者而言，并不需要掌握很深入的C语言知识。下面就是CGO编程基础快速入门的完整攻略。

1. CGO的基本概念

CGO是Go语言特有的一种特性，它能够利用C语言的库，而不需要重新用Go语言来实现它们。CGO能够将C语言代码编译成动态链接库（.so文件），然后在Go代码中使用。CGO通过#cgo指令与外部C代码交互，将C语言代码转换为可以被Go调用的代码。

2. CGO的编译方法

CGO编译需要先将C语言代码转换为动态链接库，然后将Go代码编译并链接到动态链接库中。为了简单起见，接下来的例子中我们将C语言代码写在Go文件中。

步骤1：创建一个C文件

首先，你需要创建一个C语言源代码文件，例如hello.c，在其中实现你的C函数。

例如，在hello.c文件中，下面的代码实现了一个输出Hello World!字符串的函数：

#include <stdio.h>
void hello()
{
    printf("Hello, world!\n");
}

步骤2：将C代码编译成动态链接库

接下来，你需要将hello.c编译成一个动态链接库，在这里我们使用gcc。

使用如下命令：

gcc -c -fPIC hello.c -o hello.o
gcc -shared hello.o -o libhello.so

第一行命令将hello.c编译成目标文件（hello.o），继而生成一个位置无关的代码（Position Independent Code，PIC）。

第二行命令将hello.o编译成动态链接库（libhello.so）。

步骤3：编写Go代码，并链接动态链接库

现在，你需要将动态链接库链接到Go代码中。

例如，在main.go文件中，我们写下如下代码：

package main
// #cgo LDFLAGS: -L./ -lhello
// void hello();
import "C"

func main() {
   C.hello()
}

在这里，#cgo指令告诉编译器如何找到动态链接库。

在import "C"语句中，我们声明了一个“C”包，它允许我们调用libc.so的函数。

最后，我们在main函数中调用了hello函数。

步骤4：编译Go代码

最后，你需要使用go build命令编译Go代码。

比如，在你的终端中键入：

go build

GCC将使用-L./ -lhello参数链接到生成的二进制文件中。

3. 示例1

下面是一个简单的示例，演示如何在Go代码中使用C语言库函数。

这个例子展示的是如何使用“strftime”函数格式化日期和时间。strftime是一个C语言库函数，它可以将时间格式化成指定的字符串形式。

下面是C语言代码（hello.c）：

#include <time.h>
#include <stdio.h>

void printDate()
{
    time_t now;
    time(&now);
    char buff[80];
    strftime(buff, 80, "%Y-%m-%d %H:%M:%S", localtime(&now));
    printf("%s\n", buff);
}

我们使用了time.h头文件来获取当前时间，并用strftime函数将当前时间格式化成%Y-%m-%d %H:%M:%S的形式。

接下来，我们将C代码编译成动态链接库（.so文件）。

gcc -c -fPIC hello.c -o hello.o
gcc -shared hello.o -o libhello.so

然后我们用Go语言调用它。下面是Go语言代码：

package main

//#cgo CFLAGS: -g -Wall
//#cgo LDFLAGS: -L./ -lhello
//void printDate();
import "C"

func main() {
    C.printDate()
}

我们用“C”包导入了printDate函数并进行调用。此外，使用#cgo指令，我们告知编译器在编译阶段如何链接libhello.so库。

最后，我们用go build命令构建程序并运行它：

go build
./test

程序输出了当前时间的格式化字符串。

4. 示例2

下面是另一个示例，通过Go语言读取一个本地C库的配置文件。

首先，我们定义一个配置文件格式：

struct conf_file {
    char *name;
    char *value;
};

struct conf_file conf[] = {
    {"uid", "1001"},
    {"gid", "1001"},
    {"verbose", NULL},
    {NULL, NULL},
};

这个结构体定义了一个conf_file对象，包含了两个字符串（name和value）。我们可以使用它来存储配置文件。

接下来，我们将把这个结构体纳入到静态库（libconf.a）中。

gcc -c -fPIC conf.c -o conf.o
ar cr libconf.a conf.o

我们现在有了一个静态库。

现在，我们将用Go语言读取配置文件，并打印出每个配置项目。在main.go文件中，写下如下代码：

package main

/*
#include "conf.h"
*/
import "C"

import (
    "unsafe"
    "fmt"
)

func main() {
    var cf []C.struct_conf_file
    var list *C.struct_conf_file

    list = (*C.struct_conf_file)(unsafe.Pointer(&cf))

    C.get_config(list)

    for _, v := range cf {
        if v.name == nil && v.value == nil {
            break
        }
        fmt.Printf("%s(%s)\n", C.GoString(v.name), C.GoString(v.value))
    }
}

我们将静态库conf.a中定义的函数导入到main.go文件中：

import "C"

然后，我们使用unsafe包和一个指向C.struct_conf_file的指针来分配内存，以便将Go slice值填充到预定义的conf数组中：

var cf []C.struct_conf_file
var list *C.struct_conf_file

list = (*C.struct_conf_file)(unsafe.Pointer(&cf))

调用get_config函数填充列表：

C.get_config(list)

最后，我们循环遍历slice，打印出每个配置项：

for _, v := range cf {
    if v.name == nil && v.value == nil {
        break
    }
    fmt.Printf("%s(%s)\n", C.GoString(v.name), C.GoString(v.value))
}

这样就利用CGO编程，完成了用Go语言读取一个C语言库和一个C语言库中的结构体的示例。