Leaf游戏服务器简析(三)之模块Skeleton

Skeleton

Skeleton给Module提供了一个运行骨架.Skeleton实现了ChanRPC(也就是各个模块之间的通信功能).如果一个Module是基于Skeleton实现的,则Skeleton就为这个Module提供了ChanRPC的功能.

// leaf\module\skeleton.go
type Skeleton struct {
    GoLen              int
    TimerDispatcherLen int
    AsynCallLen        int
    ChanRPCServer      *chanrpc.Server
    g                  *g.Go
    dispatcher         *timer.Dispatcher
    client             *chanrpc.Client
    server             *chanrpc.Server
    commandServer      *chanrpc.Server
}

主要关注逻辑
结构体中有两个3个*chanrpc.Server的成员,其中ChanRPCServer和server指向的是相同的chanrpc.Server,ChanRPCServer是对外暴露的成员,而server则是内部隐藏的成员,就是公有和私有的区别,ChanRPCServer只用来读,不提供修改功能,这两个server提供了模块间的ChanRPC机制.
commandServer提供模块与命令行交互的接口

基于Skeleton的Module

以LeafServer中game模块为例

// server\game\internal\module.go
package internal

import (
    "github.com/name5566/leaf/module"
    "server/base"
)

var (
    skeleton = base.NewSkeleton()
    ChanRPC  = skeleton.ChanRPCServer
)

type Module struct {
    *module.Skeleton
}

func (m *Module) OnInit() {
    m.Skeleton = skeleton
}

func (m *Module) OnDestroy() {

}

在程序进入main.go的main()函数之前,该模块的skeleton会通过base.NewSkeleton()被实例化

// server\base\skeleton.go
func NewSkeleton() *module.Skeleton {
    skeleton := &module.Skeleton{
        GoLen:              conf.GoLen,
        TimerDispatcherLen: conf.TimerDispatcherLen,
        AsynCallLen:        conf.AsynCallLen,
        ChanRPCServer:      chanrpc.NewServer(conf.ChanRPCLen),
    }
    skeleton.Init()
    return skeleton
}

之后程序进入main.go的main()函数之后Leaf.Run()的流程中会调用Module的Oninit()以及执行Run()
而在game模块中,OnInit()逻辑其实就是让自己的Module指向我们之前实例化的Skeleton

// server\game\internal\module.go
var (
    skeleton = base.NewSkeleton()
    ChanRPC  = skeleton.ChanRPCServer
)

type Module struct {
    *module.Skeleton
}

func (m *Module) OnInit() {
    m.Skeleton = skeleton
}

所以当调用game.Module.Run()的时候,其实调用的逻辑是Skeleton的Run()函数,这个函数对于模块的意义可以参见Leaf游戏服务器简析(二)之ChanRPC,不做赘述.
由于在Skeleton中实现了Run(),game自己的Module也实现了OnInit()和OnDestroy(),回头看一眼Module的定义

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

所以一个基于Skeleton的Module就这么被创建出来了.