【从零开始学Skynet】基础篇（四）：网络模块常用API

news2025/1/19 3:19:01

游戏服务端要处理客户端请求，作为服务端引擎，网络编程也是Skynet的核心功能。

1、学习网络模块

skynet.socket 模块提供了网络编程的 API，常用的API如下表所示：

Lua API	说明
socket.listen(address ,port)	监听一个端口，返回一个 id ，供 start 使用。
socket.start(id , accept)	accept 是一个函数。每当一个监听的 id 对应的 socket 上有连接接入的时候，都会调用 accept 函数。这个函数会得到接入连接的 id 以及 ip 地址。你可以做后续操作。
socket.read(id, sz)	从一个 socket 上读 sz 指定的字节数。如果读到了指定长度的字符串，它把这个字符串返回。如果连接断开导致字节数不够，将返回一个 false 加上读到的字符串。如果 sz 为 nil ，则返回尽可能多的字节数，但至少读一个字节（若无新数据，会阻塞）。
socket.write(id, str)	把一个字符串置入正常的写队列，skynet框架会在 socket 可写时发送它。
socket.close(id)	关闭一个连接，这个 API 有可能阻塞住执行流。因为如果有其它coroutine 正在阻塞读这个id对应的连接，会先驱使读操作结束，close操作才返回。

socket.read中所谓的阻塞模式和 skynet.call一样，都利用了Lua的协程机制。调用socket.read，服务有可能被挂起，直到接收到数据，才会往下执行。

更多API参见：https://github.com/cloudwu/skynet/wiki/Socket

2、功能开发

学完上面的API，我们来写一个Echo程序，Echo程序其实就是一个开启处理客户端消息的服务，它会把收到的内容原封不动地发回给客户端。以下是Echo程序的示意图：

3、代码实现

（1）主服务

本例只需开启一个服务，在skynet/examples目录下创建main_echo.lua文件，输入代码如下所示：

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

function connect(fd, addr)
    --启用连接
    print(fd.." connected addr:"..addr)
    socket.start(fd)
    --消息处理
    while true do
        local readdata = socket.read(fd)
        --正常接收
        if readdata ~= nil then
            print(fd.." recv "..readdata)
            socket.write(fd, readdata)
            --断开连接
        else
            print(fd.." close ")
            socket.close(fd)
        end
    end
end

skynet.start(function()
    local listenfd = socket.listen("0.0.0.0", 8888)
    socket.start(listenfd ,connect)
end)

代码说明：

先引入 skynet 和 skynet.socket 这两个模块；
使用skynet.start启动服务后，依次调用socket.listen和 socket.start 来监听 8888 端口；
新客户端发起连接时， connect 方法将被调用；
在 while 循环里，程序先用socket.read 接收数据，如果收到数据（ if readdata~=nil 的真分

支），则通过 socket.write 将数据发回客户端；如果客户端断开了连接（if readdata~=nil 的假分支），则调用 socket.close 关闭连接；
“0.0.0.0”表示不限制客户端的IP。

（2）配置文件

在skynet/examples目录下创建config_echo文件，也可以拿之前的配置文件修改"start"的值即可，配置参数如下所示：

include "config.path"

thread = 8
logger = nil
logpath = "."
harbor = 0
start = "main_echo"	-- main script
bootstrap = "snlua bootstrap"	-- The service for bootstrap
-- snax_interface_g = "snax_g"
cpath = root.."cservice/?.so"
-- daemon = "./skynet.pid"

4、运行代码

（1）输入如下指令即可运行：

cd skynet
./skynet examples/config_echo

如果开启服务端时提示“ init service failed: ./lualib/skynet/socket.lua:414: Listen error ”，意味着监听端口 8888被占用，可能是多次运行服务端所致，可以执行“ killall skynet ”命令关闭所有的Skynet 进程。

（2）重新打开终端输入命令，显示如下结果，表示运行成功；

（3）此时我们还需要开启一个telnet来作为我们的客户端去连接主服务，我们再打开一个终端输入指令“telnet 127.0.0.1 8888”；

知识拓展： telnet 是 Linux 下的一个程序，可用于调试 TCP 连接。如果尚未安装，可执行“ apt-get install telnet”安装。输入“telnet [ip] [ 端口 ]” 即可向指定服务器发起连接，连接成功后还可以在 telnet 中输入内容，按回车键可将字符串发给服务端。