TencentOS Server Go 开发指南

Go 简介
Go 语言（Golang）是谷歌推出的一种编译型、静态类型、并发级别高、垃圾回收的开源编程语言。其简洁、性能高效、并发支持强大，广泛应用于云计算、Web 开发和网络编程。
Go 安装
dnf 安装
您可以直接通过如下命令安装系统提供的 golang 包，基于此进行 Go 开发。
dnf install -y golang
安装完成后可通过如下命令确认安装版本：
go version
输出示例：
go version go1.19 linux/amd64
自定义安装
如果您需要自定义安装，可以参考如下步骤使用官方提供的二进制文件：
1. 下载官方二进制文件。本示例安装的是 Go 1.19 版本，您可以按需选择其他版本：
wget https://go.dev/dl/go1.19.linux-amd64.tar.gz
2. 提取下载的 tarball 文件到 /usr/local 目录。若系统中已存在旧版本的 Go，请先删除 /usr/local/go 目录：
sudo rm -rf /usr/local/go
sudo tar -C /usr/local -xzf go1.19.linux-amd64.tar.gz
3. 将 Go 的可执行文件目录添加到 PATH 环境变量中：
export PATH=$PATH:/usr/local/go/bin
如需对所有用户长期生效，可将该配置写入 /etc/profile 文件：
echo 'export PATH=$PATH:/usr/local/go/bin' | sudo tee -a /etc/profile
source /etc/profile
4. 验证 Go 语言是否安装成功：
go version
输出示例：
go version go1.19 linux/amd64
Go 使用
直接运行 Go
Go 程序可直接通过 go run 命令运行。
执行 touch hello.go 创建文件，并添加以下内容：
package main
﻿
import "fmt"
﻿
func main() {
    fmt.Println("Hello, TencentOS!")                                                                                     
}
您可以直接运行此代码。
go run hello.go
输出示例：
Hello, TencentOS!
创建 Go 项目
对于涉及依赖关系的复杂 Go 代码，可以通过创建 Go 项目来进行开发。
1. 假设您的项目目录为 $HOME/go，可通过如下命令创建项目目录：
mkdir -p $HOME/go/{src,bin,pkg}
其中：
src：包含源代码文件的目录
bin：包含可执行文件的目录
pkg：包含编译后的包依赖的对象文件的目录
2. 设置环境变量：
export GOPATH=$HOME/go
3. 初始化一个新的 Go 项目，项目名称为 my_project，用于随机生成人名。执行以下命令创建项目并进入项目目录：
mkdir -p ${GOPATH}/src/my_project
cd ${GOPATH}/src/my_project
4. 创建一个名为main.go 的件，添加以下代码：
package main
﻿
import (
	"fmt"
﻿
	"github.com/Pallinder/go-randomdata"
)
﻿
func main() {
	for i := 1; i <= 5; i++ {
		randomName := randomdata.FirstName(randomdata.RandomGender) + " " + randomdata.LastName()
		fmt.Printf("Person %d: %s\\n", i, randomName)
	}
}
5. 初始化 Go module 并安装依赖：
go mod init example.com/my_project
go mod tidy
6. 编译项目：
go build
7. 使用 go install 命令安装可执行文件：
go install
此时 bin 目录下将生成一个名为 my_project 的可执行文件，可以直接运行：
$HOME/go/bin/my_project
Person 1: Sofia Martin
Person 2: Emily Anderson
Person 3: Elizabeth Taylor
Person 4: Emma Miller
Person 5: Isabella Smith
此时，一个完整的 Go 项目目录树如下：
cd ~/go
tree -L 3
输出示例：
.
├── bin
│   └── my_project
├── pkg
│   ├── mod
│   │   ├── cache
│   │   ├── github.com
│   │   └── golang.org
│   └── sumdb
│       └── sum.golang.org
└── src
    └── my_project
        ├── go.mod
        ├── go.sum
        └── main.go
调测功能
fmt.Println
在开发阶段，打印变量值和程序中某些点的执行状态是最简单且常见的调试方法。可以使用 Go 的 fmt.Println() 在程序中输出调试信息。
Println 由 Print 和 ln（换行）两部分组成，表示在打印完成后会自动添加一个换行符。
您可以将任意数量和类型的参数传递给 fmt.Println，输出时，参数间使用空格进行分隔。示例如下：
fmt.Println("Hello, TencentOS!")
fmt.Println("The value is:", 42)
fmt.Println("Name:", "John", "Age:", 30)
fmt.Println 函数用于打印值，但不支持格式化字符串输出。如需进行字符串输出，请使用 fmt.Printf（或 fmt.Sprintf）函数。这些函数提供更多的格式化选项，如占位符（%d、%f、%s 等），和输出控制功能（如字段宽度、精度和填充字符等）。
debug.PrintStack()
debug.PrintStack() 函数可以将当前程序的堆栈以文本形式抛出到标准错误输出，要使用此工具，需要适当修改代码。
首先，需要导入 runtime/debug：
import (
    ...
	"runtime/debug"
	...
)
然后在需要打印调用栈的地方加入如下代码：
...	
debug.PrintStack()
...
运行修改后的代码即可打出调用栈。
pprof
pprof 是用于 Go 的可视化调测工具，侧重于性能数据的分析，要使用此工具，需要适当修改代码。
首先，需要导入 pprof 包：
import (
    ...
	"runtime/pprof"
	...
)
接下来，需要创建 pprof 文件，例如：
f, err := os.Create("cpu.pprof")
然后，调用了 pprof.StartCPUProfile() 函数来开始记录 CPU 配置文件：
pprof.StartCPUProfile(f)
在执行程序一段时间后，使用 pprof.StopCPUProfile() 函数停止记录 CPU 配置文件。
defer pprof.StopCPUProfile()
如此设置后，执行完程序会生成 cpu.pprof 这个文件，使用如下命令即可进入交互界面进行详细分析。
go tool pprof cpu.pprof
输出示例：
File: main
Type: cpu
Time: May 29, 2023 at 7:17pm (CST)
Duration: 609.33ms, Total samples = 440ms (72.21%)
Entering interactive mode (type "help" for commands, "o" for options)
(pprof) top
Showing nodes accounting for 440ms, 100% of 440ms total
      flat  flat%   sum%        cum   cum%
     440ms   100%   100%      440ms   100%  main.fibonacci
         0     0%   100%      440ms   100%  main.main
         0     0%   100%      440ms   100%  runtime.main
Go 包管理
除了使用系统提供的 dnf 命令管理 Go 相关的包，您也可以使用 Go 提供的 Go Modules 包管理系统，用于处理项目及其依赖项。
初始化 Go Modules
要在项目中启用 Go Modules，请在项目根目录下执行以下命令。此命令将创建一个名为 go.mod 的文件，其中包含项目的模块名称和当前 Go 版本。
go mod init <module-path>
例如上文中创建项目用到的命令：
go mod init example.com/my_project
cat go.mod
输出示例：
module example.com/my_project
﻿
go 1.19
安装和更新依赖项
要添加或更新依赖项，请使用以下命令。这将下载缺失的依赖项并更新 go.mod 和 go.sum 文件。
go mod tidy
执行完上述命令后，将在 go.mod 文件中新增依赖的包：
cat go.mod
输出示例：
module example.com/my_project
﻿
go 1.19
﻿
require github.com/Pallinder/go-randomdata v1.2.0
﻿
require golang.org/x/text v0.9.0 // indirect
若要获取特定版本的依赖项，请使用以下命令。此命令将更新 go.mod 文件，并获取请求的版本。
go get <dependency_path>@<version>
如需使用 v1.1.0 版本的 go-randomdata，请运行以下命令：
go get github.com/Pallinder/go-randomdata@v1.1.0
cat go.mod
输出示例：
module example.com/my_project
﻿
go 1.19
﻿
require github.com/Pallinder/go-randomdata v1.1.0
﻿
require golang.org/x/text v0.9.0 // indirect
此时 go.mod 文件被更新。
另外，也可以使用特定的 git commit，如：
go get github.com/Pallinder/go-randomdata@3e0fbf126b9e6853a5e50951913caab476d650c7
输出示例：
go: downloading github.com/Pallinder/go-randomdata v0.0.0-20181031200937-3e0fbf126b9e
go: downgraded github.com/Pallinder/go-randomdata v1.2.0 => v0.0.0-20181031200937-3e0fbf126b9e
cat go.mod
输出示例：
module example.com/my_project
﻿
go 1.19
﻿
require github.com/Pallinder/go-randomdata v0.0.0-20181031200937-3e0fbf126b9e
﻿
require golang.org/x/text v0.9.0 // indirect
查看当前依赖项及其详情
要查看当前项目的所有依赖项的信息以及可更新版本，可以运行以下命令：
go list -u -m all
输出示例：
example.com/my_project
github.com/Pallinder/go-randomdata v0.0.0-20181031200937-3e0fbf126b9e [v1.2.0]
golang.org/x/mod v0.8.0 [v0.10.0]
golang.org/x/sys v0.5.0 [v0.8.0]
golang.org/x/text v0.9.0
golang.org/x/tools v0.6.0 [v0.9.1]
移除不再使用的依赖项
要移除不再使用的依赖项，首先需要在源代码中注释不再使用的依赖包：
import (
...
//      "github.com/Pallinder/go-randomdata"
...
)
然后执行如下命令：
go mod tidy
这时已查不到删去的依赖项：
go list -u -m all
输出示例：
example.com/my_project
Go 工具介绍
go fmt
go fmt 用来自动格式化 Go 源代码文件，以确保代码风格一致，并符合官方编码规范。
例如，创建一个名为 example.go 的文件，其内容如下，但代码排列和缩进不规范：
package main
﻿
import "fmt"
﻿
func main()         {
fmt.Println("Hello, world!")
list:=[]int{9,7,5,3}
for i, val := range list {
fmt.Printf("Index: %d, Value: %d\\n",i,val)
}
}
执行如下命令：
go fmt example.go
执行后代码便实现了规范化：
cat example.go
输出示例：
package main
﻿
import "fmt"
﻿
func main() {
	fmt.Println("Hello, world!")
	list := []int{9, 7, 5, 3}
	for i, val := range list {
		fmt.Printf("Index: %d, Value: %d\\n", i, val)
	}
}
go vet
go vet 用于静态检查 Go 源代码中的潜在错误或可疑编码模式。
创建一个名为 example.go 的文件，其中有一个错误：在 Printf 的占位符和参数之间有一个不匹配：
package main
﻿
import "fmt"
﻿
type Person struct {
	FirstName string
	LastName  string
	Age       int
}
﻿
func main() {
	p := Person{
		FirstName: "John",
		LastName:  "Doe",
		Age:       30,
	}
﻿
	fmt.Printf("Person: %s %s, age %d, and an extra parameter: %s\\n", p.FirstName, p.LastName, p.Age)
}
执行此命令后，go vet 将报告以下错误：
go vet example.go
输出示例：
# command-line-arguments
./example.go:18:2: fmt.Printf format %s reads arg #4, but call has 3 args
工具指明了文件 example.go 的第 18 行具有额外的参数，但没有相应的格式化指令。
除了对单个文件进行检查之外，要检查包括子目录在内的整个项目中的所有 Go 代码文件，可以在项目的根目录下运行 go vet：
go vet ./...
go doc
go doc 命令从 Go 源代码中提取包、类型、函数和方法的文档注释，并将其以易读的纯文本格式输出到终端。
例如，创建一个名为 stringutil.go 的简单字符串处理库：
// Package stringutil contains utility functions for manipulating strings.
package stringutil
﻿
// Reverse returns a reversed copy of the input string s.
func Reverse(s string) string {
	r := []rune(s)
	for i, j := 0, len(r)-1; i < len(r)/2; i, j = i+1, j-1 {
		r[i], r[j] = r[j], r[i]
	}
	return string(r)
}
导入并使用自定义的 stringutil 包：
go mod init example.com/stringutil
go mod tidy
完成上述配置后，可输出包的描述：
go doc example.com/stringutil
输出示例：
package stringutil // import "example.com/stringutil"
﻿
Package stringutil contains utility functions for manipulating strings.
﻿
func Reverse(s string) string
也可以查询函数的描述：
go doc example.com/stringutil.Reverse
输出示例：
package stringutil // import "example.com/stringutil"
﻿
func Reverse(s string) string
    Reverse returns a reversed copy of the input string s.
﻿
Go 开发指南

本页目录：

Go 简介

Go 安装

dnf 安装

自定义安装

Go 使用

直接运行 Go

创建 Go 项目

调测功能

`fmt.Println`

`debug.PrintStack()`

pprof

Go 包管理

初始化 Go Modules

安装和更新依赖项

查看当前依赖项及其详情

移除不再使用的依赖项

Go 工具介绍

go fmt

go vet

go doc
