protocol buffer 简单入门
来源:互联网 发布:友情链接查询源码 编辑:程序博客网 时间:2024/04/28 15:10
目前项目中服务端和客户端传输数据使用的是protocol buffer,这是谷歌公司开发的一款开源数据交换格式,和xml类似,关于pb和xml之间的比较可以上网搜索一下。先说一下,目前,protobuf只支持谷歌的三大语言:c++,java和python。本文使用java解析。
首先是定义proto文件,很类似于C中的struct。为了简便,直接使用我们项目中的几个proto,看Request.proto的定义:
package general.game.message.request;option java_package = "message.request";option java_outer_classname = "Request";enum CommandType{ COMMAND_TYPE_LOGIN = 11; COMMAND_TYPE_REGISTER = 12; COMMAND_TYPE_EXCHANGE_HERO = 13; COMMAND_TYPE_GET_ARMY_AND_TECH = 14; COMMAND_TYPE_UPGRADE_ARMY = 15; COMMAND_TYPE_UPGRADE_ARMY_TECH = 16; COMMAND_TYPE_REQUEST_CITY_LIST = 18; COMMAND_TYPE_UPGRADE_HERO_LEVEL = 19;}message ClientCommand{ optional CommandType commandType = 1; extensions 10 to max;}简单解释一下,前三行的意思是将此proto文件生成java后打包到message.request包中,Request就是生成java文件后的类名。枚举的目地是拓展更多的proto文件,假如message很多,总不能都写在一个Request.proto中吧。message的定义主要就是optional添加需要的项,extensions表明10以后的位置是枚举中列出,用来扩展。我们测试COMMAND_TYPE_UPGRADE_LEVEL这一个。
再看看HeroRequest.proto文件的定义:
package general.game.message.request;option java_package = "message.request";option java_outer_classname = "HeroRequest";import "Request.proto";//军官升级message UpgradeHeroLevelCommand {extend ClientCommand {optional UpgradeHeroLevelCommand upgradeHeroLevelCommand = 19;} required int32 heroId = 1;}
extend是说明这个message对原来ClientCommad这个message扩展的,required是必须字段,位置一添加了一项heroId的属性,如果还需要其他属性,继续这样添加即可(或者使用optional添加可选字段)。
然后需要将proto文件生成java代码,用python写了一简单的脚本自动生成到指定的项目目录中,我自己的pb文件夹内容有,刚刚定义的proto文件在request文件夹里,proto-2.5.0-win32不用我说都知道吧,compile_java.py就是脚本。
#! encoding=utf-8import osimport timedef compile_java(proto_path, name): cmd_java = r'''.\protoc-2.5.0-win32\protoc.exe --java_out=D:\webgame_workspace\TestAction\src --proto_path=%s %s''' % (proto_path, os.path.join(proto_path, name)) os.system(cmd_java) #time.sleep(10) def compile_file(proto_path, name): print 'compile', proto_path, name compile_java(proto_path, name) def compile_dir(proto_path): for name in os.listdir(proto_path): if name.endswith('.proto'): compile_file(proto_path, name) if __name__ == '__main__': compile_dir(r'.\request') compile_dir(r'.\response')java_out就是生成的java代码所在的目录,可以任意修改成自己需要的,但是“=”后前后不能有空格。
用java网络编程实现一个客户端和服务端,客户端代码如下:
package TestAction;import java.io.OutputStream;import java.net.*;import message.request.HeroRequest;import message.request.Request;import message.request.Request.CommandType;public class TestUpgradeHeroLevelAction {public static void main(String[] args) {// TODO Auto-generated method stubtry {Socket socket= new Socket();SocketAddress sa = new InetSocketAddress("127.0.0.1", 8080);socket.connect(sa, 10000);//构造Request类中ClientCommand类的builder(Request.proto文件中定义的ClientCommad message)Request.ClientCommand.Builder requestBuilder = Request.ClientCommand.newBuilder();//设置CommandTyperequestBuilder.setCommandType(CommandType.COMMAND_TYPE_UPGRADE_HERO_LEVEL);//构造HeroRequest类中UpgradeHeroLevelCommand类的builder(HeroRequest.proto文件中定义的UpgradeHeroLevelCommand message)HeroRequest.UpgradeHeroLevelCommand.Builder heroRequestBuilder = HeroRequest.UpgradeHeroLevelCommand.newBuilder();heroRequestBuilder.setHeroId(1);//HeroRequest中的message是拓展了Request.proto,将生成的heroRequestBuilder.build()设置到requestBuilder的拓展方法中去,我们发送的是request请求requestBuilder.setExtension(HeroRequest.UpgradeHeroLevelCommand.upgradeHeroLevelCommand, heroRequestBuilder.build());OutputStream os = socket.getOutputStream();os.write(requestBuilder.build().toByteArray());os.close();socket.close();} catch (Exception e) {e.printStackTrace();}}}
服务端代码如下:
package TestAction;import java.io.InputStream;import java.net.ServerSocket;import java.net.Socket;import com.google.protobuf.ExtensionRegistry;import message.ExtensionFactory;import message.request.HeroRequest;import message.request.Request;public class TestServer {public static void main(String[] args) {try {ServerSocket server = null;try {server = new ServerSocket(8080);} catch (Exception e) {System.out.println("can not listen to" + e);}Socket socket = null;try {socket = server.accept();} catch (Exception e) {e.printStackTrace();}InputStream is = socket.getInputStream();//由于前端传过来的数据含有extension,防止被认为是位置类型,需要提供ExtensionRegistry实例ExtensionRegistry registry = ExtensionRegistry.newInstance(); //Request.registerAllExtensions(registry); HeroRequest.registerAllExtensions(registry); //或者将上面两行代码换成这样 registry.add(HeroRequest.UpgradeHeroLevelCommand.upgradeHeroLevelCommand); //从InputStream流中读取并解析消息 Request.ClientCommand command = Request.ClientCommand.parseFrom(is, registry); //我们发送的是Request消息,要解析出里面拓展的需要Request.ClientCommand 对象的getExtension中获取(通过HreoRequest.proto中定义的message中的optional选项获取) HeroRequest.UpgradeHeroLevelCommand heroRequest = command.getExtension(HeroRequest.UpgradeHeroLevelCommand.upgradeHeroLevelCommand);System.out.println("commandType:" + command.getCommandType());System.out.println("heroId:" + heroRequest.getHeroId());is.close();socket.close();server.close();} catch (Exception e) {e.printStackTrace();}}}
执行的结果:
commandType:COMMAND_TYPE_UPGRADE_HERO_LEVEL
heroId:1
0 0
- protocol buffer 简单入门
- google Protocol Buffer 入门
- Protocol Buffer入门
- Protocol Buffer入门
- Protocol Buffer 入门
- protocol buffer简单使用
- 简单介绍 protocol buffer
- Google Protocol Buffer 入门&案例
- protocol buffer的简单使用
- Google Protocol Buffer (PB)简明入门
- Google Protocol Buffer (PB)简明入门
- Protocol Buffer for Java快速入门
- Google Protocol Buffer (PB)简明入门
- 关于 Protocol Buffer 的简单运用
- protocol buffer
- protocol buffer
- Protocol Buffer
- protocol Buffer
- 『多媒体』流媒体之 工作模型
- Python的内存泄漏及gc模块的使用分析
- Pm685驱动调试笔记
- 如何通过外网访问内网的网站?
- 程序员必读之书
- protocol buffer 简单入门
- jxl在linux环境下报java.lang.ArrayIndexOutOfBoundsException
- Android应用开发中如何使用隐藏API
- destoon实现公司新闻详细页添加评论功能的方法
- win7安装ruby on rails开发环境
- SQL Server2014备份与备份恢复之完全备份(差异备份/日志备份)
- SVN的基础操作
- 数据中心灾备系统的分类
- ios获取各种目录