golang中的nil接收器

索引：https://waterflow.link/articles/1666534616841

我们先看一个简单的例子，我们自定义一个错误，用来把多个错误放在一起输出：

type CustomError struct {
	errors []string
}

func (c *CustomError) Add(err string) {
	c.errors = append(c.errors, err)
}

func (c *CustomError) Error() string {
	return strings.Join(c.errors, ";")
}

因为实现了Error() string方法，所以它实现了error接口。

现在我们要实现一个添加课件的功能，但是添加之前需要验证参数的合法性，所以我们创建了一个Validate方法，我们可能会这么写：

package main

import (
	"errors"
	"fmt"
	"strings"
)

type CustomError struct {
	errors []string
}

func (c *CustomError) Add(err error) {
	c.errors = append(c.errors, err.Error())
}

func (c *CustomError) Error() string {
	return strings.Join(c.errors, ";")
}

type Courseware struct {
	Name string
	Code string
}

func (c *Courseware) Validate() error {
	var m *CustomError // 1
	if c.Name == "" { // 2
		m = &CustomError{}
		m.Add(errors.New("课件名不能为空"))
	}
	if c.Code == "" { // 3
		if m == nil {
			m = &CustomError{}
		}
		m.Add(errors.New("课件编号不能为空"))
	}

	return m // 4
}

func main() {
	m := Courseware{
		Name: "多媒体课件",
		Code: "CW330",
	}
	if err := m.Validate(); err != nil {
		fmt.Println("valid err: ", err)
	}
}

看上去好像一点问题都没有：

1. 定义一个CustomError类型的指针
2. 如果Name为空，初始化m，调用Add方法把错误添加到CustomError.errors
3. 如果Code为空，如果m还没有初始化，先初始化，调用Add方法把错误添加到CustomError.errors
4. 最后返回自定义错误

但是当我们执行上面的代码时，会发现结果并不是我们想要的：

go run 8.go
valid err:  <nil>

我们发现居然走到了打印错误的判断里，但是打印出来的错误居然是一个nil。

在 Go 中，我们必须知道指针接收器可以为 nil。我们看一个简单的例子：

package main

import (
	"fmt"
)

type Demo struct {
}

func (d *Demo) Print() string {
	return "demo"
}

func main() {
	var d *Demo
	fmt.Println(d)
	fmt.Println(d.Print())
}

go run 8.go
<nil>
demo

Demo被初始化为nil，但是这段代码可以正常运行。说明nil指针也可以作为接收器。

其实上面的Print方法等价于：

func Print(d *Demo) string {
	return "demo"
}

因为将 nil 指针传递给函数是有效的。 所以使用 nil 指针作为接收器也是有效的。

我们继续回到上面的自定义错误。

m 被初始化为指针的零值：nil。 如果所有验证都通过，return 语句返回的结果不是 nil，而是一个 nil 指针。 因为 nil 指针是一个有效的接收器，所以将结果转换为error接口不会产生 nil 值。

所以我们虽然返回了一个nil指针，但是转换为error接口时并不是一个nil的接口（虽然是nil指针，但是是*CustomError类型，并实现了error）。

要解决这个问题，我们只要直接返回nil值，不返回nil的指针：

package main

import (
	"errors"
	"fmt"
	"strings"
)

type CustomError struct {
	errors []string
}

func (c *CustomError) Add(err error) {
	c.errors = append(c.errors, err.Error())
}

func (c *CustomError) Error() string {
	return strings.Join(c.errors, ";")
}

type Courseware struct {
	Name string
	Code string
}

func (c *Courseware) Validate() error {
	var m *CustomError
	if c.Name == "" {
		m = &CustomError{}
		m.Add(errors.New("课件名不能为空"))
	}
	if c.Code == "" {
		if m == nil {
			m = &CustomError{}
		}
		m.Add(errors.New("课件编号不能为空"))
	}

  // 这里如果m指针为nil，直接返回nil
	if m == nil {
		return nil
	}

	return m
}

func main() {
	m := Courseware{
		Name: "多媒体课件",
		Code: "CW330",
	}

	if err := m.Validate(); err != nil {
		fmt.Println("valid err: ", err)
	}
}

或者我们直接返回*CustomError类型的错误：

package main

import (
	"errors"
	"fmt"
	"strings"
)

type CustomError struct {
	errors []string
}

func (c *CustomError) Add(err error) {
	c.errors = append(c.errors, err.Error())
}

func (c *CustomError) Error() string {
	return strings.Join(c.errors, ";")
}

type Courseware struct {
	Name string
	Code string
}

// 返回*CustomError
func (c *Courseware) Validate() *CustomError {
	var m *CustomError
	if c.Name == "" {
		m = &CustomError{}
		m.Add(errors.New("课件名不能为空"))
	}
	if c.Code == "" {
		if m == nil {
			m = &CustomError{}
		}
		m.Add(errors.New("课件编号不能为空"))
	}

	return m
}

func main() {
	m := Courseware{
		Name: "多媒体课件",
		Code: "CW330",
	}

	if err := m.Validate(); err != nil {
		fmt.Println("valid err: ", err)
	}
}

但这并不是可取的，为了扩展我们实现了error接口，也需要返回error类型的错误。