skynet通用模块

skynet官方并没有提供多少游戏相关的解决方案，我造了些轮子，勉强能用吧~

项目结构

项目结构可以参照bewater-sample，或者以第三方库的形式引入你的项目。我们有时候需要同时维护多个新老项目，我把通用部分抽离出来，一方面是为了让旧项目与新代码保持同步，另一方面为了降低新建项目的成本，做到开箱即用。

lualib(lua库)
   bw(一些常用的lua库)
   sys(一些业务相关的系统，可以忽略)
   def(一些定义，在你的项目里把它覆盖）
service(通用服务)
luaclib(编译好的c库)
lualib-src(c库源码)
examples(测试服务)
    etc(启动配置)
    lualib(测试lib)
    service(测试服务)
skynet(fork skynet项目，不作任何改动)
shell(测试启动脚本)

与客户端对接的示例: https://github.com/zhandouxiaojiji/mini-sample

运行测试脚本

./run.sh test #启动进程, run.sh [配置名]

脚本与服务检索优先级

examples>bewater>skynet
这三个目录下都有luaclib,lualib-src,lualib,service这几个目录，skynet的所有代码不作改动，通用的写到bewater
服务的检索分两种，service/?.lua和service/?/init.lua，可以服务写成一个脚本，放在service下，或者写成一个目录，入口文件是init.lua，服务内require优先查找当前目录，参考service/sock/hall

lua库

bw.timer   定时器
bw.lock    协程锁
bw.class   伪类
bw.xml     xml库
bw.bewater 框架相关api
bw.uuid    生成唯一uuid
bw.const   给table添加只读限制
bw.payment 支付宝支付&微信支付&苹果支付
bw.server  一些通用的服务

c库

cjson     json库
codec     集成md5,rsa,base64,aes等编码加解密算法
protobuf  pb库
random    随机库
webclient http库

服务处理call和send的情况

bewater提供bewater.ret这个方法，对skynet.ret进行了一次封装，默认情况下以call处理，以skynet.retpack(...)返回
当处理消息的方法返回的是util.NORET，表示发送方以send的方式发送，本服务不作回应

    local skynet = require "skynet"
    local bewater = require "bw.bewater"
    local CMD = {}
    function CMD.on_send()
        return bewater.NORET
    end
    function CMD.on_call()
        return
    end
    skynet.start(function()
        skynet.dispatch("lua", function(_, _, cmd)
            local f = assert(CMD[cmd], cmd)
            bewater.ret(f(...))
        end)
    end)

协程锁与防重入

服务间通讯通常是用skynet.call或者skynet.send，我们平常用的最多的是call，call有个坑就是当前协程会被挂起，在协程被唤醒前可能同样的代码又被执行了一次。在处理关键业务的时候(比如加经验，货币)需要特别小心重入是否会引发逻辑上的bug。协程锁跟线程锁是差不多原理，在lock的地方挂起等待上一次协程处理完再继续往下执行。

local lock = require "bw.lock"
local l = lock.new()
function test()
    l:lock()
    -- do something
    l:unlock()
end

不过这种锁还是要慎用，容易造成单个服务的消息队列过长。实在没办法比如是客户端不可预知的操作，可以加个锁预防一下。

logger服务

bewater提供syslog服务作为日志服务，运维方可以使用logrotate等工具进行日志管理和维护，当然这只是个备选。

-- etc 启动配置
logservice = "snlua"
logger = "syslog"
APPNAME = "skynet-test"
LOG_SRC = "true"

停机方法

monitor这个服务是用来注册停机事件的，正式服上安全停机需要自行写一个停机的gm指令，然后通知monitor运行停机逻辑。

-- service A
skynet.dispatch("lua", function(_, _, cmd, ...)
    if cmd == "shutdown" then
        -- todo shutdown A
    end
end)
skynet.call(".monitor", "lua", "register", self)

-- gm shutdown
skynet.call(".monitor", "lua", "shutdown")

活动日程

schedule是一个专门负责定时执行的服务，调试方便，特别适合做活动开放的日程

skynet.fork(function()
    while true do
        schedule.submit({mon = 10, day = 1})
        -- todo 国庆活动
        skynet.sleep(100)
    end
end)
schedule.changetime({mon = 9, day = 30, hour = 23, min = 59, sec = 59})

定时器

skynet的timeout本身不支持取消，而且每个timeout都会新建一条协程，但是游戏通常需要用大量的定时器。所以我对根据云风大神建议对skynet的timeout进行了封装，以单向链表的数据结构记录时间和回调。timer库可以创建大量的定时器，销毁也比较方便，最好是在同个虚拟机或者单个玩家的对象只挂一个timer，这样比较省资源，也比较方便管理。后续会参照日程表schedule加入修改系统时间的方法，让调试更加方便。

local timer = require "bw.timer"
local ti = timer.create()
ti.delay(1, function()
    -- todo timeout
end)
ti.delay(5.5, function()
    -- todo timeout
end)
ti.destroy()

代码规范

使用luacheck进行代码质量检查，配置文件.luacheckrc

luacheck --config .luacheck.rc ./

我也写了个简单git钩子tools/pre-commit，将此文件拷到.git/hooks目录下，之后在每次git commit前都会自动luacheck所有修改过的lua脚本，没有报错才能提交。这个钩子适合所有lua项目。

优化与改进计划

最初的思路是设计各种通用的服务，然后暴露一些接口给使用者，这种设计思路其实是错误的。应该把通用的逻辑抽成lua库，让使用者自己制定服务，参照云风写的agent和gateserver二者的关系。后续将逐步消灭service目录下的服务，改成lualib。
带业务逻辑的服务应该写成目录的形式(即service/?/init.lua)，这样可以保证服务内部api的私有性，不用写在lualib跟其它服务的逻辑混淆。
经过多次重构和迭代之后，越来越理解云风为什么把skynet做的这么轻量级了，你的制定条条框框越少，代码的可扩展性和可复用性就越强。bewater也在朝这个方向改进，收集更多的可复用的轮子，而不是写一些难以扩展的所谓通用服务。

关于bewater

Be water My friend 是在我心目中浩气长存的伟大武术家李小龙先生已经解释过啦，如果你想更加了解多点的话，不妨Issue一下。

learno / bewater