Skynet服务端框架搭建3-封装API

Skynet服务端框架搭建3-封装API

搭好框架以后自然是封装API，方便调用服务。

引入

在引入service模块后，只需要一句s.start就能开启服务。服务端收到消息后，service模块会自动调用消息处理函数s.resp.×××。它比原生的API简洁。

图中login1想agentmgr发送名为reqlogin的消息，经过service模块处理，agentmgr中s.resp.reqlogin方法被调用。编写游戏逻辑时，只需要填充s.resp中的方法即可。

定义属性

开始编写service模块了，在lualib下新建service.lua文件

lualib/service.lua

local skynet = require "skynet"
local cluster = require "skynet.cluster"

local M = {
	--类型和id
	name = "",
	id = 0,
	--回调函数
	exit = nil,
	init = nil,
	--分发方法
	resp = {},
}

service模块是对Skynet服务的一种封装，上面name代表服务的类型、id代表服务编号。init和exit是回调的方法，在服务初始化和退出时被调用。resp表会存放着消息处理方法。

启动逻辑

给service模块添加start方法用于开启服务，当外部调用start方法时，它先给name和id赋值，再调用skynet.start开启服务。start方法仅仅是对skynet.start的简易封装。服务启动后Skynet会调用init方法，由它调用skynet.dispatch实现消息路由，在调用上层的M.init()。

lualib/service.lua

function init()
	skynet.dispatch("lua", dispatch)
	if M.init then
		M.init()
	end
end

function M.start(name, id, ...)
	M.name = name
	M.id = tonumber(id)
	skynet.start(init)
end

服务脚本调用s.start①之后，一直到服务脚本init方法被调用⑤，其中服务脚本是服务的Lua代码，封装层代表service模块，skynet代表skynet原生的API

消息分发

下面是消息分发的函数，它会找到resp[cmd]，如果没有，则会调用skynet.ret()，这里定义了处理方法，所以会使用xpcall安全调用，再根据返回值作不同处理。

lualib/service.lua

function traceback(err)
	skynet.error(tostring(err))
	skynet.error(debug.traceback())
end

local dispatch = function(session, address, cmd, ...)
	local fun = M.resp[cmd]
	if not fun then
		skynet.ret()
		return
	end
	
	local ret = table.pack(xpcall(fun, traceback, address, ...))
	local isok = ret[1]
	
	if not isok then
		skynet.ret()
		return
	end

	skynet.retpack(table.unpack(ret,2))
end

一些参数的解释

• address：表示发送方
• cmd：代表消息名的字符串，s.resp.reqlogin和s.resp.reqkick对应的消息名分别是reqlogin和reqkick
• fun：是处理消息的方法，比如s.resp.reqlogin和s.resp.reqkick
• xpcall：安全调用fun方法，如果fun方法报错程序不会中断，而是把错误信息转交给第2个参数traceback。如果程序报错，xpcall会返回false，如果程序正常执行，xpcall返回的第一个值为true，从第2个值开始才是fun的返回值，xpcall会把第3个及后面的参数传给fun
• traceback：作为xpcall的第2个参数，功能是打印出错误提示和堆栈
• ret：xpcall返回值的打包。如果fun方法报错，ret[1]是false，否则为true
• skynet.retpack：fun方法的真正返回值从ret[2]开始，用table.unpack解包并返回

调用过程如图所示

辅助方法

service中还可以封装一些辅助方法，类似于skynet.call和skynet.send

lualib/service.lua

function M.call(node, srv, ...)
	local mynode = skynet.getenv("node")
	if node == mynode then
		return skynet.call(srv, "lua", ...)
	else
		return cluster.call(node, srv, ...)
	end
end

function M.send(node, srv, ...)
	local mynode = skynet.getenv("node")
	if node == mynode then
		return skynet.send(srv, "lua", ...)
	else
		return cluster.send(node, srv, ...)
	end
end

这样后面调用多了也比较省事

编写空服务

gateway/init.lua

local skynet = require "skynet"
local s = require "service"

function s.init()
    skynet.error("[start]"..s.name.." "..s.id)
end

s.start(...)

代码中s.start(…)表示可变参数，在用skynet.newservice启动服务时可以传递参数给它。service模块把第一个参数赋值给s.name，第二个赋给s.id，这里只能打印日志。

再修改一下main.lua，创建一个gateway服务

service/main.lua

local skynet = require "skynet"

skynet.start(function()
    --初始化
    skynet.error("[start main]")
    skynet.newservice("gateway","gateway",1)
    --退出自身
    skynet.exit()
end)

启动测试

可以发现节点先启动主服务main，main启动gateway1，最后main服务调用skynet.exit()退出

[root@feng1 game_demo]# 
[root@feng1 game_demo]# sh start.sh 1
[:00000002] LAUNCH snlua bootstrap
[:00000003] LAUNCH snlua launcher
[:00000004] LAUNCH snlua cdummy
[:00000005] LAUNCH harbor 0 4
[:00000006] LAUNCH snlua datacenterd
[:00000007] LAUNCH snlua service_mgr
[:00000008] LAUNCH snlua main
[:00000008] [start main]
[:00000009] LAUNCH snlua gateway gateway 1
[:0000000a] LAUNCH snlua clusterd
[:00000009] [start]gateway 1
[:00000008] KILL self
[:00000002] KILL self