1、nil是什么

相信写过Golang的程序员对下面一段代码是非常非常熟悉的了:

  1. if err != nil {
  2. // do something....
  3. }

当出现不等于nil的时候,说明出现某些错误了,需要我们对这个错误进行一些处理,而如果等于nil说明运行正常。那什么是nil呢?查一下词典可以知道,nil的意思是无,或者是零值。零值,zero value,是不是有点熟悉?在Go语言中,如果你声明了一个变量但是没有对它进行赋值操作,那么这个变量就会有一个类型的默认零值。这是每种类型对应的零值:

  1. bool -> false
  2. numbers -> 0
  3. string -> ""
  4. pointers -> nil
  5. slices -> nil
  6. maps -> nil
  7. channels -> nil
  8. functions -> nil
  9. interfaces -> nil

举个例子,当你定义了一个struct:

  1. type Person struct {
  2. AgeYears int
  3. Name string
  4. Friends []Person
  5. }
  6. var p Person // Person{0, "", nil}

变量p只声明但没有赋值,所以p的所有字段都有对应的零值。那么,这个nil到底是什么呢?Go的文档中说到,nil是预定义的标识符,代表指针通道函数接口映__射切片的零值,也就是预定义好的一个变量:

  1. type Type int
  2. var nil Type

是不是有点惊讶?nil并不是Go的关键字之一,你甚至可以自己去改变nil的值:

  1. var nil = errors.New("hi")

这样是完全可以编译得过的,但是最好不要这样子去做。

2、nil有什么用

在了解了什么是nil之后,再来说说nil有什么用。

pointers

  1. var p *int
  2. p == nil // true
  3. *p // panic: invalid memory address or nil pointer dereference

指针表示指向内存的地址,如果对为nil的指针进行解引用的话就会导致panic。那么为nil的指针有什么用呢?先来看一个计算二叉树和的例子:

  1. type tree struct {
  2. v int
  3. l *tree
  4. r *tree
  5. }
  6. // first solution
  7. func (t *tree) Sum() int {
  8. sum := t.v
  9. if t.l != nil {
  10. sum += t.l.Sum()
  11. }
  12. if t.r != nil {
  13. sum += t.r.Sum()
  14. }
  15. return sum
  16. }

上面的代码有两个问题,一个是代码重复:

  1. if v != nil {
  2. v.m()
  3. }

另一个是当tnil的时候会panic:

  1. var t *tree
  2. sum := t.Sum() // panic: invalid memory address or nil pointer dereference

怎么解决上面的问题?我们先来看看一个指针接收器的例子

  1. type person struct {}
  2. func sayHi(p *person) { fmt.Println("hi") }
  3. func (p *person) sayHi() { fmt.Println("hi") }
  4. var p *person
  5. p.sayHi() // hi

对于指针对象的方法来说,就算指针的值为nil也是可以调用的,基于此,我们可以对刚刚计算二叉树和的例子进行一下改造:

  1. func(t *tree) Sum() int {
  2. if t == nil {
  3. return 0
  4. }
  5. return t.v + t.l.Sum() + t.r.Sum()
  6. }

跟刚才的代码一对比是不是简洁了很多?对于nil指针,只需要在方法前面判断一下就ok了,无需重复判断。换成打印二叉树的值或者查找二叉树的某个值都是一样的:

  1. func(t *tree) String() string {
  2. if t == nil {
  3. return ""
  4. }
  5. return fmt.Sprint(t.l, t.v, t.r)
  6. }
  7. // nil receivers are useful: Find
  8. func (t *tree) Find(v int) bool {
  9. if t == nil {
  10. return false
  11. }
  12. return t.v == v || t.l.Find(v) || t.r.Find(v)
  13. }

所以如果不是很需要的话,不要用NewX()去初始化值,而是使用它们的默认值。

slices

  1. // nil slices
  2. var s []slice
  3. len(s) // 0
  4. cap(s) // 0
  5. for range s // iterates zero times
  6. s[i] // panic: index out of range

一个为nil的slice,除了不能索引外,其他的操作都是可以的,当你需要填充值的时候可以使用append函数,slice会自动进行扩充。那么为nil的slice的底层结构是怎样的呢?根据官方的文档,slice有三个元素,分别是长度、容量、指向数组的指针:
理解Go语言的nil - 图1
当有元素的时候:
理解Go语言的nil - 图2
所以我们并不需要担心slice的大小,使用append的话slice会自动扩容。(视频中说slice自动扩容速度很快,不必担心性能问题,这个值得商榷,在确定slice大小的情况只进行一次内存分配总是好的)

map

对于Go来说,map,function,channel都是特殊的指针,指向各自特定的实现,这个我们暂时可以不用管。

  1. // nil maps
  2. var m map[t]u
  3. len(m) // 0
  4. for range m // iterates zero times
  5. v, ok := m[i] // zero(u), false
  6. m[i] = x // panic: assignment to entry in nil map

对于nil的map,我们可以简单把它看成是一个只读的map,不能进行写操作,否则就会panic。那么nil的map有什么用呢?看一下这个例子:

  1. func NewGet(url string, headers map[string]string) (*http.Request, error) {
  2. req, err := http.NewRequest(http.MethodGet, url, nil)
  3. if err != nil {
  4. return nil, err
  5. }
  6. for k, v := range headers {
  7. req.Header.Set(k, v)
  8. }
  9. return req, nil
  10. }

对于NewGet来说,我们需要传入一个类型为map的参数,并且这个函数只是对这个参数进行读取,我们可以传入一个非空的值:

  1. NewGet("http://google.com", map[string]string{
  2. "USER_AGENT": "golang/gopher",
  3. },)

或者这样传:

  1. NewGet("http://google.com", map[string]string{})

但是前面也说了,map的零值是nil,所以当header为空的时候,我们也可以直接传入一个nil

  1. NewGet("http://google.com", nil)

是不是简洁很多?所以,把nil map作为一个只读的空的map进行读取吧。

channel

  1. // nil channels
  2. var c chan t
  3. <- c // blocks forever
  4. c <- x // blocks forever
  5. close(c) // panic: close of nil channel

关闭一个nil的channel会导致程序panic(如何关闭channel可以看这篇文章:如何优雅地关闭Go channel)举个例子,假如现在有两个channel负责输入,一个channel负责汇总,简单的实现代码:

  1. func merge(out chan<- int, a, b <-chan int) {
  2. for {
  3. select {
  4. case v := <-a:
  5. out <- v
  6. case v := <- b:
  7. out <- v
  8. }
  9. }
  10. }

如果在外部调用中关闭了a或者b,那么就会不断地从a或者b中读出0,这和我们想要的不一样,我们想关闭a和b后就停止汇总了,修改一下代码:

  1. func merge(out chan<- int, a, b <-chan int) {
  2. for a != nil || b != nil {
  3. select {
  4. case v, ok := <-a:
  5. if !ok {
  6. a = nil
  7. fmt.Println("a is nil")
  8. continue
  9. }
  10. out <- v
  11. case v, ok := <-b:
  12. if !ok {
  13. b = nil
  14. fmt.Println("b is nil")
  15. continue
  16. }
  17. out <- v
  18. }
  19. }
  20. fmt.Println("close out")
  21. close(out)
  22. }

在知道channel关闭后,将channel的值设为nil,这样子就相当于将这个select case子句停用了,因为nil的channel是永远阻塞的。

interface

interface并不是一个指针,它的底层实现由两部分组成,一个是类型,一个值,也就是类似于:(Type, Value)。只有当类型和值都是nil的时候,才等于nil。看看下面的代码:

  1. func do() error { // error(*doError, nil)
  2. var err *doError
  3. return err // nil of type *doError
  4. }
  5. func main() {
  6. err := do()
  7. fmt.Println(err == nil)
  8. }

输出结果是falsedo函数声明了一个*doErro的变量err,然后返回,返回值是error接口,但是这个时候的Type已经变成了:(*doError,nil),所以和nil肯定是不会相等的。所以我们在写函数的时候,不要声明具体的error变量,而是应该直接返回nil

  1. func do() error {
  2. return nil
  3. }

再来看看这个例子:

  1. func do() *doError { // nil of type *doError
  2. return nil
  3. }
  4. func wrapDo() error { // error (*doError, nil)
  5. return do() // nil of type *doError
  6. }
  7. func main() {
  8. err := wrapDo() // error (*doError, nil)
  9. fmt.Println(err == nil) // false
  10. }

这里最终的输出结果也是false。为什么呢?尽管wrapDo函数返回的是error类型,但是do返回的却是*doError类型,也就是变成了(*doError,nil),自然也就和nil不相等了。因此,不要返回具体的错误类型。遵从这两条建议,才可以放心地使用if x != nil