欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  移动技术

Protocol Buffer使用转换工具将proto文件转换成Java文件流程及使用

程序员文章站 2022-10-08 21:09:14
Client与Server的网络通信协议传输使用google protobuf,服务器端使用的是Java 一、 Protocol Buffersprotobuf全称Google Protocol Buffers,是google开发的的一套用于数据存储,网络通信时用于协议编解码的工具库。它和XML或者 ......

client与server的网络通信协议传输使用google protobuf,服务器端使用的是java

一、 protocol buffers
protobuf全称google protocol buffers,是google开发的的一套用于数据存储,网络通信时用于协议编解码的工具库。它和xml或者json差不多,也就是把某种数据结构的信息,以某种格式(xml,json)保存起来,protobuf与xml和json不同在于,protobuf是基于二进制的。主要用于数据存储、传输协议格式等场合。那既然有了xml等工具,为什么还要开发protobuf呢?主要是因为性能,包括时间开销和空间开销:

1.时间开销:xml格式化(序列化)和xml解析(反序列化)的时间开销是很大的,在很多时间性能上要求很高的场合,你能做的就是看着xml干瞪眼了。

2.空间开销:熟悉xml语法的同学应该知道,xml格式为了有较好的可读性,引入了一些冗余的文本信息。所以空间开销也不是太好(应该说是很差,通常需要实际内容好几倍的空间)。

二、服务器端生成的proto文件转换成java文件

示例:proto文件

syntax = "proto3";

option java_package = "com.showly.app.chat.proto";//生成java文件后的存放路径
option java_outer_classname = "chatserverproto";


// 聊天内容类型
enum contenttype {
    normal = 0;         // 普通文本聊天
    anonymous = 1;         // 匿名文本聊天(输入框旁边有个勾选)
}


// 性别
enum gendertype {
    secret = 0;             // 保密
    male = 1;                // 男
    female = 2;                // 女

}


// 用户信息
message userinfo {
    int32 uid = 1;
    string headpic = 2;
    gendertype gender = 3;
    bool vip = 4; //vip
    int32 level = 5; //等级
    string nickname = 6; //昵称
}



// 响应消息的一个头. 每个消息都会带上.
message responseheader {
    int32  status = 1;            // 状态 非0 为失败
    string  msg = 2;             // 状态描述
}


// 聊天使用的消息体对象
message chatinfo {
    userinfo info = 1;             // 用户信息
    string location = 2;             // 用户的位置. 
    contenttype type = 3;             // 消息类型
    bytes content = 4;             // 消息内容
    int64 dt = 5;                 // 时间戳
}


// cmdid = 1000(客户端传输到服务器端的请求id)
message loginrequest {
    int32 uid = 1;             //uid
    string token = 2;        // token
}

// cmdid = 1000000(客户端获取服务器端响应id)
message loginresponse {
    responseheader header = 1;
    repeated chatinfo chats = 2;            // 10条历史记录
    bool roomreconn = 3;                 // 房间重连
}


// cmdid = 1001 切换城市 世界为 "world"
message changecityrequest {
    string  city = 1;                  // city code
}


// cmdid = 1000001
message changecityresponse {
    responseheader header = 1;
    repeated chatinfo chats = 2;// 10条历史记录
}


enum locationtype {
    world = 0;//世界信息
    redbagroom = 1; //红包活动房间
}


// cmdid = 1002
message sendchatmsgrequest {
    string location = 1;        //位置
    contenttype type = 2;         // 消息类型
    bytes content = 3;             // 消息内容. 以后可能图片什么. 我这里不写死. 客户端给我字节数组.
    locationtype locationtype = 4 ;// 消息位置
}

// cmdid = 1000002  推送的聊天信息广播协议
message chatinfobroadcastresponse {
    responseheader header = 1;     
    chatinfo chat = 2;         // 广播的内容
    locationtype locationtype = 3 ;// 消息位置
} 

// cmdid = 1003 心跳. 不需要发送东西. 告诉服务器还活着
message heartrequest {

}

// 这里仅服务端使用这个, 客户端按照下行的id 解析即可.
message defaultheaderresponse {
    responseheader header = 1;         // 头
}

转换流程:
1、这时需要protoc转换工具(公众号回复"protocbuf转换工具")

2、将proto文件放到工具相应的目录(如图)

Protocol Buffer使用转换工具将proto文件转换成Java文件流程及使用

3、使用如图命令行进行转换

Protocol Buffer使用转换工具将proto文件转换成Java文件流程及使用

转换后的java文件为chatserverproto(生成的文件代码太长,这里不放出来了)

三、protocol buffer使用

以使用netty网络编程框架protocol buffer传输为例:

netty登录请求(此协议为客户端与服务端双方规定好的协议)
// cmdid = 1000
message loginrequest {
    int32 uid = 1;             //uid
    string token = 2;        // token
}

项目代码中使用:

chatserverproto.loginrequest loginrequest = chatserverproto.loginrequest
                .newbuilder()
                .setuid(integer.parseint(i8showsharepre.gethomeid(getactivity())))
                .settoken(i8showsharepre.gettoken(getactivity()))
                .build();

        messagecontent messagecontent = new messagecontent(1000, loginrequest.tobytearray());
        //nettychatclient为netty对象
        nettychatclient.sendmessage(messagecontent);

以下是个人公众号(longxuanzhigu),之后发布的文章会同步到该公众号,方便交流学习android知识及分享个人爱好文章:

Protocol Buffer使用转换工具将proto文件转换成Java文件流程及使用