目录
- 核心特性
- 函数原型
- 使用场景
- 场景 1:高性能二进制传输(如文件转发)
- 场景 2:自定义序列化协议(如 Protocol Buffers)
- 场景 3:跨服务共享内存(避免拷贝)
- 配套接收方实现
- 与 skynet.call 的对比
- 注意事项
- 典型错误示例
- 总结
skynet.rawcall
是 Skynet 框架中用于直接传递原始二进制数据的低级通信接口,适用于需要绕过自动序列化/反序列化、手动控制内存或实现高性能传输的场景。以下是其详细用法和典型应用场景:
核心特性
-
非自动序列化:
- 直接传递
lightuserdata
(C 指针)+size
(数据长度),不调用skynet.pack
/skynet.unpack
。 - 适用于已序列化的二进制数据或需要避免序列化开销的场景。
- 直接传递
-
同步调用:
- 与
skynet.call
类似,发送请求后阻塞等待响应。 - 返回值为接收方通过
skynet.ret
返回的原始数据指针(需手动处理)。
- 与
-
内存管理:
- 发送方和接收方需明确内存所有权,避免野指针或内存泄漏。
函数原型
local response_ptr, response_size = skynet.rawcall(target, typename, data_ptr, data_size)
- 参数:
target
:目标服务地址(如skynet.self()
或服务句柄)。typename
:消息类型(字符串,需接收方注册对应的处理协议)。data_ptr
:原始数据指针(lightuserdata
)。data_size
:数据长度(number
)。
- 返回值:
response_ptr
:响应数据的指针(lightuserdata
)。response_size
:响应数据的长度(number
)。
使用场景
场景 1:高性能二进制传输(如文件转发)
-- 发送方(直接传递文件内容指针)
local file_content = read_file_as_binary("data.bin")
local ptr, size = convert_to_lightuserdata(file_content) -- 假设已获得指针和大小
-- 同步调用目标服务,获取响应
local resp_ptr, resp_size = skynet.rawcall(target_service, "binary", ptr, size)
-- 处理响应数据(需手动解析)
process_response(resp_ptr, resp_size)
skynet.free(resp_ptr) -- 手动释放响应内存(若由接收方分配)
场景 2:自定义序列化协议(如 Protocol Buffers)
-- 发送方(使用 Protobuf 编码)
local protobuf = require "protobuf"
local msg = { id = 1001, name = "Alice" }
local encoded_data = protobuf.encode("MyProto", msg)
local ptr, size = get_data_pointer(encoded_data) -- 获取数据指针和长度
-- 发送原始数据并等待响应
local resp_ptr, resp_size = skynet.rawcall(target, "proto", ptr, size)
local decoded_resp = protobuf.decode("ResponseProto", resp_ptr, resp_size)
skynet.free(resp_ptr)
场景 3:跨服务共享内存(避免拷贝)
-- 发送方(传递共享内存指针)
local shared_buf = skynet.malloc(1024) -- 分配共享内存
fill_buffer(shared_buf, 1024) -- 填充数据
-- 请求目标服务处理共享内存
local resp_ptr, resp_size = skynet.rawcall(target, "shared_mem", shared_buf, 1024)
-- 处理完毕后释放内存
skynet.free(shared_buf)
if resp_ptr ~= nil then
skynet.free(resp_ptr)
end
配套接收方实现
接收方需注册对应的协议类型,并手动处理原始数据指针:
-- 接收方服务
skynet.register_protocol {
name = "binary",
id = skynet.PTYPE_USER, -- 自定义类型(如 100)
unpack = function(ptr, size) return ptr, size end, -- 直接透传指针和大小
pack = function(ptr, size) return ptr, size end, -- 响应时不打包
}
skynet.dispatch("binary", function(session, source, ptr, size)
-- 处理原始数据
local result = process_binary_data(ptr, size)
-- 返回响应(假设 result 是已分配的指针和大小)
skynet.ret(result.ptr, result.size)
end)
与 skynet.call 的对比
特性 | skynet.rawcall | skynet.call |
---|---|---|
数据传输 | 原始指针(无序列化) | 自动调用 skynet.pack /unpack |
性能 | 更高(避免序列化开销) | 较低(适合结构化数据) |
内存管理 | 需手动管理指针生命周期 | 框架自动管理 |
适用场景 | 大文件、自定义协议、共享内存 | 常规 RPC、结构化数据交互 |
错误处理 | 需自行处理指针有效性 | 框架自动捕获异常 |
注意事项
-
内存安全:
- 确保传递的指针在接收方使用期间有效。
- 若数据由发送方分配,接收方不应释放;若需返回新数据,接收方应分配新内存。
-
协议一致性:
- 发送方和接收方必须使用相同的协议类型(
typename
)。 - 接收方需正确注册协议处理函数(
skynet.register_protocol
)。
- 发送方和接收方必须使用相同的协议类型(
-
避免野指针:
- 使用
skynet.malloc
和skynet.free
替代原生malloc
/free
,确保内存池统一管理。
- 使用
典型错误示例
-- 错误:传递临时栈指针(可能导致崩溃)
local tmp_data = "Hello"
local ptr = get_pointer(tmp_data)
skynet.rawcall(target, "test", ptr, #tmp_data) -- tmp_data 可能已被回收
-- 正确:分配堆内存并传递
local heap_ptr = skynet.malloc(1024)
fill_data(heap_ptr)
skynet.rawcall(target, "test", heap_ptr, 1024)
skynet.free(heap_ptr) -- 确保接收方不再使用后释放
总结
使用场景优先级:
- 高频二进制传输(如音视频流、日志批量处理)。
- 自定义序列化协议(如 Protobuf、FlatBuffers)。
- 零拷贝共享内存(大规模数据共享,避免复制开销)。
- 与 C 模块交互(直接传递 C 层分配的内存块)。
核心原则:
- 仅在必要时使用
skynet.rawcall
,优先选择更安全的skynet.call
。 - 严格管理内存生命周期,结合
skynet.malloc
/skynet.free
使用。 - 确保发送方和接收方对数据格式和协议类型有明确约定。