C#调用Go语言详解

如何在 C# 中调用 Golang 函数？

Go 语言提供了 CGO 机制，使得能够在 Go 代码中直接调用 C 的库函数，此外还支持在 C 语言中调用 Go 函数，非常强大。 Golang 支持将 Go 函数导出给 C 语言使用，那么也同样可以给 C# 使用。

CGO 环境搭建

要使用 CGO 特性，需要安装 C／C 构建工具链，在 macOS 和 Linux 下是要安装好 GCC，在 Windows 下是需要安装 MinGW 工具。如果你的电脑上已经安装好 GCC ，则可以跳过本小节。

关于 MinGW 的安装网上已经有很多教程，本篇将介绍一种更简单的方法来安装 MinGW ：通过安装 QT 来部署 MinGW 到本机（该方法来自：ha666）。QT 的安装包中自带了 MinGW 环境，我们只要安装 QT 开发包，那么附带的 MinGW 环境就安装好了。

QT 的下载地址可以在： http://download.qt.io/archive/qt/ 中找到，目前（2020年1月28日）最新的版本是 5.14.1 ，Windows 版的下载地址是： qt-opensource-windows-x86-5.14.1.exe 。

如果你没有且不想创建 QT 的网络账户，那么在运行 QT 的安装文件之前，可以先断开网络，这样就不会出现 QT 账户的注册和登录界面：

安装过程中无需更改默认的安装目录，在“选择组件”页面时，勾选 MinGW 组件：

在安装完成之后，需要设置好环境变量 Go 编译器才能找到 GCC 的安装位置。如果你使用的软件版本和我相同并且没有更改默认安装位置，那么这个要添加到 PATH 变量中的目录地址应该是：C:\Qt\Qt5.14.0\Tools\mingw730_32\bin\

如果安装正确并配置好了环境变量，那么在命令行中键入 gcc ，将会看到以下输出：

在C#中调用Go输出Hello Golang

编写 Golang 代码，文件名为 main.go 。注意：虽然我们最终要生成动态链接库，但是 main 函数仍是不可或缺的。

接下来对 Go 源文件进行编译，新建一个 make.bat 文件，填入以下指令并运行：

命令成功后，我们会得到两个文件：HelloGolang.Interop.h 和 HelloGolang.Interop.dll 。

使用 Visual Studio 新建 HelloGolang 控制台应用程序，并将生成的目标平台设置为 x86 。将 HelloGolang.Interop.dll 添加到项目中，并设置为“始终复制”：

在 Program.cs 文件中，使用 DllImport 导入外部方法并调用：

运行程序，那么将会在控制台中看到以下输出：

其中，第一行的 Hello World！ 来自 C# 程序，第二行 Hello C#,I'm golang! 则来自 Go 程序。

进阶使用：参数、返回值与类型转换

基本的传参与返回值

使用 Golang 编写一个名为 Check 的方法，该方法接收两个整型的参数（i1，i2）并返回一个布尔值，当 i1 > i2 时返回值为 True，否则为 False ：

需要一个 make.bat 文件，用于生成动态链接库：

同上篇，将 C# 项目 Golang.Ioc 的目标平台设置为 x86 ，将生成的 Golang.Ioc.Interop.dll 复制到项目中并设置为始终复制：

使用 P/Invoke 调用导出的方法：

运行之后，程序将会产生如下输出，程序行为符合我们的预期：

C、CGO、Golang 与 P/Invoke

C/C++ 经过几十年的发展，已经积累了庞大的软件资产，它们很多久经考验而且性能已经足够优化。Go 语言必须能够站在 C/C++ 这个巨人的肩膀之上，有了海量的 C/C++ 软件资产兜底之后，我们才可以放心愉快地用 Go 语言编程。C 语言作为一个通用语言，很多库会选择提供一个 C 兼容的 API，然后用其他不同的编程语言实现。Go 语言通过自带的一个叫 CGO 的工具来支持 C 语言函数调用，同时我们可以用 Go 语言导出 C 动态库接口给其它语言使用。

《Go语言高级编程》 第二章 CGO编程

P/Invoke 的全称是 Platform Invoke (平台调用) 它实际上是一种函数调用机制，通过 P/Invoke 我们就可以调用非托管 DLL 中的函数。实际上很多 NET 基类库中定义的类型内部调用了从 Kernel32.dll，User32.dll，gdi32.dll 等非托管 DLL 中导出的函数。

之所以可以在 C# 中调用 Golang 程序集是因为 CGO 在中间充当了桥梁。我们的调用顺序应该是 C# -> C -> Golang 。

下表列出了 Windows API 和 C 样式函数中使用的数据类型。 许多非托管库包含将这些数据类型作为参数和返回值传递的函数。 第三列列出了相应的 .NET Framework 内置值类型或可在托管代码中使用的类。

Go语言中数值类型和C语言数据类型基本上是相似的，以下是它们的对应关系表：

需要注意的是，虽然在C语言中int、short等类型没有明确定义内存大小，但是在CGO中它们的内存大小是确定的。在CGO中，C语言的int和long类型都是对应4个字节的内存大小，size_t类型可以当作Go语言uint无符号整数类型对待。

在编写完 Golang 代码后，如果不确定对应的 C# 类型，那么可以查看在编译后与 DLL 同时生成的 .h 头文件，对应上面两张表应该就可以找到正确的类型 。

字符串类型参数

如果一个方法需要导出并且参数或返回值涉及到字符串，通常使用 *C.char 来代替 Golang 内置的 string 类型对外导出。可以调用 C.CString 方法将 Golang 的字符串类型转为 *C.char 类型：

需要注意的是：C string 在 C 的堆上使用 malloc 申请。调用者有责任在合适的时候对该字符串进行释放，释放方式可以是调用C.free（调用C.free需包含stdlib.h）。

在 Golang 源码中新增 GetSlogan 方法，该方法接受一个名为 name 的字符串参数，并返回一句为武汉加油的口号。为了可以在返回值使用完成后释放掉由 C.CString 申请的内存，再增加一个 Free 方法：

C# 提供一个 ICustomMarshaler 接口，可以用它来对托管内存和非托管内存进行转换。添加一个 CStringMarshaler  实现 ICustomMarshaler 接口，帮我们处理 C# string 和 C.CString 之间的转换过程，并保证内存被正确释放：

测试一下对 GetSlogan 方法的调用：

运行代码后将产生以下输出：

增加代码进行性能测试：

调用 52 万 1 千次后，内存占用仍在 20M 以内，可以证明没有发生内存泄漏问题：