在protobuf中，`repeated` 字段默认不提供内置的排序功能。若需确保这些字段的元素有序，唯一有效的方法是在将数据添加到protobuf构建器（builder）之前，手动对持有这些元素的集合进行排序。无论是java还是kotlin的protobuf api，都不支持在元素被添加到构建器后进行排序操作，因此必须在构建消息之前完成排序。
理解Protobuf的repeated字段
Protobuf的repeated字段用于表示一个可重复的、零个或多个相同类型的元素列表。例如，在定义一个包含多个依赖项的Info消息时，可能会用到如下结构：
syntax = "proto3";message Dependency { string name = 1; int32 version = 2;}message Info { repeated Dependency f1 = 1; repeated Dependency f2 = 2;}
在这种情况下，f1和f2都是Dependency对象的列表。Protobuf规范本身并没有对repeated字段的元素顺序做强制性规定，它仅仅保证了序列化和反序列化时元素的相对顺序不变。这意味着，如果你以特定顺序添加元素，它们在反序列化后仍会保持该顺序。然而，Protobuf API本身不提供自动排序功能。
Protobuf repeated字段的排序挑战
许多应用场景可能需要repeated字段中的元素保持特定的排序，例如：
数据一致性： 确保无论何时何地生成消息，其内部列表的顺序都是可预测的。比较操作： 方便对两个Protobuf消息进行比较，如果列表顺序不同，即使内容相同也会被认为是不同的消息。业务逻辑： 某些业务逻辑可能依赖于列表的特定排序。
Protobuf的Java或Kotlin API在设计时，并没有将排序功能集成到其构建器（Builder）中。这意味着一旦你通过addF1()、addAllF1()等方法将元素添加到Info消息的构建器中，就无法直接调用构建器上的方法来对这些已添加的元素进行排序。
解决方案：构建前手动排序
鉴于Protobuf API的特性，唯一且最直接的解决方案是在将元素添加到Protobuf构建器之前，在你的应用程序代码中完成排序。这通常涉及以下步骤：
怪兽AI数字人
数字人短视频创作，数字人直播，实时驱动数字人
44 查看详情 创建可变列表： 使用一个标准的Java List或Kotlin MutableList来收集你想要添加到repeated字段的所有元素。添加元素： 将所有Dependency对象添加到这个可变列表中。执行排序： 使用Java的Collections.sort()或Kotlin的sort()、sortBy()等方法，根据你的排序逻辑对列表进行排序。添加到Protobuf构建器： 将已排序的列表通过addAll方法添加到Protobuf消息的构建器中。
示例代码 (Java)
假设我们有一个Dependency类，并希望根据name字段进行排序。
import com.example.protobuf.Dependency;import com.example.protobuf.Info;import java.util.ArrayList;import java.util.Collections;import java.util.List;public class ProtobufSortingExample { public static void main(String[] args) { // 1. 创建可变列表 List dependenciesF1 = new ArrayList(); dependenciesF1.add(Dependency.newBuilder().setName("Spring Boot").setVersion(2).build()); dependenciesF1.add(Dependency.newBuilder().setName("Log4j").setVersion(1).build()); dependenciesF1.add(Dependency.newBuilder().setName("Guava").setVersion(3).build()); // 2. 添加元素 (已完成) // 3. 执行排序 (根据name字段升序排序) Collections.sort(dependenciesF1, (d1, d2) -> d1.getName().compareTo(d2.getName())); // 4. 添加到Protobuf构建器 Info info = Info.newBuilder() .addAllF1(dependenciesF1) // 添加已排序的列表 .build(); // 验证排序结果 System.out.println("Sorted F1 dependencies:"); info.getF1List().forEach(dep -> System.out.println(" " + dep.getName() + " v" + dep.getVersion())); // 对于f2字段，如果也需要排序，则重复上述步骤 List dependenciesF2 = new ArrayList(); dependenciesF2.add(Dependency.newBuilder().setName("Jackson").setVersion(2).build()); dependenciesF2.add(Dependency.newBuilder().setName("OkHttp").setVersion(4).build()); dependenciesF2.add(Dependency.newBuilder().setName("Retrofit").setVersion(2).build()); // 排序f2 Collections.sort(dependenciesF2, (d1, d2) -> d1.getName().compareTo(d2.getName())); Info anotherInfo = Info.newBuilder() .addAllF1(dependenciesF1) .addAllF2(dependenciesF2) // 添加已排序的f2列表 .build(); System.out.println("nSorted F2 dependencies:"); anotherInfo.getF2List().forEach(dep -> System.out.println(" " + dep.getName() + " v" + dep.getVersion())); }}
输出示例：
Sorted F1 dependencies: Guava v3 Log4j v1 Spring Boot v2Sorted F2 dependencies: Jackson v2 OkHttp v4 Retrofit v2
示例代码 (Kotlin)
import com.example.protobuf.Dependencyimport com.example.protobuf.Infofun main() { // 1. 创建可变列表 val dependenciesF1 = mutableListOf() dependenciesF1.add(Dependency.newBuilder().setName("Spring Boot").setVersion(2).build()) dependenciesF1.add(Dependency.newBuilder().setName("Log4j").setVersion(1).build()) dependenciesF1.add(Dependency.newBuilder().setName("Guava").setVersion(3).build()) // 2. 添加元素 (已完成) // 3. 执行排序 (根据name字段升序排序) dependenciesF1.sortBy { it.name } // 4. 添加到Protobuf构建器 val info = Info.newBuilder() .addAllF1(dependenciesF1) // 添加已排序的列表 .build() // 验证排序结果 println("Sorted F1 dependencies:") info.f1List.forEach { dep -> println(" ${dep.name} v${dep.version}") } // 对于f2字段，如果也需要排序，则重复上述步骤 val dependenciesF2 = mutableListOf() dependenciesF2.add(Dependency.newBuilder().setName("Jackson").setVersion(2).build()) dependenciesF2.add(Dependency.newBuilder().setName("OkHttp").setVersion(4).build()) dependenciesF2.add(Dependency.newBuilder().setName("Retrofit").setVersion(2).build()) // 排序f2 dependenciesF2.sortBy { it.name } val anotherInfo = Info.newBuilder() .addAllF1(dependenciesF1) .addAllF2(dependenciesF2) // 添加已排序的f2列表 .build() println("nSorted F2 dependencies:") anotherInfo.f2List.forEach { dep -> println(" ${dep.name} v${dep.version}") }}
注意事项与总结
排序时机： 务必在调用Protobuf构建器的addAll或add方法之前完成排序。一旦元素被添加到构建器，就无法再通过Protobuf API进行排序。性能考量： 对于包含大量元素的repeated字段，频繁进行排序可能会带来一定的性能开销。在设计系统时，应权衡排序的必要性与潜在的性能影响。一致性： 如果你的系统对repeated字段的顺序有要求，请确保所有生成该Protobuf消息的代码路径都遵循相同的排序逻辑，以保证数据的一致性。自定义排序： 排序逻辑可以根据实际需求进行定制，例如按多个字段排序、降序排序等，只需提供相应的Comparator或Lambda表达式。Protobuf设计哲学： Protobuf本身更侧重于高效的数据序列化和反序列化，对于数据在传输过程中的语义（如顺序、唯一性等）通常留给应用程序层处理。这也是为什么它不提供内置排序功能的原因之一。
总之，虽然Protobuf本身不提供repeated字段的排序功能，但通过在构建消息前对数据进行手动排序，可以轻松实现对这些字段的有序控制，确保数据符合业务需求。
以上就是Protobuf repeated 字段排序的最佳实践的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/294829.html
微信扫一扫 
支付宝扫一扫 
