Go语言第一不胜坑 – interface 与 nil 的比

interface简介

Go语言以略好达成亲手要出名,它的语法非常简单,熟悉C++,Java的开发者只待特别紧缺的岁月哪怕可以操纵Go语言的为主用法。

interface是Go语言里所提供的万分重大的特点。一个interface里可以定义一个或者基本上个函数,例如系统自带的io.ReadWriter的定义如下所示:

type ReadWriter interface {
    Read(b []byte) (n int, err error)
    Write(b []byte) (n int, err error)
}

另项目只要她提供了Read和Write的绑定函数实现,Go就认为这个类型实现了这interface(duck-type),而无像Java需要开发者使用implements标明。

而Go语言的interface在利用过程中却生一个特地坑的性状,当您比一个interface类型的价值是否是nil的下,这是内需特别注意避免的问题。

同等浅真正的登坑

即是咱以GoWorld分布式游戏服务器的开发中,碰到的一个实在的bug。由于GoWorld支持多种不同的数据库(包括MongoDB,Redis等)来保存服务端对象,因此GoWorld在上层提供了一个联之对象存储接口定义,而异的目标数据库实现只待贯彻EntityStorage接口所提供的函数即可。

// EntityStorage defines the interface of entity storage backends
type EntityStorage interface {
    List(typeName string) ([]common.EntityID, error)
    Write(typeName string, entityID common.EntityID, data interface{}) error
    Read(typeName string, entityID common.EntityID) (interface{}, error)
    Exists(typeName string, entityID common.EntityID) (bool, error)
    Close()
    IsEOF(err error) bool
}

因一个采取Redis作为目标数据库的实现吗条例,函数OpenRedis连接Redis数据库并最终回到一个redisEntityStorage目标的指针。

// OpenRedis opens redis as entity storage
func OpenRedis(url string, dbindex int) *redisEntityStorage {
    c, err := redis.DialURL(url)
    if err != nil {
        return nil
    }

    if dbindex >= 0 {
        if _, err := c.Do("SELECT", dbindex); err != nil {
            return nil
        }
    }

    es := &redisEntityStorage{
        c: c,
    }

    return es
}

当上层逻辑中,我们使用OpenRedis函数连接Redis数据库,并拿回到的redisEntityStorage指南针赋值个一个EntityStorage接口变量,因为redisEntityStorage对象实现了EntityStorage接口所定义的具有函数。

var storageEngine StorageEngine // 这是一个全局变量
storageEngine = OpenRedis(cfg.Url, dbindex)
if storageEngine != nil {
    // 连接成功
    ...
} else {
    // 连接失败
    ...
}

面的代码看起还深正常,OpenRedis于连接Redis数据库失败的上会回去nil,然后调用者将返回值和nil进行比较,来判定是否连成。这个就算是Go语言少有的几乎单深坑之一,因为任OpenRedis函数是否连接Redis成功,都见面运行连接成之逻辑。

搜索问题所在

怀念使解这题目,首先要理解interface{}变量的本来面目。在Go语言中,一个interface{}类型的变量包含了2独指针,一个指针指向值的种,另外一个指南针指于实际的价值。
我们得据此如下的测试代码进行说明。

// InterfaceStructure 定义了一个interface{}的内部结构
type InterfaceStructure struct {
    pt uintptr // 到值类型的指针
    pv uintptr // 到值内容的指针
}

// asInterfaceStructure 将一个interface{}转换为InterfaceStructure
func asInterfaceStructure (i interface{}) InterfaceStructure {
    return *(*InterfaceStructure)(unsafe.Pointer(&i))
}

func TestInterfaceStructure(t *testing.T) {
    var i1, i2 interface{}
    var v1 int = 0x0AAAAAAAAAAAAAAA
    var v2 int = 0x0BBBBBBBBBBBBBBB
    i1 = v1
    i2 = v2
    fmt.Printf("sizeof interface{} = %d\n", unsafe.Sizeof(i1))
    fmt.Printf("i1 %x %+v\n", i1, asInterfaceStructure(i1))
    fmt.Printf("i2 %x %+v\n", i2, asInterfaceStructure(i2))
    var nilInterface interface{}
    fmt.Printf("nil interface = %+v\n", asInterfaceStructure(nilInterface))
}

当下段代码的输出如下:

sizeof interface{} = 16
i1 aaaaaaaaaaaaaaa {pt:5328736 pv:825741282816}
i2 bbbbbbbbbbbbbbb {pt:5328736 pv:825741282824}
nil interface = {pt:0 pv:0}

因而对一个interface{}类型的nil变量来说,它的点滴独指针都是0。这是契合Go语言对nil的正儿八经定义的。在Go语言中,nil是零值(Zero Value),而当Java之类的语言里,null实际上是空指针。关于零值和空指针有什么分别,这里就不再进行了。

当我们用一个实际项目的价赋值给一个interface类型的变量的早晚,就同时把种及值都赋值给了interface里的星星单指针。如果这现实品种的值是nil的说话,interface变量依然会储存对应之路指针和值指针。

func TestAssignInterfaceNil(t *testing.T) {
    var p *int = nil
    var i interface{} = p
    fmt.Printf("%v %+v is nil %v\n", i, asInterfaceStructure(i), i == nil)
}

输入如下:

<nil> {pt:5300576 pv:0} is nil false

可见,在这种状态下,虽然我们把一个nil值赋值给interface{},但是实际上interface里依然满怀了靠为品种的指针,所以将这个interface变量去与nil常量进行比较的讲话虽会回去false

哪些化解之题目

思念使回避这个Go语言的坑,我们而举行的哪怕是免将一个发或吧nil的切切实实品种的值赋值给interface变量。以上述的OpenRedis呢条例,一栽方式是预先对OpenRedis归来的结果开展非-nil检查,然后再次赋值给interface变量,如下所示。

var storageEngine StorageEngine // 这是一个全局变量
redis := OpenRedis(cfg.Url, dbindex)
if redis != nil {
    // 连接成功
    storageEngine = redis // 确定redis不是nil之后再赋值给interface变量
} else {
    // 连接失败
    ...
}

除此以外一栽办法是被OpenRedis函数直接回到EntityStorage接口类型的值,这样尽管可以把OpenRedis的归值直接对赋值给EntityStorage接口变量。

// OpenRedis opens redis as entity storage
func OpenRedis(url string, dbindex int) EntityStorage {
    c, err := redis.DialURL(url)
    if err != nil {
        return nil
    }

    if dbindex >= 0 {
        if _, err := c.Do("SELECT", dbindex); err != nil {
            return nil
        }
    }

    es := &redisEntityStorage{
        c: c,
    }

    return es
}

关于那种办法更好,就差了。希望大家以实际上项目中并非踩坑,即使踩了呢克便捷跨出来!

开源分布式游戏服务器引擎:https://github.com/xiaonanln/goworld,欢迎赏星,共同学习

对Go语言服务端支出感兴趣的冤家欢迎加入QQ讨论群:662182346