Golang - 空指针如何预防

在Go语言中，空指针是一个常见的运行时错误来源，它通常发生在尝试访问一个未被初始化或已被设置为nil的指针所指向的值。

1、凡是有点『.』操作的的行为都要先进行非nil判断：

例如，想记录一个err的msg，通过err.Error()就可以获取到err的string类型的错误消息msg，但这里需要对err进行非nil判断：

if err != nil {
    log.Error("err",err.Error())
}

再如，如果想对一个interface{}的变量进行类型转换，那么应该先对该interface{}进行非nil判断：

a := map[string]interface{}{"1":1,"2":2}
var aIntVal int
if a["3"] != nil {
    aIntVal := a["3"].(int)
}

因为interface{}的默认值就是nil，它不跟int默认是0，string默认是""一样，所以需要对interfa{}的值进行判断，否则容易空指针异常。

2、切片、映射或通道未初始化

虽然切片、映射和通道不是指针类型，但如果在使用它们之前没有进行初始化，同样会导致运行时错误。对于切片和映射，应该使用make函数进行初始化；对于通道，应该使用make或new结合字面量进行初始化。

错误示范：

var s []int  
fmt.Println(s[0]) // 错误：索引越界（不是空指针错误，但同样是运行时错误）  
  
var m map[string]int  
fmt.Println(m["key"]) // 错误：空指针解引用（映射未初始化）  
  
var ch chan int  
ch <- 1 // 错误：向未初始化的通道发送数据（不是空指针错误，但会导致panic）

正确示范：

 // 初始化切片  
    slice := make([]string, 0, 5) // 创建一个空的字符串切片，容量为5  
    slice = append(slice, "apple", "banana") // 向切片中添加元素  
    fmt.Println(slice) // 输出: [apple banana]  
  
    // 初始化映射  
    mapping := make(map[string]int) // 创建一个空的字符串到整数的映射  
    mapping["apple"] = 1  
    mapping["banana"] = 2  
    fmt.Println(mapping) // 输出: map[apple:1 banana:2]  
  
    // 初始化通道  
    channel := make(chan string) // 创建一个字符串通道  
    go func() {  
        channel <- "message" // 在另一个goroutine中向通道发送消息  
    }()  
    msg := <-channel // 从通道接收消息  
    fmt.Println(msg) // 输出: message  

3、 初始化指针
确保在使用指针之前对其进行初始化。对于结构体、切片、映射和通道等复合类型，使用make函数进行初始化。对于其他类型的指针，可以使用new函数或直接在声明时进行初始化。

var p *MyType = new(MyType) // 使用new初始化指针
或者 p := &MyType{} // 直接初始化指针

4、检查指针是否为nil

在解析引用指针之前，始终检查它是否为nil。这可以通过简单的比较实现：

if p != nil {  
    // 安全地使用p指向的值  
}

5、使用短变量声明和初始化

利用Go语言的短变量声明特性，可以在声明变量的同时确保它不为nil：

if p := getPointer(); p != nil {  
    // 使用p指向的值  
}

在这个例子中，如果getPointer()返回nil，则不会执行花括号内的代码。

6、使用可选的类型和错误处理

对于可能返回nil的函数，考虑使用返回值和错误（error）的方式，而不是直接返回指针。这样调用者可以检查错误，并据此决定如何处理nil值。

func GetResource() (*ResourceType, error) {  
    // ...获取资源的逻辑  
    if 资源不存在 {  
        return nil, errors.New("resource not found")  
    }  
    return &ResourceType{}, nil  
}  
  
func main() {  
    resource, err := GetResource()  
    if err != nil {  
        // 处理错误，比如记录日志或返回错误给调用者  
        return  
    }  
    // 安全地使用resource  
}

7、避免使用裸指针
尽可能使用值接收者和返回值，而不是指针，除非有明确的理由需要指针（比如性能优化或修改调用者的变量）。这样可以减少处理nil指针的需要。
8、使用安全的数据结构和方法
设计安全的接口和数据结构，避免将内部状态的裸指针暴露给外部调用者。通过封装和数据隐藏，可以减少外部代码错误处理指针的机会。
9、使用断言和类型检查
对于接口值，使用类型断言时总是检查第二个返回值（布尔值），以确定断言是否成功。这可以避免在断言失败时解引用一个nil指针。

var value interface{} = getSomeValue()  
if typedValue, ok := value.(SomeType); ok {  
    // 使用typedValue，它是SomeType类型，不是nil  
} else {  
    // 处理类型断言失败的情况  
}

总结：

预防和处理Go语言中的空指针错误需要遵循良好的编程习惯，包括始终初始化指针、在解析引用前检查nil、使用错误处理替代返回nil指针、避免不必要的指针使用，以及使用安全的接口和数据结构。通过这些策略，可以显著减少空指针错误并提高代码的健壮性。