初识ProtoBuf

protoBuf是什么?我想能够搜索到这篇文章的朋友应该都有所了解了,所以我在这里就简单的说一下。

protobuf就是一个可以跨语言、跨平台的数据交换的格式。

介绍就这么多,言简意赅嘛。下面我们就现安装一下protobuf。
我本人比较喜欢去官网下载,下载展示如何在官网下载。

  • 进入官网,之后点击下载-跳转到github对应的protobuf项目点击releases进入源页面下载你所需要的版本。
    此处我通过wget命令下载,我使用的服务器为Centos 7。
# 下载protobuf
wget https://github.com/protocolbuffers/protobuf/releases/download/v3.6.1/protobuf-all-3.6.1.tar.gz

#解压
tar -zxvf protobuf-all-3.6.1.tar.gz 
cd protobuf-all-3.6.1

#预编译和安装,以下过程相对比较慢
./configure --prefix=/home/gnss/software/protobuf
make
make check
make install

#验证是否安装成功
cd /home/gnss/software/protobuf/bin
./protoc --version

#出现下面结果说明你安装成功了
libprotoc 3.6.1

安装成功之后,配置profile文件,以便于命令的运行。

vim /etc/profile

#在添加类似配置
PROTOBUF_HOME=/home/gnss/software/protobuf
PATH=$PATH:$PROTOBUF_HOME/bin
export PROTOBUF_HOME PATH

到此处安装与配置都已经结束,下面可以正式对protobuf学习了。


首先我们先看一个案例,案例如下(因为我使用的是protobuf 3.0之后的版本,语法与2.0不同,详细信息建议去官网查看):

#protobuf文件的后缀为proto
vim person.proto

#添加以下信息,由于本人是java程序员,以下都是以java为标准的
syntax = "proto3";

option java_package = "com.mrzhang.study.protobufdemo.protos";
option java_outer_classname = "PersonProto";

message Person {
    string name = 1;
    int32 age = 2;
    bool sex = 3;
    int64 birthday = 4;
    string address = 5;
    repeated Car cars = 6;
    map other = 7;
}

message Car {
    string name = 1;
    string color = 2;
}

说明

  • syntax = "proto3":声明语法,不显示声明默认是2.0的语法。
  • option java_package = "com.mrzhang.study.protobufdemo.protos":声明生成的java文件的包名,包名称为:com.mrzhang.study.protobufdemo.protos。
  • option java_outer_classname = "PersonProto":声明生成的java文件的名称,名称为PersonProto。
  • message Person{}:声明一个内部类,这点对于java程序员应该比较好理解。整个文件可以理解为是一个名为PersonProto的Java类,而里面声明的message相当于PersonProto的内部类。
  • string name = 1:声明内部类的属性,及属性类型,属性编号。
    对于属性声明,格式为:标注+类型+属性名+属性顺序号+[默认值]
    标注:required、optional、repeated标注存在着3中,在3.0之前,标注是必须的,但在3.0之后required、optional是可以不写的,如果填写了,抱歉语法会告诉你“3.0了,还写它干嘛,赶紧删了”repeated这个标注,是为了声明集合而存在的,但是转换为java类之后你会发现,它是List接口的一个实现类。
    属性名:对应java类中的字段名称,可以使用下划线命名,在java类中会转换为驼峰命名的。
    [默认值]:此属性适用于3.0之前,在3.0之后不需要设置了。
    属性顺序号在同一个message内部是全局唯一的,不能够重复。
    类型:这个比较多,我就只举例较为常用的几个,若想查看其他参数建议去官网查看,具体类型对比如下:
.proto类型 Java 类型 备注
int32 int 使用可变长度编码。 编码负数的效率低 - 如果您的字段可能有负值,请改用sint32。
int64 long 使用可变长度编码。 编码负数的效率低 - 如果您的字段可能有负值,请改用sint64。
sint32 int 使用可变长编码方式。有符号的整型值。编码时比通常的int32高效。
sint64 long 使用可变长编码方式。有符号的整型值。编码时比通常的int64高效。
float float
double double
bool boolean
string String 一个字符串必须是UTF-8编码或者7-bit ASCII编码的文本。

举例: required sint number = 1 [description = 666];
保存文件通过protoc执行生成相关java文件。

#运行以下命令
protoc --java_out=./ person.proto 

#执行成功之后会在当前目录下看到,你在文件中设置的java_package的文件路径,进入路径查看文件
cd com/mrzhang/study/protobufdemo/protos
ll

#看到以下文件
-rw-r--r--. 1 root root 77379 11月 15 00:00 PersonProto.java

查看文件内容如下(文件内容太长此处我就只摘抄部分):

package com.mrzhang.study.protobufdemo.protos;

public final class PersonProto {
    public  static final class Person extends com.google.protobuf.GeneratedMessageV3 implements PersonOrBuilder {
        private static final long serialVersionUID = 0L;

        private Person(com.google.protobuf.GeneratedMessageV3.Builder builder) {
            super(builder);
        }
        private Person() {
            name_ = "";
            age_ = 0;
            sex_ = false;
            birthday_ = 0L;
            address_ = "";
            cars_ = java.util.Collections.emptyList();
        }

        private volatile java.lang.Object name_;
        private int age_ ;
        private boolean sex_;
        private long birthday_;
        private volatile java.lang.Object address_;
        private java.util.List cars_;
        private com.google.protobuf.MapField other_;
}

初识protobuf就到这里,后续我将结合java代码,展示protobuf的使用。

你可能感兴趣的:(初识ProtoBuf)