以下在的protoBuf文件为例,他会生成一个名为peroson_pb的模块
#file:person.proto
message Person {
required int32 id = 1;
required string name = 2;
optional string email = 3;
extensions 10 to max;
}
message Phone {
extend Person { repeated Phone phones = 10;}
enum PHONE_TYPE{
MOBILE = 1;
HOME = 2;
}
optional string num = 1;
optional PHONE_TYPE type = 2;
}
#endfile:person.proto
1、创建protobuf对象,不管是解析还是组装protobuf对象,都需要先创建一个protobuf对象。当然在LUA中一个对象就是一个table表
local person = person_pb.Person()
2、将protobuf对象转换为字节流,这里主要用来将protobuf对象以流的形式发送到服务器端
local iostring = pb.new_iostring()
person:SerializeToIOString(iostring)
3、将字节流转换为protobuf对象,这里是将服务器端发送的流转换为protbuf对象
local person = person_pb.Person()
person:ParseFromString(iostring)
4、访问protobuf中的对象
1)required类型变量
local id = person.id
2)optional类型变量,这里要注意,如果找不到某个对象,这个变量会是默认值。哪怕是proto协议中没有定义的变量,这里也会返回默认值
if person:HasField("email") ~= nil then #这里就是判断这个值是否在服务器端赋过值
local email = person.email
end
3)repeated类型变量,在LUA中就对应一个table
local phones = phone.phones
local num = #phones
for i = 1, num do
local phone = phones[i]
end
警告:protobuf对象可以访问协议中没有定义的变量,返回值是nil,所以请避免变量名的拼写错误
5、修改protobuf中的变量
person.id = 1
警告:protobuf对象在设置变量时,会对变量的合法性进行检查,如果给协议中没有的变量斌值,这里会产生错误提示
6、遍历protbuf中的变量,这个函数用的比较少
message:ListField()
7、获取某个字段的值,如果没有斌过值,则返回nil,这个函数名与他的实现有些不一致,请小心。其实应该更名为:GetField()比较好
message:HasField()
8、清除指定变量,这个函数用的地方也比较少,主要是一般要使用protobuf对象时都会重新创建一个对象,而这个函数主要用于重复使用同一个对象时。
message:ClearField(field)
9、清除所有字段的值
message:Clear()
10、获取字节数
message:ByteSize()
11、消息之间的拷贝
message:MergeFrom(msg)
12、打印输出protobuf对象,这个在调试时非常管用。他会以字符串的形式打印protobuf对象。注意:没有附过值的optional变量,是不会打印的。
local info = tostring(message)
print(info)