该篇Blog和上一篇(C++实例)基本相同,只是面向于我们团队中的Java工程师,毕竟我们项目的前端部分是基于Android开发的,而且我们研发团队中目前主要使用的开发语言就是C++、Java和Python,其中Python主要用于编写各种工具程序。然而为了保证该篇Blog的完整性和独立性,我仍然会将上一篇Blog中已经出现的内容再一次赘述,同时对于Java中特有的部分也会着重介绍。
一、生成目标语言代码。
下面的命令帮助我们将MyMessage.proto文件中定义的一组Protocol Buffer格式的消息编译成目标语言(Java)的代码。至于消息的内容,我们会在后面以分段的形式逐一列出,同时也会在附件中给出所有源代码。
protoc -I=./message --java_out=./src ./MyMessage.proto
从上面的命令行参数中可以看出,待编译的文件为MyMessage.proto,他存放在当前目录的message子目录下。--java_out参数则指示编译工具我们需要生成目标语言是java,输出目录是当前目录的src子目录。这里需要补充说明的是,因为在MyMessage.proto文件中定义了option java_package = "com.lsk.lyphone"的文件级选项,所以输出的目前是src/com/lsk/lyphone,生成的目标代码文件名是MyMessage.java。
二、简单message生成的Java代码。
这里先定义一个最简单的message,其中只是包含原始类型的字段。
option java_package = "com.lsk.lyphone";
option java_outer_classname = "LYPhoneMessage";
option optimize_for = LITE_RUNTIME;
message LogonReqMessage {
required int64 acctID = 1;
required string passwd = 2;
}
对于选项java_package和java_outer_classname的功能,我们已经在之前的一篇Blog(语言规范)中进行了清晰的阐述,这里就不在另行介绍了。然而对于选项optimize_for,这里将结合本例给出一些实用性描述。
当前.proto文件中该选项的值为LITE_RUNTIME,因此由该.proto文件生成的所有Java类的父类均为com.google.protobuf.GeneratedMessageLite,而非com.google.protobuf.GeneratedMessage,同时与之对应的Builder类则均继承自com.google.protobuf.MessageLiteOrBuilder,而非com.google.protobuf.MessageOrBuilder。在之前的博客中已经给出了一些简要的说明,MessageLite接口是Message的父接口,在MessageLite中将缺少Protocol Buffer对反射的支持,而此功能均在Message接口中提供了接口规范,同时又在其实现类GeneratedMessage中给予了最小功能的实现。对于我们的项目而言,整个系统相对比较封闭,不会和更多的外部程序进行交互,与此同时,我们的客户端部分又是运行在Android平台,有鉴于此,我们考虑使用LITE版本的Protocol Buffer。这样不仅可以得到更高编码效率,而且生成代码编译后所占用的资源也会更少,至于反射所能带来的灵活性和极易扩展性,对于该项目而言完全可以忽略。下面我们来看一下由message LogonReqMessage生成的Java类的部分声明,以及常用方法的说明性注释。
在上面生成的代码中并没有列出与序列化相关的函数,这部分代码基本都是在父类中实现的,我们将在下面的例子中给出一些最基本的用法,有兴趣的开发者可以直接看Protocol Buffer中的源码,这部分代码比较通俗易懂。
下面是读写LogonReqMessage对象的Java测试代码和说明性注释。
三、嵌套message生成的Java代码。
enum UserStatus {
OFFLINE = 0;
ONLINE = 1;
}
enum LoginResult {
LOGON_RESULT_SUCCESS = 0;
LOGON_RESULT_NOTEXIST = 1;
LOGON_RESULT_ERROR_PASSWD = 2;
LOGON_RESULT_ALREADY_LOGON = 3;
LOGON_RESULT_SERVER_ERROR = 4;
}
message UserInfo {
required int64 acctID = 1;
required string name = 2;
required UserStatus status = 3;
}
message LogonRespMessage {
required LoginResult logonResult = 1;
required UserInfo userInfo = 2; //这里嵌套了UserInfo消息。
}
对于上述消息生成的Java代码,UserInfo因为只是包含了原始类型字段,因此和上例中的LogonReqMessage没有太多的差别,这里也就不在重复列出了。由于LogonRespMessage消息中嵌套了UserInfo类型的字段,在这里我们将仅仅给出该消息生成的Java代码和关键性注释。
下面是读写LogonRespMessage对象的Java测试代码和说明性注释。
四、repeated嵌套message生成的Java代码。
message BuddyInfo {
required UserInfo userInfo = 1;
required int32 groupID = 2;
}
message RetrieveBuddiesResp {
required int32 buddiesCnt = 1;
repeated BuddyInfo buddiesInfo = 2;
}
对于上述消息生成的代码,我们将只是针对RetrieveBuddiesResp消息所对应的Java代码进行详细说明,其余部分和前面小节的例子基本相同,可直接参照。而对于RetrieveBuddiesResp类中的代码,我们也仅仅是对buddiesInfo字段生成的代码进行更为详细的解释。
下面是读写RetrieveBuddiesResp对象的Java测试代码和说明性注释。
对于Java而言,我们可以通过Maven工具生成两个jar包,其中一个是protobuf-java-2.4.1.jar,主要用于optimize_for选项为非LITE_RUNTIME的情况,而另一个protobuf-java-2.4.1-lite.jar文件则恰恰与之相反。另外,我通过Beyond Compare工具对这两个jar包进行了二进制比较后发现,他们是完全相同的。这里之所以仍以LITE版本为例,主要还是因为和之前一篇Blog(C++实例)想匹配。
最后需要说明的是,Protocol Buffer仍然提供了很多其它非常有用的功能,特别是针对序列化的目的地,比如文件流和网络流等。与此同时,也提供了完整的官方文档和规范的命名规则,在很多情况下,可以直接通过函数的名字便可获悉函数所完成的工作。
该Blog中使用的示例代码均已附件的方式上传,欢迎大家下载并指正。
一、生成目标语言代码。
下面的命令帮助我们将MyMessage.proto文件中定义的一组Protocol Buffer格式的消息编译成目标语言(Java)的代码。至于消息的内容,我们会在后面以分段的形式逐一列出,同时也会在附件中给出所有源代码。
protoc -I=./message --java_out=./src ./MyMessage.proto
从上面的命令行参数中可以看出,待编译的文件为MyMessage.proto,他存放在当前目录的message子目录下。--java_out参数则指示编译工具我们需要生成目标语言是java,输出目录是当前目录的src子目录。这里需要补充说明的是,因为在MyMessage.proto文件中定义了option java_package = "com.lsk.lyphone"的文件级选项,所以输出的目前是src/com/lsk/lyphone,生成的目标代码文件名是MyMessage.java。
二、简单message生成的Java代码。
这里先定义一个最简单的message,其中只是包含原始类型的字段。
option java_package = "com.lsk.lyphone";
option java_outer_classname = "LYPhoneMessage";
option optimize_for = LITE_RUNTIME;
message LogonReqMessage {
required int64 acctID = 1;
required string passwd = 2;
}
对于选项java_package和java_outer_classname的功能,我们已经在之前的一篇Blog(语言规范)中进行了清晰的阐述,这里就不在另行介绍了。然而对于选项optimize_for,这里将结合本例给出一些实用性描述。
当前.proto文件中该选项的值为LITE_RUNTIME,因此由该.proto文件生成的所有Java类的父类均为com.google.protobuf.GeneratedMessageLite,而非com.google.protobuf.GeneratedMessage,同时与之对应的Builder类则均继承自com.google.protobuf.MessageLiteOrBuilder,而非com.google.protobuf.MessageOrBuilder。在之前的博客中已经给出了一些简要的说明,MessageLite接口是Message的父接口,在MessageLite中将缺少Protocol Buffer对反射的支持,而此功能均在Message接口中提供了接口规范,同时又在其实现类GeneratedMessage中给予了最小功能的实现。对于我们的项目而言,整个系统相对比较封闭,不会和更多的外部程序进行交互,与此同时,我们的客户端部分又是运行在Android平台,有鉴于此,我们考虑使用LITE版本的Protocol Buffer。这样不仅可以得到更高编码效率,而且生成代码编译后所占用的资源也会更少,至于反射所能带来的灵活性和极易扩展性,对于该项目而言完全可以忽略。下面我们来看一下由message LogonReqMessage生成的Java类的部分声明,以及常用方法的说明性注释。
在做各种case的对比性分析之前必须要事先声明的是,Protocol Buffer针对Java语言所生成的代码和C++相比存在一个非常重要的差别,即为每个消息均会生成一个Builder接口和一个与消息对应的实现类,该实现类又将同时实现生成的Builder接口和扩展Protocol Buffer内置的GeneratedMessageLite(或GeneratedMessage)类。这一点对于Protocol Buffer而言,是巧妙的使用了设计模式中的Builder模式。换言之,对于所有消息字段的修改操作均需要通过与其对应的Builder接口辅助完成。相信我们会通过对下面用例的学习可以得到更为清楚的认识。
//用于修改LogonReqMessage消息字段的辅助Builder接口。
//该接口会为消息中的每个字段均提供getter和setter方法。
public interface LogonReqMessageOrBuilder
extends com.google.protobuf.MessageLiteOrBuilder {
// required int64 acctID = 1;
boolean hasAcctID();
long getAcctID();
// required string passwd = 2;
boolean hasPasswd();
String getPasswd();
}
//该类为final类,即不可以在被子类化了。这一点在Protocol Buffer的官方文档中给予了明确
//的说明,因为子类化将会破坏序列化和反序列化的过程。
public static final class LogonReqMessage extends
com.google.protobuf.GeneratedMessageLite
implements LogonReqMessageOrBuilder {
// Use LogonReqMessage.newBuilder() to construct.
// 由于所有构造函数均为私有方法,由此可见,我们不能直接new LogonReqMessage的对象
// 实例,而是只能通过与其对应Builder来构造,或是直接通过反序列化的方式生成。
private LogonReqMessage(Builder builder) {
super(builder);
}
//该静态方法为该类Builder接口的工厂方法。返回的Builder实现类在完成各个字段的
//初始化后,通过build()方法返回与其对应的消息实现类,即LogonReqMessage。
public static Builder newBuilder() { return Builder.create(); }
//通过该类的对象获取与其对应的Builder类对象,一般用于通过Builder类完成消息字段的修改。
public Builder toBuilder() { return newBuilder(this); }
private LogonReqMessage(boolean noInit) {}
//判断当前对象的所有字段是否都已经被初始化。
public final boolean isInitialized() {
... ...
}
//获取已经被初始化后的对象序列化时所占用的字节空间。
public int getSerializedSize() {
... ...
}
//从内存中饭序列化LogonReqMessage对象。
//Protocol Buffer中还提供其他一些接口方法,用于从不同的数据源反序列化对象。
public static com.lsk.lyphone.LYPhoneMessage.LogonReqMessage parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return newBuilder().mergeFrom(data).buildParsed();
}
//功能和上一个函数相同,只是输入源改为InputStream接口。
public static com.lsk.lyphone.LYPhoneMessage.LogonReqMessage parseFrom(java.io.InputStream input)
throws java.io.IOException {
return newBuilder().mergeFrom(input).buildParsed();
}
// required int64 acctID = 1;
// 下面的静态变量对应于该字段在.proto中定义的标签号。该变量的命名规则为:字段(全部大写) + _FIELD_NUMBER。
public static final int ACCTID_FIELD_NUMBER = 1;
public boolean hasAcctID() {
return ((bitField0_ & 0x00000001) == 0x00000001);
}
public long getAcctID() {
return acctID_;
}
// required string passwd = 2;
public static final int PASSWD_FIELD_NUMBER = 2;
public boolean hasPasswd() {
return ((bitField0_ & 0x00000002) == 0x00000002);
}
public String getPasswd() {
... ...
}
//每一个Message类都会包含一个静态内部类,即与之对应的Builder类。上面代码中所涉及的Builder类均为该内部类。
public static final class Builder extends
com.google.protobuf.GeneratedMessageLite.Builder<
com.lsk.lyphone.LYPhoneMessage.LogonReqMessage, Builder>
implements com.lsk.lyphone.LYPhoneMessage.LogonReqMessageOrBuilder {
//清空当前对象中的所有设置。调用该函数之后,本例中的hasAcctID和hasPasswd都会返回false。
public Builder clear() {
super.clear();
acctID_ = 0L;
bitField0_ = (bitField0_ & ~0x00000001);
passwd_ = "";
bitField0_ = (bitField0_ & ~0x00000002);
return this;
}
//克隆出一个Builder对象。
public Builder clone() {
return create().mergeFrom(buildPartial());
}
public com.lsk.lyphone.LYPhoneMessage.LogonReqMessage build() {
com.lsk.lyphone.LYPhoneMessage.LogonReqMessage result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
// Builder类中修改外部消息类的方法。
// required int64 acctID = 1;
public boolean hasAcctID() {
return ((bitField0_ & 0x00000001) == 0x00000001);
}
public long getAcctID() {
return acctID_;
}
//设置AcctID字段,该函数调用后hasAcctID函数将返回true。
//这里之所以让返回值为Builder对象,就是可以让调用者在一条代码中方便的连续修改多个字段,
//如:myMessage.setAcctID(100).setPasswd("MyName");
public Builder setAcctID(long value) {
bitField0_ |= 0x00000001;
acctID_ = value;
return this;
}
//清空AcctID字段,该函数调用后hasAcctID函数返回false。
//这里之所以让返回值为Builder对象,就是可以让调用者在一条代码中方便的连续清空多个字段,
//如:myMessage.clearAcctID().clearPasswd();
public Builder clearAcctID() {
bitField0_ = (bitField0_ & ~0x00000001);
acctID_ = 0L;
return this;
}
// required string passwd = 2;
public boolean hasPasswd() {
return ((bitField0_ & 0x00000002) == 0x00000002);
}
public String getPasswd() {
... ...
}
public Builder setPasswd(String value) {
... ...
}
public Builder clearPasswd() {
bitField0_ = (bitField0_ & ~0x00000002);
passwd_ = getDefaultInstance().getPasswd();
return this;
}
void setPasswd(com.google.protobuf.ByteString value) {
bitField0_ |= 0x00000002;
passwd_ = value;
}
}
}
在上面生成的代码中并没有列出与序列化相关的函数,这部分代码基本都是在父类中实现的,我们将在下面的例子中给出一些最基本的用法,有兴趣的开发者可以直接看Protocol Buffer中的源码,这部分代码比较通俗易懂。
下面是读写LogonReqMessage对象的Java测试代码和说明性注释。
private static void testSimpleMessage() {
System.out.println("==================This is simple message.================");
//如前所述,不能直接构造该消息类对象,只能通过他的内部Builder类构造并完成所有字段的初始化。
LogonReqMessage.Builder logonReqBuilder = LogonReqMessage.newBuilder();
logonReqBuilder.setAcctID(20);
logonReqBuilder.setPasswd("Hello World");
//builder对象初始化完毕后,再通过build方法生成与之对应的消息类对象。
LogonReqMessage logonReq = logonReqBuilder.build();
int length = logonReq.getSerializedSize();
System.out.println("The result length is " + length);
//直接序列化到内存中,之后可对该内存进行二次加工后再写到本地文件或发送到远端,如加密。
byte[] buf = logonReq.toByteArray();
try {
LogonReqMessage logonReq2 = LogonReqMessage.parseFrom(buf);
System.out.println("acctID = " + logonReq2.getAcctID() + "\tpassword = " + logonReq2.getPasswd());
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
//需要说明的是,文件中的内容是由之前C++实例代码写入的,这里这样写主要是一种验证。
System.out.println("Reading data from local file generated by C++");
try {
LogonReqMessage logonReq3 = LogonReqMessage.parseFrom(new FileInputStream("C:/Mine/LogonReq.dat"));
System.out.println("acctID = " + logonReq3.getAcctID() + "\tpassword = " + logonReq3.getPasswd());
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
三、嵌套message生成的Java代码。
enum UserStatus {
OFFLINE = 0;
ONLINE = 1;
}
enum LoginResult {
LOGON_RESULT_SUCCESS = 0;
LOGON_RESULT_NOTEXIST = 1;
LOGON_RESULT_ERROR_PASSWD = 2;
LOGON_RESULT_ALREADY_LOGON = 3;
LOGON_RESULT_SERVER_ERROR = 4;
}
message UserInfo {
required int64 acctID = 1;
required string name = 2;
required UserStatus status = 3;
}
message LogonRespMessage {
required LoginResult logonResult = 1;
required UserInfo userInfo = 2; //这里嵌套了UserInfo消息。
}
对于上述消息生成的Java代码,UserInfo因为只是包含了原始类型字段,因此和上例中的LogonReqMessage没有太多的差别,这里也就不在重复列出了。由于LogonRespMessage消息中嵌套了UserInfo类型的字段,在这里我们将仅仅给出该消息生成的Java代码和关键性注释。
public static final class LogonRespMessage extends
com.google.protobuf.GeneratedMessageLite
implements LogonRespMessageOrBuilder {
//Message类的通用性函数定义。
... ...
// required .LoginResult logonResult = 1;
public static final int LOGONRESULT_FIELD_NUMBER = 1;
public boolean hasLogonResult() {
return ((bitField0_ & 0x00000001) == 0x00000001);
}
public com.lsk.lyphone.LYPhoneMessage.LoginResult getLogonResult() {
return logonResult_;
}
// required .UserInfo userInfo = 2;
public static final int USERINFO_FIELD_NUMBER = 2;
public boolean hasUserInfo() {
return ((bitField0_ & 0x00000002) == 0x00000002);
}
public com.lsk.lyphone.LYPhoneMessage.UserInfo getUserInfo() {
return userInfo_;
}
//Message类的通用性函数定义。可参照上一小节中的代码和注释。
... ...
public static final class Builder extends
com.google.protobuf.GeneratedMessageLite.Builder<
com.lsk.lyphone.LYPhoneMessage.LogonRespMessage, Builder>
implements com.lsk.lyphone.LYPhoneMessage.LogonRespMessageOrBuilder {
//一些适用于绝大多数Builder对象的通用性方法。
... ...
//当前示例中Builder生成的代码和上一小节中生成的代码非常类似,这里就不一一赘述了。
//和前面的例子相比一个重要的差别是setUserInfo函数多提供了一种函数签名,其参数为
//UserInfo类的Builder对象。这样调用者在使用时可以直接将Builder对象作为参数传入。
public Builder setUserInfo(com.lsk.lyphone.LYPhoneMessage.UserInfo.Builder builderForValue) {
userInfo_ = builderForValue.build();
bitField0_ |= 0x00000002;
return this;
}
}
}
下面是读写LogonRespMessage对象的Java测试代码和说明性注释。
private static void testNestedMessage() {
System.out.println("==================This is nested message.================");
LogonRespMessage.Builder logonRespBuilder = LogonRespMessage.newBuilder();
logonRespBuilder.setLogonResult(LoginResult.LOGON_RESULT_SUCCESS);
UserInfo.Builder userInfo = UserInfo.newBuilder();
userInfo.setAcctID(200);
userInfo.setName("Tester");
userInfo.setStatus(UserStatus.OFFLINE);
//这里也可以直接传递userInfo对象作为参数。因为LogonRespBuilder类提供了setUserInfo的方法重载。
logonRespBuilder.setUserInfo(userInfo.build());
LogonRespMessage logonResp = logonRespBuilder.build();
int length = logonResp.getSerializedSize();
System.out.println("The result length is " + length);
byte[] buf = logonResp.toByteArray();
try {
LogonRespMessage logonResp2 = LogonRespMessage.parseFrom(buf);
UserInfo userInfo2 = logonResp2.getUserInfo();
System.out.println("LogonResult = " + logonResp2.getLogonResult().toString() + " acctID = "
+ userInfo2.getAcctID() + " name = " + userInfo2.getName() + " status = " + userInfo2.getStatus().toString());
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
System.out.println("Reading data from local file generated by C++");
try {
LogonRespMessage logonResp3 = LogonRespMessage.parseFrom(new FileInputStream("C:/Mine/LogonResp.dat"));
UserInfo userInfo3 = logonResp3.getUserInfo();
System.out.println("LogonResult = " + logonResp3.getLogonResult().toString() + " acctID = "
+ userInfo3.getAcctID() + " name = " + userInfo3.getName() + " status = " + userInfo3.getStatus().toString());
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
四、repeated嵌套message生成的Java代码。
message BuddyInfo {
required UserInfo userInfo = 1;
required int32 groupID = 2;
}
message RetrieveBuddiesResp {
required int32 buddiesCnt = 1;
repeated BuddyInfo buddiesInfo = 2;
}
对于上述消息生成的代码,我们将只是针对RetrieveBuddiesResp消息所对应的Java代码进行详细说明,其余部分和前面小节的例子基本相同,可直接参照。而对于RetrieveBuddiesResp类中的代码,我们也仅仅是对buddiesInfo字段生成的代码进行更为详细的解释。
public static final class RetrieveBuddiesResp extends
com.google.protobuf.GeneratedMessageLite
implements RetrieveBuddiesRespOrBuilder {
//这里均为Protocol Buffer生成的通用性代码。
... ...
// repeated .BuddyInfo buddiesInfo = 2;
public static final int BUDDIESINFO_FIELD_NUMBER = 2;
//对于repeated类型的字段,均返回类型参数为字段类型的泛型容器对象。
public java.util.List<com.lsk.lyphone.LYPhoneMessage.BuddyInfo> getBuddiesInfoList() {
return buddiesInfo_;
}
public java.util.List<? extends com.lsk.lyphone.LYPhoneMessage.BuddyInfoOrBuilder> getBuddiesInfoOrBuilderList() {
return buddiesInfo_;
}
public int getBuddiesInfoCount() {
return buddiesInfo_.size();
}
public com.lsk.lyphone.LYPhoneMessage.BuddyInfo getBuddiesInfo(int index) {
return buddiesInfo_.get(index);
}
public com.lsk.lyphone.LYPhoneMessage.BuddyInfoOrBuilder getBuddiesInfoOrBuilder(int index) {
return buddiesInfo_.get(index);
}
//这里仍有一些Protocol Buffer生成的通用性代码。
... ...
public static final class Builder extends
com.google.protobuf.GeneratedMessageLite.Builder<
com.lsk.lyphone.LYPhoneMessage.RetrieveBuddiesResp, Builder>
implements com.lsk.lyphone.LYPhoneMessage.RetrieveBuddiesRespOrBuilder {
//这里仅列出和操作repeated字段相关的方法,其他的方法和前面的例子基本一致。
// repeated .BuddyInfo buddiesInfo = 2;
//本来打算给出比较详细的说明,但是看到Google为每个函数的命名之后就放弃这个想法,
//这样一来不仅可以避免画蛇添足,而且也节省了时间。:)
public java.util.List<com.lsk.lyphone.LYPhoneMessage.BuddyInfo> getBuddiesInfoList() {
return java.util.Collections.unmodifiableList(buddiesInfo_);
}
public int getBuddiesInfoCount() {
return buddiesInfo_.size();
}
public com.lsk.lyphone.LYPhoneMessage.BuddyInfo getBuddiesInfo(int index) {
return buddiesInfo_.get(index);
}
public Builder setBuddiesInfo(int index, com.lsk.lyphone.LYPhoneMessage.BuddyInfo value) {
... ...
}
public Builder setBuddiesInfo(int index, com.lsk.lyphone.LYPhoneMessage.BuddyInfo.Builder builderForValue) {
... ...
}
public Builder addBuddiesInfo(com.lsk.lyphone.LYPhoneMessage.BuddyInfo value) {
... ...
}
public Builder addBuddiesInfo(int index, com.lsk.lyphone.LYPhoneMessage.BuddyInfo value) {
... ...
}
public Builder addBuddiesInfo(com.lsk.lyphone.LYPhoneMessage.BuddyInfo.Builder builderForValue) {
... ...
}
public Builder addBuddiesInfo(
int index, com.lsk.lyphone.LYPhoneMessage.BuddyInfo.Builder builderForValue) {
... ...
}
public Builder addAllBuddiesInfo(
java.lang.Iterable<? extends com.lsk.lyphone.LYPhoneMessage.BuddyInfo> values) {
... ...
}
public Builder clearBuddiesInfo() {
... ...
}
public Builder removeBuddiesInfo(int index) {
... ...
}
}
}
下面是读写RetrieveBuddiesResp对象的Java测试代码和说明性注释。
private static void testRepeatedMessage() {
System.out.println("==================This is repeated message.================");
RetrieveBuddiesResp.Builder retrieveBuddiesBuilder = RetrieveBuddiesResp.newBuilder();
retrieveBuddiesBuilder.setBuddiesCnt(2);
BuddyInfo.Builder buddyInfoBuilder = BuddyInfo.newBuilder();
buddyInfoBuilder.setGroupID(20);
UserInfo.Builder userInfoBuilder = UserInfo.newBuilder();
userInfoBuilder.setAcctID(200);
userInfoBuilder.setName("user1");
userInfoBuilder.setStatus(UserStatus.OFFLINE);
buddyInfoBuilder.setUserInfo(userInfoBuilder.build());
retrieveBuddiesBuilder.addBuddiesInfo(buddyInfoBuilder.build());
buddyInfoBuilder = BuddyInfo.newBuilder();
buddyInfoBuilder.setGroupID(21);
userInfoBuilder = UserInfo.newBuilder();
userInfoBuilder.setAcctID(201);
userInfoBuilder.setName("user2");
userInfoBuilder.setStatus(UserStatus.ONLINE);
buddyInfoBuilder.setUserInfo(userInfoBuilder);
retrieveBuddiesBuilder.addBuddiesInfo(buddyInfoBuilder);
RetrieveBuddiesResp buddiesResp = retrieveBuddiesBuilder.build();
int length = buddiesResp.getSerializedSize();
System.out.println("The result length is " + length);
byte[] buf = buddiesResp.toByteArray();
try {
RetrieveBuddiesResp buddiesResp2 = RetrieveBuddiesResp.parseFrom(buf);
System.out.println("BuddiesCount = " + buddiesResp2.getBuddiesCnt());
System.out.println("Repeated Size = " + buddiesResp2.getBuddiesInfoCount());
for (int i = 0; i < buddiesResp2.getBuddiesInfoCount(); ++i) {
BuddyInfo buddyInfo = buddiesResp2.getBuddiesInfo(i);
UserInfo userInfo = buddyInfo.getUserInfo();
System.out.println("GroupID = " + buddyInfo.getGroupID() + " UserInfo.acctID = " + userInfo.getAcctID()
+ " UserInfo.name = " + userInfo.getName() + " UserInfo.status = " + userInfo.getStatus());
}
} catch (InvalidProtocolBufferException e) {
e.printStackTrace();
}
System.out.println("Reading data from local file generated by C++");
try {
RetrieveBuddiesResp buddiesResp3 = RetrieveBuddiesResp.parseFrom(new FileInputStream("C:/Mine/RetrieveBuddiesResp.dat"));
System.out.println("BuddiesCount = " + buddiesResp3.getBuddiesCnt());
System.out.println("Repeated Size = " + buddiesResp3.getBuddiesInfoCount());
List<BuddyInfo> buddiesInfo = buddiesResp3.getBuddiesInfoList();
for (BuddyInfo buddyInfo : buddiesInfo) {
UserInfo userInfo = buddyInfo.getUserInfo();
System.out.println("GroupID = " + buddyInfo.getGroupID() + " UserInfo.acctID = " + userInfo.getAcctID()
+ " UserInfo.name = " + userInfo.getName() + " UserInfo.status = " + userInfo.getStatus());
}
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
对于Java而言,我们可以通过Maven工具生成两个jar包,其中一个是protobuf-java-2.4.1.jar,主要用于optimize_for选项为非LITE_RUNTIME的情况,而另一个protobuf-java-2.4.1-lite.jar文件则恰恰与之相反。另外,我通过Beyond Compare工具对这两个jar包进行了二进制比较后发现,他们是完全相同的。这里之所以仍以LITE版本为例,主要还是因为和之前一篇Blog(C++实例)想匹配。
最后需要说明的是,Protocol Buffer仍然提供了很多其它非常有用的功能,特别是针对序列化的目的地,比如文件流和网络流等。与此同时,也提供了完整的官方文档和规范的命名规则,在很多情况下,可以直接通过函数的名字便可获悉函数所完成的工作。
该Blog中使用的示例代码均已附件的方式上传,欢迎大家下载并指正。
原文地址:http://www.cnblogs.com/stephen-liu74/archive/2013/01/06/2842972.html