golang中的nil接收器 - tw511教學網

索引：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)
	}
}

看上去好像一點問題都沒有：

定義一個CustomError型別的指標
如果Name為空，初始化m，呼叫Add方法把錯誤新增到CustomError.errors
如果Code為空，如果m還沒有初始化，先初始化，呼叫Add方法把錯誤新增到CustomError.errors
最後返回自定義錯誤

但是當我們執行上面的程式碼時，會發現結果並不是我們想要的：

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型別的錯誤。