protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别

时间:2023-02-04 15:33:39

最近在做一个基于Netty框架的项目。

该项目使用了Google的Protobuf作为编解码的框架。(没有使用XML或者json是为了更好的提高效率)。

经过了一段时间的使用我对Protobuf的原始文件进行一个简单的使用方法总结。

我主要在这里说明一下,原始文件.proto中,修饰符repeated、required、optional的区别。

0.windows环境,java工程

1.安装protobuf后,找到protoc.exe

2.写一个配置文件进行批处理(.bat),如下图所示

protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


3.写一个proto文件,如:


package trade;

message Testq{
required string deal_no=1;
required string client_id=2;
}

(注意:此处之后要进行修饰符repeated、required、optional的区别比较,因此会不断的修改proto文件。)


4.开始进行比较。


4.1使用repeated和不使用repeated的区别。

     repeated 就是说该字段是指定类型的数组。在java中是一个list,也就说,在调用的时候可以调用一个list集合,不需要一个一个的调用了,这样做很方便。下面我们来看图,进行详细的说明:


   4.1.1配置文件的比较,

        protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


下面看看在java中的区别:


首先我们会看待到,在java中增加了public interface TestsOrBuilder的这些代码,然后会看到,java.util.List<trade.Test.Testq> getTestsList();的代码,这段代码说明增加了repeated修饰符之后,生成的java代码为list类型。


protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


然后,我们会在697行找到Testq的代码,因此,增加了repeated修饰之后,也会增加600多行代码。详见下图:

protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


然后在下方还会发现,不同,详见下图:

例如会在有repeated的文件中增加,internal_static_trade_Tests_descriptor的代码片段

protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


还会增加对于list的简单描述。

protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


4.2  关于requird和optional修饰符的区别


先看配置文件,如下图:

protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


再来看生成的java代码的区别:


首先会调整说明注释,如下图


protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


然后,关键代码也会进行调整,如下图:不一样的代码required和optional-1


protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


不一样的代码required和optional-2


protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别


不一样的代码required和optional-3


protobuf的配置原始文件.proto中,使用修饰符repeated、required、optional生成的java文件的区别



通过代码我们可以看出,required的选项应该表示该字段必选,optional表示可先。


最后那个\001 和\002的区别,我查到了之后再补充吧。

这个是在网上找的一段关于这个\002的说明,有懂的人帮着确认或者解释一下吧。

Control Characters


                    CTRL   (^D means to hold the CTRL key and hit d)
Oct  Dec Char  Hex  Key     Comments
\000   0  NUL  \x00  ^@ \0 (Null byte)
\001   1  SOH  \x01  ^A    (Start of heading)
\002   2  STX  \x02  ^B    (Start of text)