Liuye Notebook
0%

Go-Basics

发表于 更新于 分类于 ， 阅读次数： Valine：

阅读更多

1 基本概念

1.1 包

包是结构化代码的一种方式：每个程序都由包（通常简称为pkg）的概念组成，可以使用自身的包或者从其它包中导入内容。

如同其它一些编程语言中的类库或命名空间的概念，每个Go文件都属于且仅属于一个包。一个包可以由许多以.go为扩展名的源文件组成，因此文件名和包名一般来说都是不相同的。

你必须在源文件中非注释的第一行指明这个文件属于哪个包，如：package main。package main表示一个可独立执行的程序，每个Go应用程序都包含一个名为main的包。

一个应用程序可以包含不同的包，而且即使你只使用main包也不必把所有的代码都写在一个巨大的文件里：你可以用一些较小的文件，并且在每个文件非注释的第一行都使用package main来指明这些文件都属于main包。如果你打算编译包名不是为main的源文件，如pack1，编译后产生的对象文件将会是pack1.a而不是可执行程序。另外要注意的是，所有的包名都应该使用小写字母。

1.2 可见性规则

当标识符（包括常量、变量、类型、函数名、结构字段等等）以一个大写字母开头，如：Group1，那么使用这种形式的标识符的对象就可以被外部包的代码所使用（客户端程序需要先导入这个包），这被称为导出（像面向对象语言中的public）；标识符如果以小写字母开头，则对包外是不可见的，但是他们在整个包的内部是可见并且可用的（像面向对象语言中的private）。

（大写字母可以使用任何Unicode编码的字符，比如希腊文，不仅仅是ASCII码中的大写字母）。

因此，在导入一个外部包后，能够且只能够访问该包中导出的对象。

假设在包pack1中我们有一个变量或函数叫做Thing（以T开头，所以它能够被导出），那么在当前包中导入pack1包，Thing就可以像面向对象语言那样使用点标记来调用：pack1.Thing（pack1在这里是不可以省略的）。

因此包也可以作为命名空间使用，帮助避免命名冲突（名称冲突）：两个包中的同名变量的区别在于他们的包名，例如pack1.Thing和pack2.Thing。

你可以通过使用包的别名来解决包名之间的名称冲突，或者说根据你的个人喜好对包名进行重新设置，如：import fm "fmt"。下面的代码展示了如何使用包的别名：

1
2
3
4
5
6
7
package main

import fm "fmt" // alias3

func main() {
   fm.Println("hello, world")
}

2 Tips

2.1 值类型与引用类型

  1. int、float、bool、array、struct是值类型
  2. slice、map、func、method、chan、interface、string是引用类型

2.2 数组与切片

  1. 数组是固定大小的 [<n>]Type
  2. 引用是可变的（可理解为动态数组）[]Type

2.3 类型转换

Type(v)

2.4 类型识别

1
2
3
4
5
6
7
8
9
10
11
12
  if value, ok := obj.(T); ok {
	
  } 
  
  switch t := obj.(type) {
case T1:
     //xxx
  case *T2:
     //xxx
  default:
     //xxx
}

2.5 字符串拼接

fmt.Sprintf

2.6 各种类型转为字符串

fmt.Sprintf

2.7 go文件命名规范

区分平台和cpu架构：<name>_<platform>_<cpu arch>.go

  • file.go
  • file_linux.go
  • file_linux_amd64.go

测试：<name>_<platform>_<cpu arch>_test.go

  • file_test.go
  • file_linux_test.go
  • file_linux_amd64_test.go

2.8 交叉编译

1
2
3
4
5
# 查看环境变量
go env

# 编译指定cpuArch的二进制
env GOOS=linux GOARCH=amd64 go build -o <target_binary> <src.go>

2.9 类似try…catch

  1. panic：抛出异常
  2. defer&recover：捕获异常

2.10 bindata-打包资源文件

go build只能编译go文件，但是项目中如果存在资源文件，比如css，html等文件，是无法被go build打包进二进制文件的

go-bindata提供了打包资源文件的方式，原理很简单：就是将这些资源文件序列化成[]byte，包含在自动创建的go文件中

go-bindata-github

1
2
3
4
5
6
7
8
9
# 安装go-bindata
go get github.com/jteeuwen/go-bindata/...
go get github.com/elazarl/go-bindata-assetfs/...

# 生成包含指定资源文件的go文件
go-bindata -pkg <package> -o <go file path> <resource path1> <resource path2> ...
# <package> : 生成go文件的包
# <go file path> : 生成的go文件路径
# <resource path1> : 具体要打包的资源路径

2.11 log-framework

lumberjack

Golang 获取用户 home 目录路径

logback-for-go

2.12 同步

2.12.1 Cond

go中的Cond类似于Java中的AbstractQueuedSynchronizer以及ConditionObject

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package main

import (
    "sync"
    "time"
)

func main() {
    m := sync.Mutex{}
    c := sync.NewCond(&m)
    go func() {
        time.Sleep(1 * time.Second)
        c.Broadcast()
    }()
    m.Lock()
    time.Sleep(2 * time.Second)
    c.Wait()
}

2.13 FAQ

  1. new和make的区别
  2. 方法参数引用和非引用

3 包管理工具

3.1 go get

  1. 要求工程必须在GOPATH中

3.1.1 从gitlab上下载依赖包

需要开启交互，默认是禁止的（在下载过程中需要进行auth，输入用户名和密码）

1
export GIT_TERMINAL_PROMPT=1

3.2 go module

3.2.1 如何开启

  1. go版本大于1.12
  2. 满足下面两个条件中的任意一个
    1. 在GOPATH/src目录之外，且目录中（当前目录或父目录）存在go.mod
    2. 设置环境变量GO111MODULE=on

3.2.2 如何使用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 初始化go module项目，执行完毕之后，会在当前路径下生成go.mod文件
go mod init github.com/aaa/bbb

# 更新依赖
go get github.com/aaa/bbb@master

# 显示依赖
go list -m all

# 显示依赖及可升级的版本
go list -u -m all

# 引入不存在的依赖/删除多余的依赖
go mod tidy

# 将外部依赖包缓存到vendor/目录中
go mod vendor

# 使用vendor/目录下的包进行编译
go build -mod=vendor

3.2.3 版本管理

go module支持在报名后增加/v2，/v3这样的后缀和对应的三位版本号标签（git tag），解决兼容性问题，包的版本号格式为：v{major}.{minor}.{patch}

go module对版本号的约定

  1. v0、v1版本不存在兼容性问题
  2. v2开始，不同的major代表和前一个版本不兼容
  3. 如果一个go程序导入（直接依赖或间接依赖）同一个包的多个兼容版本，默认会使用版本号较高的那个
    • 如果同时依赖了v0.1.2和v1.0.1，那么会使用v1.0.1
    • 如果同时依赖了v2.0.1和v2.0.2，那么会使用v2.0.2
  4. 如果一个go程序导入（直接依赖或间接依赖）同一个包的多个不兼容版本，则使用各自版本的包
    • 如果同时依赖了v1.1.0和v2.1.0，那么会同时存在

3.2.4 部分包想用本地版本

用replace指向本地的依赖

3.2.5 从github上下载依赖包

3.2.5.1 修改proxy

在墙内下载依赖包，很有可能会timeout，可以通过配置proxy来解决这个问题

1
go env -w GOPROXY=https://goproxy.cn,direct

3.2.5.2 修改sum

go module默认会从sum.golang.org对依赖包进行一个校验，但是在墙内环境，sum.golang.org是无法访问的，通常会报如下的一个错误

1
verifying github.com/xxx/yyy/go.mod: github.com/xxxyyy@v0.1.11/go.mod: Get https://sum.golang.org/lookup/github.com/xxx/yyy@v0.1.11: dial tcp 216.58.197.113:443: i/o timeout

此时，我们有两种选择

  1. 关闭校验：go env -w GOSUMDB=off
  2. 修改校验地址：go env -w GOSUMDB="sum.golang.google.cn"

3.2.6 从gitlab上下载依赖包

需要设置环境变量GOPROXY以及GOPRIVATE

1
2
3
4
5
# 不使用代理，默认会使用 proxy.golang.org
export GOPROXY=direct

# 这样配置后，就可以从gitlab中下载tom以及jerry这两个组织中的所有代码了，否则会出现 410 Gone 这样的错误信息
export GOPRIVATE=gitlab.com/tom/*, gitlab.com/jerry/*

unable to install go module (private nested repository)

在设置完GOPROXY以及GOPRIVATE之后，有时会出现如下问题

1
2
3
4
5
... imports
        gitlab.com/xxx/yyy: git ls-remote -q https://gitlab.com/xxx/yyy.git in /Users/hechenfeng/.gorepo/pkg/mod/cache/vcs/82c21665246dae55cc8f78cc6ebbe6bed9f6ccc4d86a36f71bfb28f7477c0aee: exit status 128:
        fatal: could not read Username for 'https://gitlab.com': terminal prompts disabled
Confirm the import path was entered correctly.
If this is a private repository, see https://golang.org/doc/faq#git_https for additional information.

我们可以通过设置export GIT_TERMINAL_PROMPT=1来开启交互模式，但是随后执行go mod tidy时，auth的交互是有bug的，他会让你输入两次密码（很坑）。所以我们换另一种方式来解决，执行git ls-remote -q https://gitlab.com/xxx/yyy.git，执行过程中会要求你输入gitlab的账号和密码

随后，我们继续执行go mod tidy，还是报错，但报错信息如下

1
2
3
4
... imports
        gitlab.com/xxx/yyy: git ls-remote -q https://gitlab.com/xxx.git in /Users/hechenfeng/.gorepo/pkg/mod/cache/vcs/abaeae1021d76630bfb57ffb11ec22f4a1f393859f7c63b7c849108ca94a2157: exit status 128:
        remote: Not Found
        fatal: repository 'https://gitlab.com/xxx.git/' not found

这里就有点奇怪了，我的gitlab项目地址其实是gitlab.com/xxx/yyy.git，但是错误信息里面确尝试下载的是gitlab.com/xxx.git。最后发现，我只是在代码里面引入了gitlab.com/xxx/yyy，但并未在go.mod文件的require中配置gitlab.com/xxx/yyy的依赖项，所以go mod误认为gitlab.com/xxx是仓库地址

所以我们现在在go.mod文件中，将依赖加上即可

此外，如果我们gitlab的账号密码更新了，那么git仍然会用上一次的密码来进行鉴权，此时需要将该过期的密码从系统的秘钥中删除

  • 如果是Mac的OSX系统，在钥匙串的密码一项中，找到gitlab相关的数据，删掉即可

3.2.7 IDE-GoLand

新建go module项目

  1. 在新建时，可以直接选择go module项目（Go Modules (vgo)）
  2. 创建完毕之后，会自动在项目根目录创建go.mod文件

将非go module项目改造成go module项目

  1. 在工程根目录执行go mod init xxx/xxx创建go.mod文件
  2. Preferences->GO->Go Modules (vgo)->勾上Enable Go Modules (vgo) integration

3.3 go dep

3.3.1 安装

1
2
3
4
5
# 在工程中执行下面的命令安装dep
go get -u github.com/golang/dep/cmd/dep

# 查看是否安装成功
dep help

3.3.2 使用

1
2
3
4
5
6
7
8
# 初始化，会创建两个文件Gopkg.lock、Gopkg.toml，以及目录vendor
dep init

# 添加依赖项到当前工程中
dep ensure -add github.com/pkg/errors

# 安装依赖项到vendor目录汇总
dep ensure

4 pprof

5 Common-Libs

5.1 mysql

使用go语言操作mysql数据库

5.2 template

[gotemplate](https://golang.org/pkg/text/template/）

6 GoLand

6.1 build tags

例如，我在Mac上安装了GoLand，但是我想要调用linux环境下的syscall，但是在GoLand默认解析的是Mac版本的源码（syscall_darwin_amd64.go）

可以通过配置build tags，将OS配置成linux，配置方式：

  • Preferences
    • Go
      • Vendoring & Build Tags，然后将OS改成linux即可

7 参考