【Skynet】Sproto初学与应用

最新推荐文章于 2021-09-24 20:25:53 发布
最新推荐文章于 2021-09-24 20:25:53 发布
阅读量3.8k 收藏 7
点赞数
分类专栏： skynet 文章标签： skynet socket lua
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/woxiaohahaa/article/details/78046050
版权

参考自：Skynet基础入门例子详解(5)（魔王魂影）

Sproto是云风专门为Skynet开发的轻量协议。


借鉴官方例子，我们可以在 ./examples/proto.lua 中添加自己的一个 “say” 协议

local sprotoparser = require "sprotoparser"

local proto = {}

proto.c2s = sprotoparser.parse [[
.package {
	type 0 : integer
	session 1 : integer
}

handshake 1 {
	response {
		msg 0  : string
	}
}

get 2 {
	request {
		what 0 : string
	}
	response {
		result 0 : string
	}
}

set 3 {
	request {
		what 0 : string
		value 1 : string
	}
}

quit 4 {}

say 5 {
	request {
		name 0 : string
		msg 1 : string
	}
}

]]

proto.s2c = sprotoparser.parse [[
.package {
	type 0 : integer
	session 1 : integer
}

heartbeat 1 {}
]]

return proto

然后编写自己的客户端 ./examples/client2.lua 

package.cpath = "luaclib/?.so"
package.path = "lualib/?.lua;examples/?.lua"

if _VERSION ~= "Lua 5.3" then
    error "Use lua 5.3"
end

local socket = require "clientsocket"

-- 通信协议
local proto = require "proto"
local sproto = require "sproto"

local host = sproto.new(proto.s2c):host "package"
local request = host:attach(sproto.new(proto.c2s))

local fd = assert(socket.connect("127.0.0.1", 8888))

local session = 0
local function send_request(name, args)
    session = session + 1
    local str = request(name, args, session)

    -- 解包测试
	--[=[
    local host2 = sproto.new(proto.c2s):host "package"
    local req_type, name, arg, func = host2:dispatch(str)
    print(req_type)
	print(name)
	if type(arg) == "table" then
		print(arg.name)
		print(arg.msg)
	end
	print(func)
	--]=]

    socket.send(fd, str)

    print("Request:", session)
end

send_request("handshake")		--此处如果多次发送数据，可能造成收端粘包，致使数据无法正常解析

while true do
    -- 接收服务器返回消息
    local str   = socket.recv(fd)

    -- print(str)
    if str~=nil and str~="" then
            print("server says: "..str)
            -- socket.close(fd)
            -- break;
    end

    -- 读取用户输入消息
    local readstr = socket.readstdin()

    if readstr then
        if readstr == "quit" then
            send_request("quit")
            socket.close(fd)
            break
        else
            -- 把用户输入消息发送给服务器
            send_request("say", { name = "mick", msg = readstr })
        end
    else
        socket.usleep(100)
    end

end



我们知道

local host = sproto.new(proto.s2c):host "package"
local request = host:attach(sproto.new(proto.c2s))
host 和request 分别是一对打包和解包协议，可以在本地检测。发现解包函数返回了四个参数：请求类型，请求名，请求参数，回应函数。其中，请求名和请求参数正好与打包函数里的入参 name 及 args 对应。


最后是服务器 ./examples/socket2.lua

local skynet = require "skynet"
local socket = require "socket"

local proto = require "proto"
local sproto = require "sproto"

local host

local REQUEST = {}

function REQUEST:say()
    print("say", self.name, self.msg)
end

function REQUEST:handshake()
    print("handshake")
end

function REQUEST:quit()
    print("quit")	
end

local function request(name, args, response)
    local f = assert(REQUEST[name])
    local r = f(args)
	do return name end
    if response then
        -- 生成回应包(response是一个用于生成回应包的函数。)
        -- 处理session对应问题
        -- return response(r)
    end
end

local function send_package(fd,pack)
    -- 协议与客户端对应(两字节长度包头+内容)
    local package = string.pack(">s2", pack)
    socket.write(fd, package)
end

local function accept(id)
    -- 每当 accept 函数获得一个新的 socket id 后，并不会立即收到这个 socket 上的数据。这是因为，我们有时会
    -- 希望把这个 socket 的操作权转让给别的服务去处理。
    -- 任何一个服务只有在调用 socket.start(id) 之后，才可以收到这个 socket 上的数据。

    socket.start(id)

    host = sproto.new(proto.c2s):host "package"
    -- request = host:attach(sproto.new(proto.c2s))

    while true do
        local str = socket.read(id)
        if str then
            local type,str2,str3,str4 = host:dispatch(str)

            if type=="REQUEST" then
                -- REQUEST : 第一个返回值为 "REQUEST" 时，表示这是一个远程请求。如果请求包中没有 session 
                -- 字段，表示该请求不需要回应。这时，第 2 和第 3 个返回值分别为消息类型名（即在 sproto 定义
                -- 中提到的某个以 . 开头的类型名），以及消息内容（通常是一个 table ）；如果请求包中有 
                -- session 字段，那么还会有第 4 个返回值：一个用于生成回应包的函数。
                local ok, result  = pcall(request, str2,str3,str4)

				print("ok result", ok, result)
                if ok then
                    if result then
                        socket.write(id, "收到了" .. result)
                        -- 暂时不使用回应包回应
                        -- print("response:"..result)
                        -- send_package(id,result)
                    end
                else
                    skynet.error(result)
                end
            end

			if str2 == "quit" then
				socket.close(id)
				return
			end

            if type=="RESPONSE" then
                -- RESPONSE ：第一个返回值为 "RESPONSE" 时，第 2 和 第 3 个返回值分别为 session 和
                -- 消息内容。消息内容通常是一个 table ，但也可能不存在内容（仅仅是一个回应确认）。
                -- 暂时不处理客户端的回应
                print("client response")
            end         

        else
            socket.close(id)
            return
        end
    end
end

skynet.start(function()
    print("==========Socket Start=========")
    local id = socket.listen("127.0.0.1", 8888)
    print("Listen socket :", "127.0.0.1", 8888)

    socket.start(id , function(id, addr)
            -- 接收到客户端连接或发送消息()
            print("connect from " .. addr .. " " .. id)

            -- 处理接收到的消息
            accept(id)
        end)
end)


最后别忘了在 ./examples/main.lua  中起一个 socket2.lua 服务。


这个例子让我清晰了不少：

1、打包与解包；

2、服务器中，pcall() 函数有两个返回值，第一个返回值应该在程序正常运行完成后返回 true，后面的返回值来自 pcall 调用的函数的返回值。

3、鉴于TCP的流服务，我们在客户端代码中，多次数据的发送过程代码尽量用 readstdin 分离开，否则所有数据可能一同到达服务器，而服务器并没有针对TCP数据流的粘包和拼包处理。这里可以参见 ./examples/client.lua 中的处理。



于是有了下面改进过的服务器代码：

local skynet = require "skynet"
local socket = require "socket"

local proto = require "proto"
local sproto = require "sproto"

local host
local last = ""

local REQUEST = {}

function REQUEST:say()
    print("say", self.name, self.msg)
end

function REQUEST:handshake()
    print("handshake")
end

function REQUEST:quit()
    print("quit")	
end

local function request(name, args, response)
    local f = assert(REQUEST[name])
    local r = f(args)
	do return name end
    if response then
        -- 生成回应包(response是一个用于生成回应包的函数。)
        -- 处理session对应问题
        -- return response(r)
    end
end

local function unpack_package(text)
	local size = #text
	if size < 2 then
		print("size: ", size)
		return nil, text
	end
	local s = text:byte(1) * 256 + text:byte(2)
	if size < s+2 then
		return nil, text
	end

	return text:sub(3,2+s), text:sub(3+s)
end

local function recv_package(last, fd)
	local result
	result, last = unpack_package(last)
	if result then
		return result, last
	end
	local r = socket.read(fd)
	if r then
		return nil, last .. r
	else
		return nil, nil
	end
end

local function accept(id)

    socket.start(id)
	last = ""

    host = sproto.new(proto.c2s):host "package"
    -- request = host:attach(sproto.new(proto.c2s))

    while true do
		local str
		str, last = recv_package(last, id)
		if str then
			local type,str2,str3,str4 = host:dispatch(str)

			if type=="REQUEST" then
				local ok, result  = pcall(request, str2,str3,str4)

				print("ok result", ok, result)
				if ok then
					if result then
						socket.write(id, "收到了" .. result .. '\n')
						-- 暂时不使用回应包回应
						-- print("response:"..result)
						-- send_package(id,result)
					end
				else
					skynet.error(result)
				end
			end

			if str2 == "quit" then
				print("quit!")
				socket.close(id)
				return
			end

			if type=="RESPONSE" then
				-- 暂时不处理客户端的回应
				print("client response")
			end         
		elseif not last then
			print("disconnected!")
			socket.close(id)
			return
		end
    end
end

skynet.start(function()
    print("==========Socket Start=========")
    local id = socket.listen("127.0.0.1", 8888)
    print("Listen socket :", "127.0.0.1", 8888)

    socket.start(id , function(id, addr)
            -- 接收到客户端连接或发送消息()
            print("connect from " .. addr .. " " .. id)

            -- 处理接收到的消息
            accept(id)
        end)
end)


此外，客户端也得修改，需要添加打包代码：

package.cpath = "luaclib/?.so"
package.path = "lualib/?.lua;examples/?.lua"

if _VERSION ~= "Lua 5.3" then
    error "Use lua 5.3"
end

local socket = require "clientsocket"

-- 通信协议
local proto = require "proto"
local sproto = require "sproto"

local host = sproto.new(proto.s2c):host "package"
local request = host:attach(sproto.new(proto.c2s))

local fd = assert(socket.connect("127.0.0.1", 8888))

local function send_package(fd,pack)
    -- 协议与客户端对应(两字节长度包头+内容)
    local package = string.pack(">s2", pack)
    socket.send(fd, package)
end

local session = 0
local function send_request(name, args)
    session = session + 1
    local str = request(name, args, session)
    send_package(fd, str)
    print("Request:", session)
end

send_request("handshake")
send_request("say", { name = "mick", msg = "hello world" })

while true do
    -- 接收服务器返回消息
    local str   = socket.recv(fd)

    -- print(str)
    if str~=nil and str~="" then
            print("server says: "..str)
            -- socket.close(fd)
            -- break;
    end

    -- 读取用户输入消息
    local readstr = socket.readstdin()

    if readstr then
        if readstr == "quit" then
            send_request("quit")
            socket.close(fd)
            break
        else
            -- 把用户输入消息发送给服务器
            send_request("say", { name = "mick", msg = readstr })
        end
    else
        socket.usleep(100)
    end

end

这样就为client ----> server 的传输过程添加了打包解包过程，client端在起始处就可以多次发送 send_request() 而不用担心粘包问题。上面的版本对于 server ---> client 的传输过程并未添加打包解包过程，我们可以进一步仿照上面的版本添加，同时还可以尝试服务器在收到 request 进行回应，由于目前我还不清楚 response() 函数的具体工作内容，但该函数内部进行了打包处理，我们可以尝试用一下。当然，如果是服务端单独发送消息给客户端（如心跳包），这样就需要和客户端一样调用sproto进行封包。（具体可参考examples/agent）



要添加回应，还需修改 sproto，修改如下：

say 5 {
	request {
		name 0 : string
		msg 1 : string
	}
        response {
		name 0 : string
		msg 1 : string
	}
}


这样，就需要在服务器端处理函数中返回一个 response 表格。服务器代码如下： 
local skynet = require "skynet"
local socket = require "socket"

local proto = require "proto"
local sproto = require "sproto"

local host
local last = ""

local REQUEST = {}

function REQUEST:say()
    print("say", self.name, self.msg)
	return {name = "cxl", msg = "hello"}		#对应 response ，即响应。改值会调用 response 打包
end

function REQUEST:handshake()
    print("handshake")
end

function REQUEST:quit()
    print("quit")	
end

local function request(name, args, response)
    local f = assert(REQUEST[name])
    local r = f(args)
    if response and r then
        -- 生成回应包(response是一个用于生成回应包的函数。)
        -- 处理session对应问题
        return response(r)
    end
end

local function unpack_package(text)
	local size = #text
	if size < 2 then
		return nil, text
	end
	local s = text:byte(1) * 256 + text:byte(2)
	if size < s+2 then
		return nil, text
	end

	return text:sub(3,2+s), text:sub(3+s)
end

local function recv_package(last, fd)
	local result
	result, last = unpack_package(last)
	if result then
		return result, last
	end
	local r = socket.read(fd)
	if r then
		return nil, last .. r
	else
		return nil, nil
	end
end

local function send_package(id, pack)
	local package = string.pack(">s2", pack)
	socket.write(id, package) 
end

local function accept(id)

    socket.start(id)
	last = ""

    host = sproto.new(proto.c2s):host "package"
    host2 = sproto.new(proto.s2c):host "package"
    -- request = host:attach(sproto.new(proto.c2s))

    while true do
		local str
		str, last = recv_package(last, id)
		if str then
			local type,str2,str3,str4 = host:dispatch(str)

			if type=="REQUEST" then
				local ok, result  = pcall(request, str2,str3,str4)

				if ok then
					if result then
						send_package(id,result)
					end
				else
					skynet.error(result)
				end
			end

			if str2 == "quit" then
				print("quit!")
				socket.close(id)
				return
			end

			if type=="RESPONSE" then
				-- 暂时不处理客户端的回应
				print("client response")
			end         
		elseif not last then
			print("disconnected!")
			socket.close(id)
			return
		end
    end
end

skynet.start(function()
    print("==========Socket Start=========")
    local id = socket.listen("127.0.0.1", 8888)
    print("Listen socket :", "127.0.0.1", 8888)

    socket.start(id , function(id, addr)
            -- 接收到客户端连接或发送消息()
            print("connect from " .. addr .. " " .. id)

            -- 处理接收到的消息
            accept(id)
        end)
end)


结果如下：


客户端从终端接收输入：



服务器：


可以发现两边的打包解包全都正确，而且服务器对客户端的每次请求都有响应，目前响应都是 {name = "cxl", msg = "hello"}。当初想在服务器端直接对 response 的包用 dispatch() 解包，直接报错。这是因为对于 response 类型的解包，dispatch() 知道是回应，就会知道是自己启动的该次服务，就回去查找对应 session id。但其实，我们属于提前解包，并未在客户端解包，服务器端是没有该 session id的，导致报错。 


mick_seu
关注
  • 0
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
skynet源码分析之sproto使用方法
linuxguitu的博客
01-07 693
A端主动给B端发送请求：调用request_encode对lua表进行编码，再用sproto.pack打包。 B端收到A端的请求：用sproto.unpack解包，再调用request_decode解码成lua表。 B端给A端发送返回包：用response_encode对lua表进行编码，然后用sproto.pack打包。 A端收到B端的返回包：用sproto.unpack解包，再调用request_decode解码成lua表。 不管是是request_encode还是response_encode
【游戏开发实战】教你Unity通过sproto协议与Skynet框架的服务端通信，附工程源码（Unity | Sproto | 协议 | Skynet）
linxinfa的专栏
10-10 7578
【游戏开发实战】教你Unity通过sproto协议与Skynet框架的服务端通信，附工程源码（Unity | Sproto | 协议 | Skynet）
网络层处理，及使用sproto
.
08-01 3579
一开始打算用luasocket这个开源的项目，但是接入进cocos中后，在读到流的长度和服务端下发的一直，但是在解析的时候解不出来，push不进lua的stack中。断点跟过一下代码，还是找不出原因（懒癌发作不想看里面的代码），于是乎就写了个简单网络处理（没有做跨平台处理）。 因为用是云风的 sproto 作为rpc框架，里面支持 lua53 ，对流的处理也有api string.pack 和
sproto
crlyn的博客
09-19 1671
sproto是一套由skynet自身提供的协议,类似google protobuffers,但设计更简单,也更利于lua使用,同时还提供了一套简单的rpc方案. RPC 需要一个消息包的主体格式,它必须有一个叫type的字段,描述RPC到底是哪一条消息,还要有一个session字段来表示回应消息的对应关系,通常这两个字段都被定义成integer. .package { t
Sproto c++
qq_40642108的博客
09-24 410
Sproto c++ ##全篇是我skynet学习的收尾部分，大概搞懂了底层逻辑，标志着对skynet 和 sproto核心有了初步认识；记得《超级战舰》里的一句台词，建立可靠通信是赢得一场战争的基础和关键；这里基于github上一个项目，该项目过老，现将其适配更新后的sproto，用在这自己写的一个网络游戏项目里面，CS通信有了质的飞跃。 sproto 主要逻辑都实现在sproto.c中，开发者云风给需要绑定的使用者设计了callback 和 绑定语言对应的数据结构ud，所以使用者只需设计这两个参数即可。
skynet debug 部署 vscode环境下的debug 断点调试
最新发布
03-11
此文件夹与“skynet”文件夹位于同一层级，这意味着它们可能分别存储了项目的核心代码和调试相关的设置。为了进行调试，我们需要在VSCode中创建一个`.vscode`目录（如果尚未存在），并在其中创建一个名为`launch....
skynet入门实战练习
12-22
skynet 入门实战练习 介绍：项目搭建了客户端和服务端，并采用 websocket 的通信模式，实现了多客户端（client）对应一代理服务（agent），简单易懂的实现设计，快速入门skyent上手开发。 功能：实现了登录...
SkynetMMO：MMO的Skynet实现，UnityMMO的服务器端
02-03
SkynetMMO是一个专为Unity MMO游戏设计的服务器端实现，它基于Skynet框架，结合了lua语言和sproto协议，旨在提供高效、可扩展的游戏服务解决方案。本文将深入探讨SkynetMMO的核心特性、设计原理以及其在MMORPG（大型...
skynet-vs2019.rar
04-07
《Skynet在Windows环境下与Visual Studio 2019的集成及应用》 Skynet，一个轻量级、高并发的分布式系统框架，以其高效、稳定的特点，在游戏服务器开发领域备受青睐。本压缩包“skynet-vs2019.rar”提供的是Skynet在...
skynet_vs2017.zip
07-27
《Skynet在Windows 2017环境下的编译与应用探索》 Skynet，一个轻量级、高性能的分布式系统框架，以其微服务架构和强大的网络通信能力，在游戏服务器开发、物联网(IoT)等领域得到了广泛应用。本资料包"skynet_vs...
sproto-cs:C＃中的Sproto
05-23
警告：代码正确参考，使用前请三思，作者很懒，有issue也不会很快修复的。 原始的 介绍 sproto-cs是用c＃编写的库。 班级 SpType管理器 使用SpTypeManager来管理您的协议和类型。 有两种方法可以从流或从字符串创建SpTypeManager。 using ( FileStream stream = new FileStream (" foobar . sproto ", FileMode . Open )) { SpTypeManager tm = SpTypeManager . Import ( stream ); } 或者 string client_proto = @" .package { type 0 : integer session 1 : integer }
python-sproto:python绑定到sproto
05-30
什么是新的： 20170313 添加定点数支持 添加unicode字符串支持，任何带有declare string的字段都必须是unicode，并且会以utf-8编码发送出去。 如果您自己编码字符串，则使用二进制代替 重要的： sproto_decode api 最近发生了变化，因此您可能需要更改代码以接受 ret 值。 很抱歉给您带来不便。 首先，您需要一个 sproto 编译器来将 sproto 描述编译为二进制描述。 您可以使用离线。 然后就可以使用 sproto 解码和编码接口了。 例子： with open ( 'your.spb' , 'r' ) as fh : content = fh . read () sproto_obj = SprotoRpc ( content , content , base_package ) #base_package
Skynet基础入门例子详解
09-29
本系列文章主要是记录本人在学习过程中遇到的问题，并以最基础的代码引导菜鸟入门。
skynet sproto协议剖析(一)
专注于网络编程,游戏后台,高并发
05-08 3010
前几天领导叫我分析一下skynet的sproto协议,说是要把HTML5项目和现有的skynet项目协议对接起来,意义非常重大,他自己写了开头,没有时间弄了,叫我继续搞.接到指示之后,马不停蹄的查资料,看源代码,连休息的时候也在想着这个事情.经过2,3个完整工作时间(每天饱满8小时以上),终于做出来了,可以把json格式的数据经sproto协议打包之后正确的解包为原json数据了.工作的重点是理解...
Skynet 协议 sproto 协议lua代码阅读，及sproto的使用
zhanglifan_cd的博客
03-31 856
Skynet 协议 sproto 协议lua代码阅读，及sproto的使用 main函数 skynet.newservice(“protoloader”) 服务器, 对服务协议进行加载。 local skynet = require "skynet" local sprotoparser = require "sprotoparser" local sprotoloader = require "sprotoloader" local proto = require "proto" skynet.star
Sproto CSharp集成步骤
iningwei的博客
01-15 1519
云风sproto：https://github.com/cloudwu/sproto 周边工具：https://github.com/cloudwu/sproto/wiki lvzixun的CSharp版本实现：https://github.com/lvzixun/sproto-Csharp 1：proto文件 只支持string,integer,boolen这三种基本类型。具体格式参见云风git...
【Lua杂谈】lua专用rpc协议sproto——基础介绍&用于协议测试的二次开发
HiKariのTechLab
09-12 3535
前言 rpc（远程过程调用），是不同主机间的交互的机制之一。好比说，我们想要获取服务器的某个资源，我们就可以发送一条讯息给服务器，然后服务器解析信息，再返回推送资源的信息，这样，便实现了我们客户端跟服务器的相互的“远程调用”。 为了让不同主机之间能够相互理解发送的讯息，我们需要约定统一的信息格式标准，使得不同的主机可以发送基于这个信息格式的讯息，也可以解析这个格式。这种标准，我们称之为协议（pro...
python-sproto使用实践分享
游戏测试-AJiian的博客
01-24 1046
文章目录前言认识 xxx概念安装xxx正文一、二、1.引入库实践结语 前言 我上篇文章有简单的介绍了sproto协议>>跳转链接，不过不是用sproto原生的打包解包方式，合适用sproto的格式文档的自定义协议，这篇来实践下用原生方式来进行打包解包。 认识 xxx 概念 安装xxx 正文 一、 二、 1.引入库 实践 结语 最后的最后，各位的关注、点赞、收藏、碎银子打赏是对我最大的支持，谢谢大家！ 需要源码的小伙伴关注微信公众号ID：gameTesterGz 或扫描二维码关注回复机器人脚
skynet源码分析之sproto解析和构建 ，让你从繁琐中解脱
linuxguitu的博客
12-30 2821
skynet提供一套与客户端通讯的协议sproto，设计简单，有利于lua使用，参考官方wiki https://github.com/cloudwu/skynet/wiki/Sproto。本篇介绍组装".sproto"文件以及sproto构建流程。之后，会另写一篇介绍sproto的使用方法。 1. 组装.sproto文件流程 以下面简单的test.sproto文件为例介绍.sproto文件组装流程： -- test.sproto .Person { name 0 : string
skynet之使用sproto
06-08
Skynet 在网络通信中使用了 Sproto，一种轻量级的网络数据协议，用于在不同的程序之间传递数据。Sproto 有以下特点： 1. 简单易用，只需要使用少量的 API 就可以完成协议的定义和编解码。 2. 二进制协议，可以大大...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值