基于go interface{}==nil 的幾種坑及原理分析
本文是Go比較有名的一個坑，在以前面試的時候也被問過，為什么想起來寫這個？
因為我們線上就真實出現(xiàn)過這個坑,寫給不了解的人在使用 if err != nil 的時候提高警惕。
Go語言的interface{}在使用過程中有一個特別坑的特性，當(dāng)你比較一個interface{}類型的值是否是nil的時候，這是需要特別注意避免的問題。
先來看看一個demo：
package main
import "fmt"
type ErrorImpl struct{}
func (e *ErrorImpl) Error() string {
return ""
}
var ei *ErrorImpl
var e error
func ErrorImplFun() error {
return ei
}
func main() {
f := ErrorImplFun()
fmt.Println(f == nil)
}
輸出：
false
為什么不是true?
想要理解這個問題，首先需要理解interface{}變量的本質(zhì)。在Go語言中，一個interface{}類型的變量包含了2個指針，一個指針指向值的在編譯時確定的類型，另外一個指針指向?qū)嶋H的值。
// InterfaceStructure 定義了一個interface{}的內(nèi)部結(jié)構(gòu)
type InterfaceStructure struct {
pt uintptr // 到值類型的指針
pv uintptr // 到值內(nèi)容的指針
}
// asInterfaceStructure 將一個interface{}轉(zhuǎn)換為InterfaceStructure
func asInterfaceStructure(i interface{}) InterfaceStructure {
return *(*InterfaceStructure)(unsafe.Pointer(&i))
}
func main() {
var i1, i2 interface{}
var v1 int = 23
var v2 int = 23
i1 = v1
i2 = v2
fmt.Printf("sizeof interface{} = %d\n", unsafe.Sizeof(i1))
fmt.Printf("i1 %v %+v\n", i1, asInterfaceStructure(i1))
fmt.Printf("i2 %v %+v\n", i2, asInterfaceStructure(i2))
var nilInterface interface{}
var str *string
fmt.Printf("nil interface = %+v\n", asInterfaceStructure(nilInterface))
fmt.Printf("nil string = %+v\n", asInterfaceStructure(str))
fmt.Printf("nil = %+v\n", asInterfaceStructure(nil))
}
輸出：
sizeof interface{} = 16
i1 23 {pt:4812032 pv:825741246928}
i2 23 {pt:4812032 pv:825741246936}
nil interface = {pt:0 pv:0}
nil string = {pt:4802400 pv:0}
nil = {pt:0 pv:0}
當(dāng)我們將一個具體類型的值賦值給一個interface{}類型的變量的時候，就同時把類型和值都賦值給了interface{}里的兩個指針。如果這個具體類型的值是nil的話，interface{}變量依然會存儲對應(yīng)的類型指針和值指針。
如何解決？
方法一
返回的結(jié)果進行非nil檢查，然后再賦值給interface{}變量
type ErrorImpl struct{}
func (e *ErrorImpl) Error() string {
return ""
}
var ei *ErrorImpl
var e error
func ErrorImplFun() error {
if ei == nil {
return nil
}
return ei
}
func main() {
f := ErrorImplFun()
fmt.Println(f == nil)
}
輸出：
true
方法二
返回具體實現(xiàn)的類型而不是interface{}
package main
import "fmt"
type ErrorImpl struct{}
func (e *ErrorImpl) Error() string {
return ""
}
var ei *ErrorImpl
var e error
func ErrorImplFun() *ErrorImpl {
return ei
}
func main() {
f := ErrorImplFun()
fmt.Println(f == nil)
}
輸出：
true
解決由于第三方包帶來的坑
由于有的error是第三方包返回的，又自己不想改第三方包，只好接收處理的時候想辦法。
方法一
利用interface{}原理
is:=*(*InterfaceStructure)(unsafe.Pointer(&i))
if is.pt==0 && is.pv==0 {
//is nil do something
}
將底層指向值和指向值的類型的指針打印出來如果都是0，表示是nil
方法二
利用斷言,斷言出來具體類型再判斷非空
type ErrorImpl struct{}
func (e ErrorImpl) Error() string {
return "demo"
}
var ei *ErrorImpl
var e error
func ErrorImplFun() error {
//ei = &ErrorImpl{}
return ei
}
func main() {
f := ErrorImplFun()
//當(dāng)然error實現(xiàn)類型較多的話使用
//switch case方式斷言更清晰
res, ok := f.(*ErrorImpl)
fmt.Printf("ok:%v,f:%v,res:%v",
ok, f == nil, res == nil)
}
輸出：
ok:true,f:false,res:true
方法三
利用反射
type ErrorImpl struct{}
func (e ErrorImpl) Error() string {
return "demo"
}
var ei *ErrorImpl
var e error
func ErrorImplFun() error {
//ei = &ErrorImpl{}
return ei
}
func main() {
f := ErrorImplFun()
rv := reflect.ValueOf(f)
fmt.Printf("%v", rv.IsNil())
}
輸出：
true
注意⚠：
斷言和反射性能不是特別好，如果不得已再使用，控制使用有助于提升程序性能。
由于函數(shù)接收類型導(dǎo)致的panic：
type ErrorImpl struct{}
func (e ErrorImpl) Error() string {
return "demo"
}
var ei *ErrorImpl
var e error
func ErrorImplFun() error {
return ei
}
func main() {
f := ErrorImplFun()
fmt.Printf(f.Error())
}
輸出：
panic: value method main.ErrorImpl.Error called using nil *ErrorImpl pointer
解決：
func (e *ErrorImpl) Error() string {
return "demo"
}
輸出：
demo
可以發(fā)現(xiàn)將接收類型變成指針類型就可以了。
以上就是 nil 相關(guān)的坑，希望大家可以牢記，如果 ”幸運“ 的遇到了，可以想到這些可能性。
補充：go 語言 interface{} 的易錯點
如果說 goroutine 和 channel 是 go 語言并發(fā)的兩大基石，那 interface 就是 go 語言類型抽象的關(guān)鍵。
在實際項目中，幾乎所有的數(shù)據(jù)結(jié)構(gòu)最底層都是接口類型。
說起 C++ 語言，我們立即能想到是三個名詞：封裝、繼承、多態(tài)。go 語言雖然沒有嚴格意義上的對象，但通過 interface，可以說是實現(xiàn)了多態(tài)性。（由以組合結(jié)構(gòu)體實現(xiàn)了封裝、繼承的特性）
package main
type animal interface {
Move()
}
type bird struct{}
func (self *bird) Move() {
println("bird move")
}
type beast struct{}
func (self *beast) Move() {
println("beast move")
}
func animalMove(v animal) {
v.Move()
}
func main() {
var a *bird
var b *beast
animalMove(a) // bird move
animalMove(b) // beast move
}
go 語言中支持將 method、struct、struct 中成員定義為 interface 類型，使用 struct 舉一個簡單的栗子
使用 go 語言的 interface 特性，就能實現(xiàn)多態(tài)性，進行泛型編程。
二，interface 原理
如果沒有充分了解 interface 的本質(zhì)，就直接使用，那最終肯定會踩到很深的坑，要用就先要了解，先來看看 interface 源碼
type eface struct {
_type *_type
data unsafe.Pointer
}
type _type struct {
size uintptr // type size
ptrdata uintptr // size of memory prefix holding all pointers
hash uint32 // hash of type; avoids computation in hash tables
tflag tflag // extra type information flags
align uint8 // alignment of variable with this type
fieldalign uint8 // alignment of struct field with this type
kind uint8 // enumeration for C
alg *typeAlg // algorithm table
gcdata *byte // garbage collection data
str nameOff // string form
ptrToThis typeOff // type for pointer to this type, may be zero
}
可以看到 interface 變量之所以可以接收任何類型變量，是因為其本質(zhì)是一個對象，并記錄其類型和數(shù)據(jù)塊的指針。（其實 interface 的源碼還包含函數(shù)結(jié)構(gòu)和內(nèi)存分布，由于不是本文重點，有興趣的同學(xué)可以自行了解）
三，interface 判空的坑
對于一個空對象，我們往往通過 if v == nil 的條件語句判斷其是否為空，但在代碼中充斥著 interface 類型的情況下，很多時候判空都并不是我們想要的結(jié)果（其實了解或聰明的同學(xué)從上述 interface 的本質(zhì)是對象已經(jīng)知道我想要說的是什么）
package main
type animal interface {
Move()
}
type bird struct{}
func (self *bird) Move() {
println("bird move")
}
type beast struct{}
func (self *beast) Move() {
println("beast move")
}
func animalMove(v animal) {
if v == nil {
println("nil animal")
}
v.Move()
}
func main() {
var a *bird // nil
var b *beast // nil
animalMove(a) // bird move
animalMove(b) // beast move
}
還是剛才的栗子，其實在 go 語言中 var a *bird 這種寫法，a 只是聲明了其類型，但并沒有申請一塊空間，所以這時候 a 本質(zhì)還是指向空指針，但我們在 aminalMove 函數(shù)進行判空是失敗的，并且下面的 v.Move() 的調(diào)用也是成功的，本質(zhì)的原因就是因為 interface 是一個對象，在進行函數(shù)調(diào)用的時候，就會將 bird 類型的空指針進行隱式轉(zhuǎn)換，轉(zhuǎn)換成實例的 interface animal 對象，所以這時候 v 其實并不是空，而是其 data 變量指向了空。
這時候看著執(zhí)行都正常，那什么情況下坑才會絆倒我們呢？只需要加一段代碼
package main
type animal interface {
Move()
}
type bird struct {
name string
}
func (self *bird) Move() {
println("bird move %s", self.name) // panic
}
type beast struct {
name string
}
func (self *beast) Move() {
println("beast move %s", self.name) // panic
}
func animalMove(v animal) {
if v == nil {
println("nil animal")
}
v.Move()
}
func main() {
var a *bird // nil
var b *beast // nil
animalMove(a) // panic
animalMove(b) // panic
}
在代碼中，我們給派生類添加 name 變量，并在函數(shù)的實現(xiàn)中進行調(diào)用，就會發(fā)生 panic，這時候的 self 其實是 nil 指針。所以這里坑就出來了。
有些人覺得這類錯誤謹慎一些還是可以避免的，那是因為我們是正向思維去代入接口，但如果反向編程就容易造成很難發(fā)現(xiàn)的 bug
package main
type animal interface {
Move()
}
type bird struct {
name string
}
func (self *bird) Move() {
println("bird move %s", self.name)
}
type beast struct {
name string
}
func (self *beast) Move() {
println("beast move %s", self.name)
}
func animalMove(v animal) {
if v == nil {
println("nil animal")
}
v.Move()
}
func getBirdAnimal(name string) *bird {
if name != "" {
return &bird{name: name}
}
return nil
}
func main() {
var a animal
var b animal
a = getBirdAnimal("big bird")
b = getBirdAnimal("") // return interface{data:nil}
animalMove(a) // bird move big bird
animalMove(b) // panic
}
這里我們看到通過函數(shù)返回實例類型指針，當(dāng)返回 nil 時，因為接收的變量為接口類型，所以進行了隱性轉(zhuǎn)換再次導(dǎo)致了 panic（這類反向轉(zhuǎn)換很難發(fā)現(xiàn)）。
那我們?nèi)绾翁幚砩鲜鲞@類問題呢。我這邊整理了三個點
1，充分了解 interface 原理，使用過程中需要謹慎小心
2，謹慎使用泛型編程，接收變量使用接口類型，也需要保證接口返回為接口類型，而不應(yīng)該是實例類型
3，判空是使用反射 typeOf 和 valueOf 轉(zhuǎn)換成實例對象后再進行判空
相關(guān)文章
go?1.21.0?版本引入了一個新的包?log/slog,該包提供了結(jié)構(gòu)化日志的功能,本文小編就來和大家聊聊log/slog?包的使用,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-10-10
這篇文章主要介紹了go語言if/else語句用法,結(jié)合實例形式分析了go語言if else語句的判定與流程控制技巧,需要的朋友可以參考下2016-05-05
Go?實現(xiàn)?WebSockets和什么是?WebSockets
這篇文章主要介紹了Go?實現(xiàn)?WebSockets和什么是?WebSockets，WebSockets?是構(gòu)建實時應(yīng)用程序的第一大解決方案，在線游戲、即時通訊、跟蹤應(yīng)用程序等，下文相關(guān)內(nèi)容介紹需要的小伙伴可以參考一下2022-04-04
這篇文章主要介紹了Go整合ElasticSearch的相關(guān)知識，本文通過實例代碼給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-07-07
這篇文章主要介紹了Golang發(fā)送http GET請求的示例代碼，幫助大家更好的理解和使用golang，感興趣的朋友可以了解下2020-12-12
go-zero使用goctl生成mongodb的操作使用方法
mongodb是一種高性能、開源、文檔型的nosql數(shù)據(jù)庫,被廣泛應(yīng)用于web應(yīng)用、大數(shù)據(jù)以及云計算領(lǐng)域,goctl model 為 goctl 提供的數(shù)據(jù)庫模型代碼生成指令,目前支持 MySQL、PostgreSQL、Mongo 的代碼生成,本文給大家介紹了go-zero使用goctl生成mongodb的操作使用方法2024-06-06
這篇文章主要為大家介紹了Go快速開發(fā)一個RESTful API服務(wù)，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-06-06
Golang自定義結(jié)構(gòu)體轉(zhuǎn)map的操作
這篇文章主要介紹了Golang自定義結(jié)構(gòu)體轉(zhuǎn)map的操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-12-12
Go內(nèi)存分配器的設(shè)計思想來源于TCMalloc，全稱是Thread-Caching?Malloc，核心思想是把內(nèi)存分為多級管理，下面就來和大家深入聊聊Go語言內(nèi)存分配器的使用吧2023-06-06
Golang優(yōu)雅保持main函數(shù)不退出的辦法
很多時候我們需要讓main函數(shù)不退出,讓它在后臺一直執(zhí)行,下面這篇文章主要給大家介紹了關(guān)于Golang優(yōu)雅保持main函數(shù)不退出的相關(guān)資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2022-07-07