Golang通脉之基础入门

为什么要学 Go

性能优越感；Go 极其地快，其性能与 Java 或 C++相似。在使用中，Go 一般比 Python 要快 30 倍；
序列化/去序列化、排序和聚合中表现优异；
开发者效率较高；多种赋值、数据结构、指针、格式化以及内置的 HTTP 库等能使给开发者提供快速着手开发；
天然并发，Go 的并发性方法非常容易上手；
编译速度快；
增强团队语言聚合力；Go 非常简单，且易于学习。它只提供了基本功能而没有多余。Go 引入的新概念是 defer 声明，以及内置的 goroutines 和通道的并发性管理。
Go 具备稳定的生态系统；Go 有着强大的工具支持。
GOFMT，强制代码格式；Gofmt 用一种官方的形式规格代码，避免了不必要的讨论；
Go 语言对 protocol buffers 和 gRPC 有一流的支持等；

国外如 Google、AWS、Cloudflare、CoreOS 等，国内如腾讯、知乎、哔哩哔哩、七牛、阿里等大厂都已经开始大规模使用 Golang 开发其云计算相关产品。跟着世界级巨人的脚步应该不至于走错方向，而且 Golang 的设计哲学足以让人折服。

云风博客中曾说过这样一句话：

我发现我花了四年时间锤炼自己用 C 语言构建系统的能力，试图找到一个规范，可以更好的编写软件。结果发现只是对 Go 的模仿。缺乏语言层面的支持，只能是一个拙劣的模仿。

环境搭建

下载地址

Go 官网下载地址：https://golang.org/dl/

Go 官方镜像站（推荐）：https://golang.google.cn/dl/

安装

Windows 安装

将上一步选好的安装包下载到本地。

双击下载好的文件，然后按照提示步骤安装即可。

Linux 下安装

如果不是要在 Linux 平台敲 go 代码就不需要在 Linux 平台安装 Go，开发机上写好的 go 代码只需要跨平台编译好之后就可以拷贝到 Linux 服务器上运行了，这也是 go 程序跨平台易部署的优势。

wget https://dl.google.com/go/go1.17.1.linux-amd64.tar.gz

将下载好的文件解压到/usr/local目录下：

tar -zxvf go1.17.1.linux-amd64.tar.gz -C /usr/local  # 解压

如果提示没有权限，加上sudo以 root 用户的身份再运行。执行完就可以在/usr/local/下看到 go 目录了。

配置环境变量： Linux 下有两个文件可以配置环境变量，其中/etc/profile是对所有用户生效的；$HOME/.profile是对当前用户生效的，根据自己的情况自行选择一个文件打开，添加如下两行代码，保存退出。

export GOROOT=/usr/local/go

export PATH=$PATH:$GOROOT/bin

修改/etc/profile后要重启生效，修改$HOME/.profile后使用 source 命令加载$HOME/.profile文件即可生效。检查：

~ go version

go version go1.17.1 linux/amd64

Mac 下安装

下载可执行文件版，直接点击下一步安装即可，默认会将 go 安装到/usr/local/go目录下。

检查

上一步安装过程执行完毕后，可以打开终端窗口，输入go version命令，查看安装的 Go 版本。

配置 GOPATH

GOPATH是一个环境变量，用来表明你写的 go 项目的存放路径（工作目录）。

GOPATH路径最好只设置一个，所有的项目代码都放到GOPATH的src目录下。

补充说明：Go1.11 版本之后，开启go mod模式之后就不再强制需要配置GOPATH了。

下文 GOPATH 及项目目录划分的部分适用于 Go1.11 版本之前，目前建议大家使用最新的 Go 语言版本并且打开go mod模式。可以将代码文件存放在任意位置。

Linux 和 Mac 平台就参照上面配置环境变量的方式将自己的工作目录添加到环境变量中即可。 Windows 平台的步骤请自行 Google

在 Go 1.8 版本之前，GOPATH环境变量默认是空的。从 Go 1.8 版本开始，Go 开发包在安装完成后会为 GOPATH设置一个默认目录，参见下表。

GOPATH 在不同操作系统平台上的默认值

平台	GOPATH 默认值	举例
Windows	%USERPROFILE%/go	C:\Users\用户名\go
Unix	$HOME/go	/home/用户名/go

同时，将 GOROOT下的 bin 目录及GOPATH下的 bin 目录都添加到环境变量中。

配置环境变量之后需要重启电脑上已经打开的终端。（例如 cmd、VS Code 里面的终端和其他编辑器的终端）。

Go 项目结构

不论采用何种编程语言，良好的项目组织结构都至关重要，因为这将直接影响项目内部依赖的复杂程度以及项目对外提供 API 等服务的灵活性等。最好在项目初期便制定好项目结构约定，甚至可以为其开发脚手架之类的工具来生成项目模板，让开发者尽量按照统一的规范参与项目。

项目的目录结构通常也是门面，内行人通过目录结构基本就能看出开发者是否有经验。 Go 官网并没有给出一个目录结构的标准模板，但是 golang-standards 倒是给出了一个，目录结构如下：

├── api

├── assets

├── build

│ ├── ci

│ └── package

├── cmd

│ └── *your_app*

├── configs

├── deployments

├── docs

├── examples

├── githooks

├── init

├── internal

│ ├── app

│ │ └── *your_app*

│ └── pkg

│ └── *your_private_lib*

├── pkg

│ └── *your_public_lib*

├── scripts

├── test

├── third_party

├── tools

├── vendor

├── web

│ ├── app

│ ├── static

│ └── template

├── website

├── .gitignore

├── LICENSE.md

├── Makefile

├── README.md

└── go.mod

这是 Go 应用程序项目的基本布局。它不是核心 Go 开发团队定义的官方标准；然而，它是 Go 生态系统中一组常见的老项目和新项目的布局模式。其中一些模式比其他模式更受欢迎。它还具有许多小的增强，以及对任何足够大的实际应用程序通用的几个支持目录。

此项目布局是通用的，并且不会尝试强加一个特定的 Go 包结构。

/cmd

本项目的主干。

每个应用程序的目录名应该与你想要的可执行文件的名称相匹配(例如，/cmd/myapp)。

不要在这个目录中放置太多代码。如果你认为代码可以导入并在其他项目中使用，那么它应该位于 /pkg 目录中。如果代码不是可重用的，或者你不希望其他人重用它，请将该代码放到 /internal 目录中。你会惊讶于别人会怎么做，所以要明确你的意图!

通常有一个小的 main 函数，从 /internal 和 /pkg 目录导入和调用代码，除此之外没有别的东西。

/internal

私有应用程序和库代码。这是你不希望其他人在其应用程序或库中导入代码。请注意，这个布局模式是由 Go 编译器本身执行的。有关更多细节，请参阅 Go 1.4 release notes 。注意，你并不局限于顶级 internal 目录。在项目树的任何级别上都可以有多个内部目录。

你可以选择向 internal 包中添加一些额外的结构，以分隔共享和非共享的内部代码。这不是必需的(特别是对于较小的项目)，但是最好有有可视化的线索来显示预期的包的用途。你的实际应用程序代码可以放在 /internal/app 目录下(例如 /internal/app/myapp)，这些应用程序共享的代码可以放在 /internal/pkg 目录下(例如 /internal/pkg/myprivlib)。

/pkg

外部应用程序可以使用的库代码(例如 /pkg/mypubliclib)。其他项目会导入这些库，希望它们能正常工作，所以在这里放东西之前要三思:-)注意，internal 目录是确保私有包不可导入的更好方法，因为它是由 Go 强制执行的。/pkg 目录仍然是一种很好的方式，可以显式地表示该目录中的代码对于其他人来说是安全使用的好方法。由 Travis Jeffery 撰写的 I'll take pkg over internal 博客文章提供了 pkg 和 internal 目录的一个很好的概述，以及什么时候使用它们是有意义的。

当根目录包含大量非 Go 组件和目录时，这也是一种将 Go 代码分组到一个位置的方法，这使得运行各种 Go 工具变得更加容易

如果你想查看哪个流行的 Go 存储库使用此项目布局模式，请查看 /pkg 目录。这是一种常见的布局模式，但并不是所有人都接受它，一些 Go 社区的人也不推荐它。

如果你的应用程序项目真的很小，并且额外的嵌套并不能增加多少价值(除非你真的想要:-)，那就不要使用它。当它变得足够大时，你的根目录会变得非常繁琐时(尤其是当你有很多非 Go 应用组件时)，请考虑一下。

/vendor

应用程序依赖项(手动管理或使用你喜欢的依赖项管理工具，如新的内置 Go Modules 功能)。go mod vendor 命令将为你创建 /vendor 目录。请注意，如果未使用默认情况下处于启用状态的 Go 1.14，则可能需要在 go build 命令中添加 -mod=vendor 标志。

如果你正在构建一个库，那么不要提交你的应用程序依赖项。

注意，自从 1.13 以后，Go 还启用了模块代理功能。如果启用了模块代理功能，那么根本不需要 vendor 目录。

国内模块代理功能默认是被墙的，七牛云有维护专门的的模块代理 。

服务应用程序目录

/api

OpenAPI/Swagger 规范，JSON 模式文件，协议定义文件。

有关示例，请参见 /api 目录。

Web 应用程序目录

/web

特定于 Web 应用程序的组件:静态 Web 资产、服务器端模板和 SPAs。

通用应用目录

/configs

配置文件模板或默认配置。

将 confd 或 consul-template 模板文件放在这里。

/init

System init（systemd，upstart，sysv）和 process manager/supervisor（runit，supervisor）配置。

/scripts

执行各种构建、安装、分析等操作的脚本。

这些脚本保持了根级别的 Makefile 变得小而简单(例如， https://github.com/hashicorp/terraform/blob/master/Makefile )。

有关示例，请参见 /scripts 目录。

/build

打包和持续集成。

将云( AMI )、容器( Docker )、操作系统( deb、rpm、pkg )包配置和脚本放在 /build/package 目录下。

将 CI (travis、circle、drone)配置和脚本放在 /build/ci 目录中。请注意，有些 CI 工具(例如 Travis CI)对配置文件的位置非常挑剔。尝试将配置文件放在 /build/ci 目录中，将它们链接到 CI 工具期望它们的位置(如果可能的话)。

/deployments

IaaS、PaaS、系统和容器编排部署配置和模板(docker-compose、kubernetes/helm、mesos、terraform、bosh)。注意，在一些存储库中(特别是使用 kubernetes 部署的应用程序)，这个目录被称为 /deploy。

/test

额外的外部测试应用程序和测试数据。可以随时根据需求构造 /test 目录。对于较大的项目，有一个数据子目录是有意义的。例如，你可以使用 /test/data 或 /test/testdata (如果你需要忽略目录中的内容)。请注意，Go 还会忽略以“.”或“_”开头的目录或文件，因此在如何命名测试数据目录方面有更大的灵活性。

有关示例，请参见 /test 目录。

其他目录

/docs

设计和用户文档(除了 godoc 生成的文档之外)。

有关示例，请参阅 /docs 目录。

/tools

这个项目的支持工具。注意，这些工具可以从 /pkg 和 /internal 目录导入代码。

有关示例，请参见 /tools 目录。

/examples

应用程序和/或公共库的示例。

有关示例，请参见 /examples 目录。

/third_party

外部辅助工具，分叉代码和其他第三方工具(例如 Swagger UI)。

/githooks

Git hooks。

/assets

与存储库一起使用的其他资源(图像、徽标等)。

/website

如果你不使用 Github 页面，则在这里放置项目的网站数据。

有关示例，请参见 /website 目录。

不应该拥有的目录

/src

有些 Go 项目确实有一个 src 文件夹，但这通常发生在开发人员有 Java 背景，在那里它是一种常见的模式。如果可以的话，尽量不要采用这种 Java 模式。

不要将项目级别 src 目录与 Go 用于其工作空间的 src 目录(如 How to Write Go Code 中所述)混淆。$GOPATH 环境变量指向你的(当前)工作空间(默认情况下，它指向非 windows 系统上的 $HOME/go)。这个工作空间包括顶层 /pkg, /bin 和 /src 目录。你的实际项目最终是 /src 下的一个子目录，因此，如果你的项目中有 /src 目录，那么项目路径将是这样的: /some/path/to/workspace/src/your_project/src/your_code.go。注意，在 Go 1.11 中，可以将项目放在 GOPATH 之外，但这并不意味着使用这种布局模式是一个好主意。

Go 开发编辑器

好的编辑器可以提高开发的效率，推荐两款目前最流行的编辑器。

第一是 Visual Studio Code + Go 扩展插件，可以非常高效地开发，通过官方网站 https://code.visualstudio.com/ 下载使用。

第二是老牌 IDE 公司 JetBrains 推出的 Goland，所有插件已经全部集成，更容易上手，并且功能强大，新手老手都适合，可以通过官方网站 https://www.jetbrains.com/go/ 下载使用。

第一个 Go 程序

go mod

采用 Go Module 的方式，可以在任何位置创建第一个 Go 项目——hello。在该目录下打开终端执行

go mod init  执行成功后，会生成一个 go.mod 文件

在该目录中创建一个main.go文件：

package main  // 声明 main 包，表明当前是一个可执行程序

import "fmt"  // 导入内置 fmt 包

func main(){  // main函数，是程序执行的入口

	fmt.Println("Hello World!")  // 在终端打印 Hello World!

}

go build

go build表示将源代码编译成可执行文件。

在 hello 目录下执行：

go build

或者在其他目录执行以下命令：

go build hello

go 编译器会去 GOPATH的 src 目录下查找你要编译的hello项目

编译得到的可执行文件会保存在执行编译命令的当前目录下，如果是 windows 平台会在当前目录下找到hello.exe可执行文件。

还可以使用-o参数来指定编译后得到的可执行文件的名字。

go build -o aaaaaaa.exe

go install

go install表示安装的意思，它先编译源代码得到可执行文件，然后将可执行文件移动到GOPATH的 bin 目录下。因为我们的环境变量中配置了GOPATH下的 bin 目录，所以我们就可以在任意地方直接执行可执行文件了。

跨平台编译

默认go build的可执行文件都是当前操作系统可执行的文件，如果想在 windows 下编译一个 linux 下可执行文件，只需要指定目标操作系统的平台和处理器架构即可：

SET CGO_ENABLED=0  // 禁用CGO

SET GOOS=linux  // 目标平台是linux

SET GOARCH=amd64  // 目标处理器架构是amd64

使用了 cgo 的代码是不支持跨平台编译的

然后再执行go build命令，得到的就是能够在 Linux 平台运行的可执行文件了。

Mac 下编译 Linux 和 Windows 平台 64 位可执行程序：

CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build

CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build

Linux 下编译 Mac 和 Windows 平台 64 位可执行程序：

CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build

CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build

Windows 下编译 Mac 平台 64 位可执行程序：

SET CGO_ENABLED=0

SET GOOS=darwin

SET GOARCH=amd64

go build