golang 调用c语言动态库方式实现

下面我们自己在 Linux 下做一个动态库(.so 文件 - Shared Object)，然在用 Go 来使用它。本文所用的操作系统为 Ubuntu18.04, 以 gcc 作为编译器。

1.实现头文件，声明文件中函数。这里创建一个add.h文件。

#ifndef __ADD_H__
#define __ADD_H__

char* Add(char* src, int n);

#endif

2.实现add主体函数add.c

#include <string.h>
#include <stdio.h>
#include <stdlib.h>

char* Add(char* src, int n)
{
   char str[20];
   sprintf(str, "％d", n);
   char *result = malloc(strlen(src)+strlen(str)+1);
   strcpy(result, src);
   strcat(result, str);
   return result;
}

3.用命令生成动态库，在linux下文件名称是libadd.so

gcc -fPIC -shared -o lib/libadd.so include/add.c

会在当前目录下生成 libadd.so 文件, 在 Linux 下可用 nm -D libadd.so 查看其中的方法

4.编写一个库来测试一下

#include <stdio.h>
#include "add.h"

int main(int argc, char *argv[])
{
   char* aa = "giter";
   printf("％s\n", Add(aa, 8));
   return 0;
}

链接动态库生成可执行文件

gcc include/test.c -L lib/ -ladd -o test

• -L .表示搜索要链接的库文件时包含当前目录

• -ladd 表示要链接动态库 libadd.so (备注：默认lib + xxx + .so ,中间的xxx就是库名)

• -o test 生成可执行文件 test

错误：运行出错的情况

# 运行 ./test,出错
./test: error while loading shared libraries: libadd.so: cannot open shared object file: No such file or directory

出现以上的错误。有可能是环境变量没弄好导致的，找不到动态库 libadd.so, Linux 通过 ldconfig 的指示在某些目录中(如 /lib, /user/lib) 搜索动态库。更简单的办法是用 LD_LIBRARY_PATH 环境变量。解决办法，

$ LD_LIBRARY_PATH=lib/ ./test
giter8

至此，动态库 libadd.so 准备好了，并且用 test 验证了它是可用的，接下来就在 Go 语言中使用该动态库的函数。

5.golang调用c动态库

demo1
├── include
│     └── add.c
│     └── add.h
│     └── test.c
├── lib
│     └── libadd.so
└── main.go

main.go 的代码如下：

package main

/*
// 头文件的位置，相对于源文件是当前目录，所以是 .，头文件在多个目录时写多个  #cgo CFLAGS: ...
#cgo CFLAGS: -I./include
// 从哪里加载动态库，位置与文件名，-ladd 加载 libadd.so 文件
#cgo LDFLAGS: -L./lib -ladd -Wl,-rpath,lib
#include "add.h"
*/
import "C"
import "fmt"

func main() {
 val := C.Add(C.CString("go"), 2021)
 fmt.Println("run c: ", C.GoString(val))
}

通过注释代码来告诉 Go 编译器从哪里引入头文件与加载动态库. 本例中 *.h 和 *.go 文件在同一个目录的情况下， #cgo CFLAGS: -I. 可不写。
CFLAGS: -I 和 LDFLAGS: -L 都是相对于源文件 main.go 的位置

./demo1
run c:  go2021

成功调用 C 实现的 add 函数
下面列出一些问题
import "C" 要紧挨着 /*...*/ 注释块，如果写成

/*
#cgo ...
*/

import "C"

出现下面的报错信息

# demo1
./main.go:15:10: could not determine kind of name for C.Add

import "C" 要独占一行, 试图同时引入其他的库，如 import ("C"; "fmt") 也会报上面同样的错误
加载不到头文件的错误很明显，#include "add.h" 时会告诉你该文件不存在，如果没有加载到正确的头文件调用 C.Add() 函数时就会报错

# demo1
./main.go:15:10: could not determine kind of name for C.Add

还有一个关键是能否加载到动态库 libadd.so, 参考了网上一些例子，如果把第五行改为

cgo LDFLAGS: -L./lib -ladd

编译不会报错，执行时会出错。

./demo1: error while loading shared libraries: libadd.so: cannot open shared object file: No such file or directory

但如果设置了环境变量 LD_LIBRARY_PATH=/home/vagrant/testgo/lib 也能让它跑起来

LD_LIBRARY_PATH=lib/ ./demo1

来源：https://juejin.cn/post/7047405294107754533