在protobuf中，`repeated`字段用于表示列表或数组。然而，protobuf的java和kotlin api不提供在构建器中直接对已添加元素进行排序的功能。为了确保这些字段的数据有序，唯一的有效方法是在将数据添加到protobuf消息构建器之前，先在应用层对其进行预排序。本文将详细阐述这一策略，并提供示例代码。
理解Protobuf的repeated字段
Protobuf（Protocol Buffers）是一种语言中立、平台中立、可扩展的结构化数据序列化机制。在Protobuf的消息定义中，repeated关键字用于声明一个字段可以重复出现多次，这在概念上等同于编程语言中的列表（List）或数组（Array）。例如，在一个Info消息中包含多个Dependency对象：
syntax = "proto3"; message Dependency { string name = 1; int32 version = 2; } message Info { repeated Dependency f1 = 1; repeated Dependency f2 = 2; }
在实际应用中，我们经常需要这些repeated字段中的元素以特定的顺序排列，例如按名称字母顺序或版本号大小排序。这种排序需求通常源于业务逻辑或展示要求。
Protobuf API的排序限制
一个常见的疑问是，Protobuf的构建器（Builder）是否会提供直接的排序方法来整理已添加的元素。答案是：不会。Protobuf的Java和Kotlin等语言的API设计侧重于数据的序列化、反序列化效率以及结构化数据的传输，而非数据内容的管理和操作。这意味着，一旦元素被添加到Protobuf消息的构建器中，API本身不会提供内置的排序功能来重新排列这些元素。
具体来说，当调用addF1()或addAllF1()这类方法将元素添加到repeated字段时，这些元素会按照添加的顺序被存储。Protobuf构建器通常会返回一个不可变的消息对象，一旦消息构建完成，其内部的字段列表就无法直接修改或排序。因此，尝试在构建器完成构建后进行排序是不可能的。
推荐的排序策略：预排序
鉴于Protobuf API的限制，确保repeated字段中元素有序的唯一有效且推荐的方法是：在将数据添加到Protobuf消息构建器之前，在应用层对数据进行预排序。
这个策略的核心思想是：
- 使用可变集合： 在业务逻辑中，首先使用标准的、可变的集合类型（如Java的ArrayList或Kotlin的MutableList）来收集所有需要添加到repeated字段的数据。
- 执行排序： 在将这些数据传递给Protobuf构建器之前，利用编程语言提供的排序功能（如Java的Collections.sort()或List.sort()，Kotlin的sortWith()）对这个可变集合进行排序，使其达到期望的顺序。
- 添加到构建器： 最后，将这个已经排好序的集合作为整体，通过addAll<FieldName>()方法添加到Protobuf构建器中对应的repeated字段。Protobuf构建器会按照集合中元素的现有顺序来添加并保留它们。
示例代码
以下是一个Java语言的示例，演示了如何对repeated字段进行预排序：
首先，确保你的项目中包含了由example.proto生成的java类。
import com.google.protobuf.InvalidProtocolBufferException; import java.util.ArrayList; import java.util.Collections; import java.util.Comparator; import java.util.List; // 假设已经通过protobuf编译生成了 Dependency 和 Info 类 public class ProtobufSortingExample { public static void main(String[] args) throws InvalidProtocolBufferException { // 1. 创建原始的Dependency列表 List<Dependency> dependencies = new ArrayList<>(); dependencies.add(Dependency.newBuilder().setName("ZLib").setVersion(100).build()); dependencies.add(Dependency.newBuilder().setName("ALib").setVersion(200).build()); dependencies.add(Dependency.newBuilder().setName("BLib").setVersion(50).build()); System.out.println("原始列表顺序:"); dependencies.forEach(dep -> System.out.println(" " + dep.getName() + " v" + dep.getVersion())); // 2. 对列表进行排序 (按名称字母顺序) // 使用Java 8 Comparator进行排序 Collections.sort(dependencies, Comparator.comparing(Dependency::getName)); System.out.println("n按名称排序后的列表顺序:"); dependencies.forEach(dep -> System.out.println(" " + dep.getName() + " v" + dep.getVersion())); // 3. 将已排序的列表添加到Protobuf构建器 Info info = Info.newBuilder() .addAllF1(dependencies) // 添加已排序的列表 .build(); // 验证Protobuf消息中的f1字段顺序 System.out.println("nProtobuf消息中的f1字段顺序:"); info.getF1List().forEach(dep -> System.out.println(" " + dep.getName() + " v" + dep.getVersion())); // 另一个例子：按版本号排序 List<Dependency> dependenciesByVersion = new ArrayList<>(); dependenciesByVersion.add(Dependency.newBuilder().setName("DepX").setVersion(3).build()); dependenciesByVersion.add(Dependency.newBuilder().setName("DepY").setVersion(1).build()); dependenciesByVersion.add(Dependency.newBuilder().setName("DepZ").setVersion(2).build()); // 对列表进行排序 (按版本号升序) Collections.sort(dependenciesByVersion, Comparator.comparingInt(Dependency::getVersion)); Info infoWithSortedVersion = Info.newBuilder() .addAllF2(dependenciesByVersion) .build(); System.out.println("nProtobuf消息中的f2字段 (按版本排序) 顺序:"); infoWithSortedVersion.getF2List().forEach(dep -> System.out.println(" " + dep.getName() + " v" + dep.getVersion())); } }
注意事项与最佳实践
- 一致性保障： 如果你的应用在多个地方或使用多种语言（如Java、python、Go）处理同一个Protobuf消息，并且对repeated字段的顺序有要求，务必确保所有语言和模块中的排序逻辑都是一致的。不一致的排序可能导致数据处理错误或难以调试的问题。
- 性能考量： 对于包含大量元素的repeated字段，排序操作可能会带来一定的性能开销。在设计时应权衡排序的必要性与性能影响。如果排序只在特定场景下需要，可以考虑在从Protobuf消息中获取到列表后，按需对获取到的列表进行排序，而不是在构建时强制排序。
- 不可变性原则： Protobuf消息一旦构建完成，其内部字段通常是不可变的。这意味着你无法直接修改已构建消息中repeated字段的元素顺序。所有的修改（包括排序）都必须在构建消息之前完成。
- 传输协议与应用逻辑分离： Protobuf本身不包含任何关于字段顺序的语义信息，它只保证序列化和反序列化时字段值的正确性和完整性。排序是应用程序层面的逻辑，而非协议层面的。将排序逻辑置于应用层，有助于保持Protobuf协议的简洁和通用性。
- 自定义排序逻辑： 根据业务需求，可能需要实现复杂的自定义排序逻辑。例如，按多个字段排序、按特定规则分组排序等。这些都应在构建Protobuf消息前的应用层实现。
总结
尽管Protobuf的API不直接支持对repeated字段进行排序，但通过在将数据添加到消息构建器之前进行预排序，可以有效地管理和控制这些字段中元素的顺序。这种方法简单、直接，并且与Protobuf的设计哲学保持一致，即Protobuf负责数据结构的定义和高效传输，而数据内容的组织和管理则由应用层负责。遵循这一策略，可以确保你的Protobuf消息在数据有序性方面满足业务需求，同时保持代码的清晰性和可维护性。