Go踩坑

go初学者常见错误

强烈建议 go 新手先过一遍下边这篇文章，go 写多了你一定会遇到很多里边总结的坑。

• 50 Shades of Go: Traps, Gotchas, and Common Mistakes for New Golang Devs

Go tricks

影子变量(Shadowed variables)

// https://yourbasic.org/golang/gotcha-shadowing-variables/
func main() {
    n := 0
    if true {
        n := 1
        n++
    }
    fmt.Println(n) // 0，注意 if 作用与里边使用 := 赋值隐藏了外部的 n，所以原来的 n 打印还是 0
    // 如果想要修改 n，直接用 n = 1
}

golang cannot refer to unexported field or method

小写开头只能被本 package 访问

• https://stackoverflow.com/questions/24487943/invoke-golang-struct-function-gives-cannot-refer-to-unexported-field-or-method

访问其它Go package中的私有函数(不推荐)

可以写一个公有函数暴露私有方法，不过一般私有方法都是希望隐藏的，就像 python 的下划线虽然不强制，但是不推荐使用。

• https://colobu.com/2017/05/12/call-private-functions-in-other-packages/

Can’t load package

同一个 folder 不要存在不同 package，否则 can’t load package

package is folder. package name is folder name. package path is folder path.

• https://studygolang.com/articles/8312

如何编译期间检查是否实现接口？

// for pointers to struct
type MyType struct{}
var _ MyInterface = (*MyType)(nil)  // 很多源码中可以看到这种写法，但是一开始感觉有点奇怪
// for struct literals
var _ MyInterface = MyType{}
// for other types - just create some instance
type MyType string
var _ MyInterface = MyType("doesn't matter")

• https://splice.com/blog/golang-verify-type-implements-interface-compile-time/
• https://medium.com/@matryer/golang-tip-compile-time-checks-to-ensure-your-type-satisfies-an-interface-c167afed3aae

如何通过反射判断是否实现接口?

type CustomError struct{}
func (*CustomError) Error() string {
    return ""
}
func testImplements() {
    // 判断某个类型是否实现了接口。
    // 获取接口类型 reflect.TypeOf((*<interface>)(nil)).Elem()
    typeOfError := reflect.TypeOf((*error)(nil)).Elem()
    customErrorPtr := reflect.TypeOf(&CustomError{})
    customError := reflect.TypeOf(CustomError{})
    fmt.Println(customErrorPtr.Implements(typeOfError)) // true
    fmt.Println(customError.Implements(typeOfError))    // false
}

Go 运行单个测试文件报错 undefined？

执行命令时加入这个测试文件需要引用的源码文件，在命令行后方的文件都会被加载到command-line-arguments中进行编译

go test -v getinfo_test.go lib.go

• https://www.cnblogs.com/Detector/p/10010292.html
• https://stackoverflow.com/questions/14723229/go-test-cant-find-function-in-a-same-package

Go 循环遍历 []struct 是值传递

注意循环遍历一个结构体切片是值传递，如果想要修改 struct 的值，请使用 slice 下标赋值或者用结构体指针。

type Cat struct {
  name string
}
func testSliceAssign() {
  cats := []Cat{
    {name: "cat1"},
    {name: "cat2"},
  }
  for _, cat := range cats { // cat 这里是拷贝的值
    cat.name = "new cat"  // NOTE: 注意这里 cat 是拷贝的值，所以你无法修改 cat。使用下标或者指针
  }
  fmt.Println(cats) // 无法修改 [{cat1} {cat2}]
  // 方式1：使用下标
  for i, _ := range cats {
    cats[i].name = "new cat"
  }
  fmt.Println(cats)
  // 方式2：使用struct 指针
  pcats := []*Cat{
    {name: "cat1"},
    {name: "cat2"},
  }
  for _, cat := range pcats {
    cat.name = "new cat"
  }
  for _, cat := range pcats {
    fmt.Println(cat)
  }
}

Go 无法修改值为结构体的map

func testChangeMapStruct() {
  type T struct{ Cnt int }
  m := map[string]T{"a": T{Cnt: 1}, "b": T{Cnt: 2}}
  for _, v := range m {
    v.Cnt = 100
  }
  fmt.Println(m)
  // 想要修改 map[string]T 的值，必须使用指针
  m2 := map[string]*T{"a": &T{Cnt: 1}, "b": &T{Cnt: 2}}
  for _, v := range m2 {
    v.Cnt = 100
  }
  fmt.Println(m2["a"])
}
func main() {
  testChangeMapStruct()
}

不要并发读写map，可能导致程序崩溃

使用内置 map 注意几点:

• 使用 make 初始化。直接声明然后赋值会 panic
• 赋值是浅拷贝。深拷贝需要自己复制
• 内置 map 不要并发写入或者删除，必须加锁。或者使用 sync.Map

如果多个 goroutine 并发对 map 进行读写，必须要同步，否则可能导致进程退出

// https://blog.golang.org/go-maps-in-action
var counter = struct{
    sync.RWMutex
    m map[string]int
}{m: make(map[string]int)}
counter.RLock() // locks for reading
n := counter.m["some_key"]
counter.RUnlock()
fmt.Println("some_key:", n)
counter.Lock() // locks for writing
counter.m["some_key"]++
counter.Unlock()

如何判断一个空结构体(empty struct)

// 注意需要加上括号，否则 syntax error
// https://stackoverflow.com/questions/28447297/how-to-check-for-an-empty-struct
if (Session{}) == session  {
    fmt.Println("is zero value")
}

go 如何实现函数默认值(go本身没提供)

// https://stackoverflow.com/questions/19612449/default-value-in-gos-method
// 可以通过传递零值或者 nil 的方式来判断。
// Both parameters are optional, use empty string for default value
func Concat1(a string, b int) string {
  if a == "" {
    a = "default-a"
  }
  if b == 0 {
    b = 5
  }
  return fmt.Sprintf("%s%d", a, b)
}

go 初始化 slice/map 的区别

直接看代码，注意 map 赋值之前需要先 make 创建，直接给一个 nil map 赋值会 panic，但是 slice 却可以直接声明然后 append。 如果是一个 struct 包含了 map，你应该在构造函数里进行 make 初始化，否则直接赋值也会 panic。

// 初始化一个全局 map 可以用 make，防止第一次赋值 nil map 会 panic
var globalMap = make(map[string]string) // 之后可以在 init() 函数初始化
func main() {
        var intSlice []int // 注意可以直接声明一个 slice 然后 append
        fmt.Println(intSlice)
        intSlice = append(intSlice, 1)
        fmt.Println(intSlice)
        // 已知最大容量的情况下，建议 make 初始化，可以避免重新分配内存提升效率
        maxCap := 3
        intSlice2 := make([]int, 0, maxCap)
        fmt.Println(intSlice2)
        m2 := make(map[int]int) // 如果是 map 要先 make 才可以，否则 panic
        m2[1] = 1 // ok
        fmt.Println(m2)
        // 直接声明然后赋值就会 panic。有一些 struct 包含了 map 结构体成员，构造函数里需要注意初始化 map，否则直接赋值panic
        // https://stackoverflow.com/questions/27553399/golang-how-to-initialize-a-map-field-within-a-struct
        var m1 map[int]int
        m1[1] = 1          // NOTE: panic ! 注意这样会panic 啊！！!
        fmt.Println(m1)
        type T struct {
            m map[int][int]
        }
        func NewT() T {
            return T{m: make(map[int]int)}
            // return T{m: map[int]int{}}
        }
}

go 没有内置的 set 结构

go 目前没有提供泛型，也没提供一个统一的 set 数据结构。可以使用 map[string]bool 来模拟 set(注意并发安全)。 或者使用第三方提供的 set 类型。

• https://github.com/deckarep/golang-set
• https://stackoverflow.com/questions/34018908/golang-why-dont-we-have-a-set-datastructure

编译 tag 的作用

// +build linux,386 darwin,!cgo

• https://golang.org/pkg/go/build/

Application auto build versioning

给 build 的二进制文件加上版本号，注意如果命令中输出有空格，需要加上单引号。 这样我们可以每次运行二进制文件的时候打印构建时间，当前的版本等信息。

// +build linux,386 darwin,!cgo
package main
import "fmt"
var xyz string
func main() {
    fmt.Println(xyz)
}
// $ go run -ldflags "-X main.xyz=abc" main.go
// go build -ldflags "-X main.minversion=`date -u +.%Y%m%d.%H%M%S`" service.go
// go build  -ldflags "-X 'main.time=$(date -u --rfc-3339=seconds)' -X 'main.git=$(git log --pretty=format:"%h" -1)'"  main.go

• https://stackoverflow.com/questions/11354518/application-auto-build-versioning

Go JSON 空值处理的一些坑，看示例

package main
import (
        "encoding/json"
        "fmt"
)
// https://www.sohamkamani.com/blog/golang/2018-07-19-golang-omitempty/
// omitempty 对于0值和，nil，pointer 的处理需要注意下坑。
func testNormal() {
        type Dog struct {
                Breed    string
                WeightKg int
        }
        d := Dog{
                Breed:    "dalmation",
                WeightKg: 45,
        }
        b, _ := json.Marshal(d)
        fmt.Println(string(b)) // {"Breed":"dalmation","WeightKg":45}
}
func testOmit() {
        type Dog struct {
                Breed    string
                WeightKg int
        }
        d := Dog{
                Breed: "pug",
        }
        b, _ := json.Marshal(d)
        fmt.Println(string(b)) //{"Breed":"pug","WeightKg":0}
        // 注意没填的字段输出0，如果不想输出0呢？比如想输出 null 或者压根不输出这个字段
}
func testOmitEmpty() {
        type Dog struct {
                Breed string
                // The first comma below is to separate the name tag from the omitempty tag
                WeightKg int `json:",omitempty"`
        }
        d := Dog{
                Breed: "pug",
        }
        b, _ := json.Marshal(d)
        fmt.Println(string(b)) // {"Breed":"pug"}
}
func testValuesCannotBeOmitted() {
        type dimension struct {
                Height int
                Width  int
        }
        type Dog struct {
                Breed    string
                WeightKg int
                Size     dimension `json:",omitempty"`
        }
        d := Dog{
                Breed: "pug",
        }
        b, _ := json.Marshal(d)
        fmt.Println(string(b)) //{"Breed":"pug","WeightKg":0,"Size":{"Height":0,"Width":0}}
}
func testValuesCannotBeOmittedButUsePointer() {
        type dimension struct {
                Height int
                Width  int
        }
        type Dog struct {
                Breed    string
                WeightKg int
                Size     *dimension `json:",omitempty"` //和上一个不同在于这里使用指针
        }
        d := Dog{
                Breed: "pug",
        }
        b, _ := json.Marshal(d)
        fmt.Println(string(b)) // {"Breed":"pug","WeightKg":0}
}
// The difference between 0, "" and nil
// One issue which particularly caused me a lot a trouble is the case where you want to differentiate between a default value, and a zero value.
//
// For example, if we have a struct describing a resteraunt, with the number of seated customers as an attribute:
func testZeroWillOmit() {
        type Restaurant struct {
                NumberOfCustomers int `json:",omitempty"`
        }
        d := Restaurant{
                NumberOfCustomers: 0,
        }
        b, _ := json.Marshal(d)
        fmt.Println(string(b)) // {}
        // 输出 {}， 0被省略了
}
func testZeroPointer() {
        type Restaurant struct {
                NumberOfCustomers *int `json:",omitempty"`
        }
        d1 := Restaurant{}
        b, _ := json.Marshal(d1)
        fmt.Println(string(b)) //Prints: {}
        n := 0
        d2 := Restaurant{
                NumberOfCustomers: &n,
        }
        b, _ = json.Marshal(d2)
        fmt.Println(string(b)) //Prints: {"NumberOfCustomers":0} ，总结一下就是值为 0 的 pointer 也不会省略字段
}
func main() {
        // testOmit()
        // testOmitEmpty()
        // testValuesCannotBeOmitted()
        // testValuesCannotBeOmittedButUsePointer()
        testZeroWillOmit()
}

• https://www.sohamkamani.com/blog/golang/2018-07-19-golang-omitempty/
• https://ethancai.github.io/2016/06/23/bad-parts-about-json-serialization-in-Golang/

Go int/int64/float 和 string 转换示例

// 推荐一个更加强大的转换库：https://github.com/spf13/cast
package main
import (
        "fmt"
        "strconv"
)
func main() { // 测试 int 和 string(decimal) 互相转换的函数
        // https://yourbasic.org/golang/convert-int-to-string/
        // int -> string
        sint := strconv.Itoa(97)
        fmt.Println(sint, sint == "97")
        // byte -> string
        bytea := byte(1)
        bint := strconv.Itoa(int(bytea))
        fmt.Println(bint)
        // int64 -> string
        sint64 := strconv.FormatInt(int64(97), 10)
        fmt.Println(sint64, sint64 == "97")
        // int64 -> string (hex) ，十六进制
        sint64hex := strconv.FormatInt(int64(97), 16)
        fmt.Println(sint64hex, sint64hex == "61")
        // string -> int
        _int, _ := strconv.Atoi("97")
        fmt.Println(_int, _int == int(97))
        // string -> int64
        _int64, _ := strconv.ParseInt("97", 10, 64)
        fmt.Println(_int64, _int64 == int64(97))
        // https://stackoverflow.com/questions/30299649/parse-string-to-specific-type-of-int-int8-int16-int32-int64
        // string -> int32，注意 parseInt 始终返回的是 int64，所以还是需要 int32(n) 强转一下
        _int32, _ := strconv.ParseInt("97", 10, 32)
        fmt.Println(_int32, int32(_int32) == int32(97))
        // int32 -> string, https://stackoverflow.com/questions/39442167/convert-int32-to-string-in-golang
        strconv.FormatInt(int64(i), 10) // fast
        strconv.Itoa(int(i)) // fast
        fmt.Sprint(i) // slow
        // int -> int64 ，不会丢失精度
        var n int = 97
        fmt.Println(int64(n) == int64(97))
        // string -> float32/float64  https://yourbasic.org/golang/convert-string-to-float/
        f := "3.14159265"
        if s, err := strconv.ParseFloat(f, 32); err == nil {
            fmt.Println(s) // 3.1415927410125732
        }
        if s, err := strconv.ParseFloat(f, 64); err == nil {
            fmt.Println(s) // 3.14159265
        }
        // float -> string https://yourbasic.org/golang/convert-string-to-float/
        s := fmt.Sprintf("%f", 123.456)
}

Go struct 如何设置默认值

Go 的结构体成员没法直接设置默认值，使用的是每个类型的默认值，可以 New 构造函数里设置。

// https://stackoverflow.com/questions/37135193/how-to-set-default-values-in-go-structs
//Something is the structure we work with
type Something struct {
     Text string
     DefaultText string
}
// NewSomething create new instance of Something
func NewSomething(text string) Something {
   something := Something{}
   something.Text = text
   something.DefaultText = "default text"
   return something
}

Go 如何使用枚举值 Enum

Go没有提供内置的枚举类型，不过可以使用自定义类型和常量值来实现枚举类型。 并且还可以给自定义的类型定义方法。

type Base int
const (
        A Base = iota
        C
        T
        G
)

• https://stackoverflow.com/questions/14426366/what-is-an-idiomatic-way-of-representing-enums-in-go
• https://blog.learngoprogramming.com/golang-const-type-enums-iota-bc4befd096d3

Go 如何断判非空字符串/slice

标准库实际上 len(s) != 0 和 s != "" 都有使用，我个人倾向于 s != "" 看起来更清楚，区分其他容器类型判断的方式。 比如如果使用 slice 可以使用 len(slice) == 0 判断是否为空。

Go 如何格式化参数

• https://yourbasic.org/golang/fmt-printf-reference-cheat-sheet/

命名返回值

go 的返回值可以命名，使用命名返回值有几个用处：

• 可以当成文档，直观的展示返回值的含义
• 自动初始化为类型的零值
• 返回的时候不用写很多参数名，直接用 return 就行
• 如果想要在 defer 中修改返回值，只能使用命名参数。例子如下
• 缺点：函数里很容易误用声明一个同名的参数就会被被覆盖了(shadow)
• 函数返回相同类型的两个或三个参数，或者如果从上下文中不清楚结果的含义，使用命名返回，其它情况不建议使用命名返回。

func namedReturn(i int) (ret int) {
    ret = i
    defer func() { ret++ }()
    return
}
func anonReturn(i int) int {
    ret := i
    defer func() { ret++ }() // 修改 ret 无效
    return ret
}
func main() {
    fmt.Println(namedReturn(0)) // 1
    fmt.Println(anonReturn(0))  // 0
}

Go 如何复制map

注意 go 和其他很多编程语言一样，对于复合结构是浅拷贝，共享底层数据结构。几个变量指向同一个复合结构的时候注意修改一个对其他变量也是可见的。

// https://stackoverflow.com/questions/23057785/how-to-copy-a-map
func copyMap(src map[string]string) map[string]string {
  res := make(map[string]string)
  for k, v := range src {
    res[k] = v
  }
  return res
}
func testShareMap() {
  am := []map[string]string{
    map[string]string{"a1": "a1", "b1": "b1"},
    map[string]string{"a2": "a2", "b2": "b2"},
  }
  bm := am
  bm[0]["a1"] = "testbm" // NOTE 这里修改了b，a 里边的也会变。共享 map
  fmt.Println(am)
  var cm []map[string]string
  for _, m := range am {
    cm = append(cm, copyMap(m))
  }
  cm[0]["a1"] = "testcm" // will not modify am
  fmt.Println(am)
}
func main() {
  testShareMap()
}

闭包问题

package main
import (
        "fmt"
        "time"
)
// 闭包问题
func testClosure() {
        data := []string{"one", "two", "three"}
        for _, v := range data {
                go func() {
                        fmt.Println(v)
                }()
        }
        time.Sleep(1 * time.Second) // not good, just for demo
        // three three three
}
// 两种方式解决：1.使用一个for 循环临时变量
func testClosure1() {
        data := []string{"one", "two", "three"}
        for _, v := range data {
                vcopy := v
                go func() {
                        fmt.Println(vcopy)
                }()
        }
        time.Sleep(1 * time.Second) // not good, just for demo
        // one two three (may wrong order)
}
// 方法2：使用传给匿名goroutine参数，推荐使用这种方式
func testClosure2() {
        data := []string{"one", "two", "three"}
        for _, v := range data {
                go func(in string) {
                        fmt.Println(in)
                }(v)
        }
        time.Sleep(1 * time.Second) // not good, just for demo
        // one two three (may wrong order)
}
type field struct {
        name string
}
func (p *field) print() {
        fmt.Println(p.name)
}
func testField() {
        data := []field{{"one"}, {"two"}, {"three"}}
        for _, v := range data {
                // v := v    // NOTE：直接这样就可以解决，
                // 或者使用 struct 指针。 []*field 初始化
                go v.print() // print three three three
        }
        time.Sleep(1 * time.Second)
}
func main() {
        // testClosure()
        // testClosure1()
        // testClosure2()
        testField()
}

Failed Type Assertions

package main
import "fmt"
func main() {
        var data interface{} = "hehe"
        // NOTE: 这里不要用 同名的 data 变量，比如换成 dataInt
        if data, ok := data.(int); ok {
                fmt.Println("[is an int] value =>", data)
        } else {
                fmt.Println("[not an int] value =>", data)
                // NOTE ：注意 data 已经被失败的 type assert 赋值成了0
        }
}

An interface holding a nil value is not nil

An interface holding nil value is not nil. An interface equals nil only if both type and value are nil.

package main
import "fmt"
func main() {
    var a interface{}
    fmt.Printf("a == nil is %t\n", a == nil) // a == nil is true
    var b interface{}
    var p *int = nil
    b = p
    fmt.Printf("b == nil is %t\n", b == nil) // b == nil is false
}

逃逸分析

想要知道变量在 stask 还是 heap 分配使用 go run -gcflags -m app.go

报错：go test flag: flag provided but not defined

• https://stackoverflow.com/questions/29699982/go-test-flag-flag-provided-but-not-defined

redio tricks

redis 连接超时

默认是没有超时时间的，注意设置超时时间（connect/read/write)。

• https://ms2008.github.io/2019/07/04/golang-redis-deadlock/

redis 单测如何 mock

reids mock 可以用 miniredis，以下是一个示例代码

package main
import (
  "fmt"
  "os"
  "testing"
  "github.com/alicebob/miniredis"
  "github.com/go-redis/redis"
  "github.com/stretchr/testify/assert"
)
var followImpl *Follow
func setupFollow() {
  fmt.Println("setup")
  mr, err := miniredis.Run()
  if err != nil {
    panic("init miniredis failed")
  }
  client := redis.NewClient(&redis.Options{
    Addr: mr.Addr(),
  })
  _ = client.Set("key", "wang", 0).Err()
  followImpl = &Follow{client: client}
}
func TestGet(t *testing.T) {
  val, err := followImpl.Get("key")
  followImpl.client.Set("key", "2", 0)
  fmt.Println(val, err)
  assert.Equal(t, val, "wang")
}
func TestPING(t *testing.T) {
  PING()
}
func TestMain(m *testing.M) {
  setupFollow()
  code := m.Run()
  os.Exit(code)
}

网络相关

获取本机 ip

package main
import (
    "fmt"
    "log"
    "net"
    "time"
)
var localIp string // 用一个全局变量或者缓存，防止高并发的时候重复频繁系统调用
// GetIPAddr 获取 server IP
func GetIPAddr() string {
    if localIp != "" {
        // fmt.Printf("use local ip %s\n", localIp)
        return localIp
    }
    addrs, err := net.InterfaceAddrs()
    if err != nil {
        return ""
    }
    for _, addr := range addrs {
        if ipnet, ok := addr.(*net.IPNet); ok && !ipnet.IP.IsLoopback() {
            if ipnet.IP.To4() != nil {
                localIp = ipnet.IP.String()
                return localIp
            }
        }
    }
    return ""
}
func main() {
    fmt.Println(GetIPAddr())
}

Go panic 场景

在《Go 编程之旅》中总结了一些 panic 场景，写 go 的时候留意下：

• 数组/切片越界
• 空指针调用
• 过早关闭 HTTP 响应体
• 除以 0
• 向已经关闭的 channel 发送消息
• 重复关闭 channel
• 关闭未初始化的 channel
• 未初始化 map
• 跨协程的 panic 处理
• sync 计数为负数。