ProtoBuf的使用

最新推荐文章于 2024-10-02 07:55:04 发布

世界,我们认识多久了

最新推荐文章于 2024-10-02 07:55:04 发布

阅读量995

点赞数 20

文章标签：后端

本文链接：https://blog.csdn.net/weixin_47629101/article/details/140950421

版权

文章目录

概要

Protocol Buffers（简称Proto）是一种轻量、高效、语言无关、平台无关的序列化数据结构的方法，其主要用途包括：

数据序列化：Proto定义了一种结构化数据的格式，可以用来序列化结构化数据对象为二进制格式，或者反序列化二进制数据为结构化数据对象。这种序列化格式具有高效性和紧凑性，适合网络传输和持久化存储。
跨语言、跨平台通信：Proto生成的数据格式是语言无关和平台无关的，这使得不同编程语言和不同操作系统的应用程序可以相互通信和交换数据，而无需关心底层实现细节。
数据结构定义：通过.proto文件定义数据结构和数据类型，包括消息类型、字段、枚举等，Proto提供了一种清晰的方式来描述数据的结构，使得数据交换和持久化更加简单和可靠。
版本兼容性：Proto支持向前和向后兼容性，即使在消息结构发生变化时，旧版本的代码仍然可以与新版本的数据进行互操作，这对于分布式系统和长期演进的软件架构尤为重要。
性能优化：Proto生成的代码通常比通用的文本序列化格式（如JSON和XML）更小、更快，这使得它在对性能有要求的应用场景下（如大规模数据处理、高并发网络通信等）具有显著的优势。
自动生成代码：根据.proto文件，Proto提供了代码生成工具（如protoc编译器），可以自动生成对应编程语言的数据访问类，大大简化了开发人员的工作量。

总之，Proto在现代软件开发中被广泛用于构建高效、可扩展、跨平台的数据通信和存储方案，特别适用于需要高性能和数据结构明确定义的场景。

.proto 文件中可以定义以下几种数据结构

消息（Message）: 消息是.proto 文件中最基本的数据结构，类似于类的概念，用于描述一个数据对象。消息可以包含多个字段，每个字段可以是不同类型的数据，如整数、字符串、Map、嵌套的消息等。
```
message Person {
    string name = 1;
    int32 id = 2;
    string email = 3;
    map<string,strring> hobby = 4;
}
```
在 Protocol Buffers 中，list 的概念不像在某些编程语言中直接使用的列表或数组那样，而是通过重复字段来实现类似列表的功能。在 .proto 文件中，可以使用重复字段来定义一个列表或数组的数据结构。

下面是如何在 Protocol Buffers 中定义和使用一个List(列表)的简单示例：

在 `.proto` 文件中List的实现：

假设我们要定义一个消息，其中包含一个字符串列表：

syntax = "proto3";

message StringList {
    repeated string items = 1;
}

repeated string items = 1;：这行代码定义了一个名为 items 的重复字段，类型为 string。关键字 repeated 表示这是一个重复字段，可以包含多个值，类似于一个动态长度的数组或列表。
items 字段可以包含零个或多个字符串值。

Java 示例：

// 创建一个 StringList 消息对象
StringList.Builder builder = StringList.newBuilder();
// 添加字符串到 items 列表中
builder.addItems("Item 1");
builder.addItems("Item 2");

// 获取列表中的元素
StringList stringList = builder.build();
List<String> itemsList = stringList.getItemsList();
for (String item : itemsList) {
    System.out.println(item);
}

枚举（Enum）: 枚举用于定义一组命名的常量值。在.proto 文件中，枚举值被赋予一个整数值，可以用于表示某种状态或选项。
```
enum PhoneType {
    MOBILE = 0;
    HOME = 1;
    WORK = 2;
}
```
服务（Service）: 服务定义了可以由客户端调用的一组方法。每个服务方法都有一个请求消息和一个响应消息，用于进行通信和交互。
```
service AddressBook {
    rpc AddPerson(Person) returns (AddressBook);
    rpc GetPerson(int32) returns (Person);
}
```
扩展（Extensions）: 扩展用于向现有消息添加新字段，而不需要修改消息的定义。它允许在不破坏现有代码的情况下向消息中添加新的字段和功能。
```
extend Person {
    optional string address = 4;
}
```