最简略的CGO程序

//cgo.go
package main

import "C"

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

上述代码是一个残缺的CGO程序,通过import “C”语句启动了CGO个性,go build命令会在编译和链接阶段启动gcc编译器

源码形式调用C函数

cgoTest.h

void SayHello(const char* s);

cgoTest.c

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

void SayHello(const char* s) {
    puts(s);
}

main.go

package main

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

func main(){
    C.SayHello(C.CString("Hello world\n"))
}

上述.c文件也能够是.cpp文件,前提是编译时须要g++

cgoTest.cpp

#include <iostream>

extern "C" {
    #include "cgo01.h"
}

void SayHello(const char* s) {
    std::cout << s;
}

上述.c和.cpp的不同实现都实现了SayHello函数,阐明解放了函数的实现者,那如果是这种状况,可不可以应用go实现SayHello函数呢?

答案是能够的,这种技术也称为面向C语言接口(.h中的接口申明)的编程技术,该技术不仅仅能够解放函数的实现者,同时也能够简化函数的使用者。

cgoTest.go

package main

import "C"

import "fmt"

//export SayHello
func SayHello(s *C.char){
    fmt.Print(C.GoString(s))  //留神:这里是C.GoString
}

留神:上述main.go文件在应用C函数CString后在程序退出前没有开释C.CString创立的字符串会导致内存透露,然而对于这个小程序来说,这样是没有问题的,因为程序推出后操作系统会主动回收程序的所有资源

改良后的main.go代码

package main

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

func main(){
    cs := C.CString("CPP Hello world\n")
    C.SayHello(cs)
    C.free(unsafe.Pointer(cs))
}

当然也有其余办法能够防止这种麻烦的状况呈现,而且只须要一个go文件就能够实现面向C语言的编程

main.go (只有这一个文件)

//+build go1.10
package main

//void SayHello(_GoString_ s); //Go1.10中CGO新增的预约义C语言类型,用来示意Go语言字符串
import "C"
import "fmt"

//export SayHello
func SayHello(s string){ //留神这里变量类型为Go 中的string
    fmt.Print(s)
}
func main(){
    C.SayHello("Hello CGO\n")
}

下面代码执行时先从Go语言的main函数开始,到CGO主动生成的C语言版本SayHello桥接函数,最初到Go语言环境的SayHello函数,是不是有一种合久必分、分久必合的感觉,这也是CGO编程的精髓所在。

外部机制

如果在一个go文件中呈现了import “C” 指令则示意将调用cgo命令生成的对应的两头文件,下图是cgo生成的两头文件的示意图:

在保障go build 没问题的状况下执行如下命令就能够生成两头文件

go tool cgo main.go

生成的两头文件在_obj目录下

为了在C语言中应用Go语言定义的函数,咱们须要将Go代码编译为一个C动态库

go build -buildmode=c-archive -o SayHello.a  cgoTest.go

如果没有谬误的话,会生成一个SayHello.a动态库和SayHello.h头文件

既然提到了动态库的生成,顺便也说一下Go生成C动静库

go build -buildmode=c-shared -o SayHello.so cgoTest.go

编译和链接参数

编译和链接参数是每一个C/C++程序员须要常常面对的问题。构建每一个C/C++利用均须要通过编译和链接两个步骤,CGO也是如此

编译参数:CFLAGS/CPPFLAGS/CXXFLAGS

编译参数次要是头文件的检索门路,预约义的宏等参数。实践上来说C和C++是齐全独立的两个编程语言,它们能够有着本人独立的编译参数。 然而因为C++语言对C语言做了深度兼容,甚至能够将C++了解为C语言的超集,因而C和C++语言之间又会共享很多编译参数。 因而CGO提供了CFLAGS/CPPFLAGS/CXXFLAGS三种参数,其中CFLAGS对应C语言编译参数(以.c后缀名)、 CPPFLAGS对应C/C++ 代码编译参数(.c,.cc,.cpp,.cxx)、CXXFLAGS对应纯C++编译参数(.cc,.cpp,*.cxx)

链接参数:LDFLAGS

链接参数次要蕴含要链接库的检索目录和要链接库的名字。因为历史遗留问题,链接库不反对相对路径,咱们必须为链接库指定绝对路径。 cgo 中的 ${SRCDIR} 为当前目录的绝对路径。通过编译后的C和C++指标文件格式是一样的,因而LDFLAGS对应C/C++独特的链接参数

CGO在应用C/C++资源的时候个别有三种模式:间接应用源码;链接动态库;链接动静库。间接应用源码就是在import “C”之前的正文局部蕴含C代码,或者在以后包中蕴含C/C++源文件。链接动态库和动静库的形式比拟相似,都是通过在LDFLAGS选项指定要链接的库形式链接

通过动态库的形式调用C函数

如果CGO中引入的C/C++资源有代码而且代码规模也比拟小,间接应用源码是最现实的形式,但很多时候咱们并没有源代码,或者从C/C++源代码开始构建的过程异样简单,这种时候应用C动态库也是一个不错的抉择。动态库因为是动态链接,最终的目标程序并不会产生额定的运行时依赖,也不会呈现动静库特有的跨运行时资源管理的谬误。不过动态库对链接阶段会有肯定要求:动态库个别蕴含了全副的代码,外面会有大量的符号,如果不同动态库之间呈现了符号抵触则会导致链接的失败

假如dirname 下有filename.c文件和filename.h文件,则生成动态库的命令为

$ cd ./dirname
$ gcc -c -o filename.o filename.c
$ ar rcs libfilename.a filename.o

应用动态库中的C函数

package main

//#cgo CFLAGS: -I./dirname
//#cgo LDFLAGS: -L${SRCDIR}/dirname -lfilename
//
//#include "filename.h"
import "C"
import "fmt"

func main() {
    fmt.Println(C.filename_func())
}

通过动静库的形式调用C函数

动静库呈现的初衷是对于雷同的库,多个过程能够共享同一个,以节俭内存和磁盘资源。然而在磁盘和内存曾经白菜价的明天,这两个作用曾经显得微不足道了,那么除此之外动静库还有哪些存在的价值呢?从库开发角度来说,动静库能够隔离不同动静库之间的关系,缩小链接时呈现符号抵触的危险。而且对于windows等平台,动静库是逾越VC和GCC不同编译器平台的惟一的可行形式

动静库的生成

gcc -shared -o libfinename.so filename.c

对于CGO 来说,应用动静库和动态库是一样的

package main

//#cgo CFLAGS: -I./dirname
//#cgo LDFLAGS: -L${SRCDIR}/dirname -lfilename
//
//#include "filename.h"
import "C"
import "fmt"

func main() {
    fmt.Println(C.filename_func())
}