Leaf游戏服务器简析(一)之模块生命周期

Module(模块)的生命周期

使用leaf开发游戏服务器由多个模块组成,模块的定义如下:

// leaf/module.go
type Module interface{
    OnInit()
    OnDestroy()
    Run(closeSig chan bool)
}

模块需要实现OnInit(),OnDestroy(),Run(closeSig chan bool)三个接口,这三个接口定义了模块生命周期的行为.

以官方项目LeafServer为例说明模块的运行机制

// server/main.go (片段)
// LeafServer程序的入口
func main() {
    // ......
    leaf.Run(
        game.Module,
        gate.Module,
        login.Module,
    )
}

程序入口调用leaf.Run(),在Run函数里面分别注册了game.Module, gate.Module, login.Module,在leaf源码里我们可以看到leaf.Run()的行为:

// leaf/leaf.go
func Run(mods ...module.Module) {
    // ...
    // module
    for i := 0; i < len(mods); i++ {
        module.Register(mods[i])
    }
    module.Init()

    // ...

    // 通过channel c来监听来自操作系统的终止指令
    c := make(chan os.Signal, 1)
    signal.Notify(c, os.Interrupt, os.Kill)
    // 等待终止指令, 一旦读到终止指令则执行之后的代码,module.Destroy()将调用各个模块的OnDestroy()
    sig := <-c

    // ...
    module.Destroy()
}

函数参数mods是我们传进来的各个模块,module.Register(mod)将我们的模块注册到module中去:

// leaf/module.go
var mods []*module
func Register(mi Module) {
    m := new(module)
    m.mi = mi
    m.closeSig = make(chan bool, 1)
    mods = append(mods, m)
}

之后调用module.Init()对我们注册的模块进行初始化,进入OnInit()周期,之后对每个模块开启goroutine来进入各模块的Run()周期:

// leaf/module.go

// 初始化
func Init() {
    for i := 0; i < len(mods); i++ {
        mods[i].mi.OnInit()
    }

    for i := 0; i < len(mods); i++ {
        m := mods[i]
        m.wg.Add(1)
        // 开启goroutine
        go run(m)
    }
}

func run(m *module) {
    m.mi.Run(m.closeSig)
    m.wg.Done()
}

而Module生命周期的结束阶段则在系统读取到终止命令时执行module.Destroy()来进行模块的销毁逻辑:

// leaf/module.go

func Destroy() {
    for i := len(mods) - 1; i >= 0; i-- {
        m := mods[i]
        m.closeSig <- true
        m.wg.Wait()
        destroy(m)
    }
}

func destroy(m *module) {
    defer func() {
        if r := recover(); r != nil {
            if conf.LenStackBuf > 0 {
                buf := make([]byte, conf.LenStackBuf)
                l := runtime.Stack(buf, false)
                log.Error("%v: %s", r, buf[:l])
            } else {
                log.Error("%v", r)
            }
        }
    }()
    m.mi.OnDestroy()
}