nRPC protobuf定义指南服务与消息设计最佳实践【免费下载链接】nrpcnRPC is like gRPC, but over NATS项目地址: https://gitcode.com/gh_mirrors/nr/nrpcnRPC是基于NATS协议的高性能RPC框架类似于gRPC但通过NATS消息系统实现通信。本指南将帮助开发者掌握protobuf定义的核心技巧从基础语法到高级功能打造符合nRPC规范的服务接口。一、protobuf基础结构与规范1.1 文件头部声明每个nRPC protobuf文件需以syntax proto3;声明开始并指定package和go_package等核心选项syntax proto3; package helloworld; option go_package github.com/nats-rpc/nrpc/examples/helloworld/helloworld;1.2 导入nRPC扩展nRPC提供专用的protobuf扩展定义需通过import语句引入import nrpc.proto;该文件位于项目根目录nrpc.proto包含服务发现、消息路由等关键扩展字段。二、消息设计最佳实践2.1 基础消息结构消息字段应遵循必填字段前置可选字段后置原则使用合理的字段编号1-15为单字节编码优先使用// 标准请求消息示例 message HelloRequest { string name 1; // 必选字段 int32 timeout 2; // 可选字段 } // 标准响应消息示例 message HelloReply { string message 1; int32 code 2; }2.2 特殊消息类型nRPC预定义了常用空消息类型可直接使用无需重复定义Void: 空消息体nrpc.protoNoRequest: 无请求参数nrpc.protoNoReply: 无响应结果nrpc.proto三、服务定义与配置3.1 基础服务定义服务定义需明确包含请求/响应类型采用PascalCase命名规范// 服务定义示例 service Greeter { // 简单RPC方法 rpc SayHello (HelloRequest) returns (HelloReply) {} }完整示例可参考examples/helloworld/helloworld/helloworld.proto。3.2 高级服务配置通过nRPC扩展选项可自定义服务路由行为// 自定义主题前缀 option (nrpc.packageSubject) custom.prefix; // 服务级主题配置 service Greeter { option (nrpc.serviceSubject) greet; rpc SayHello (HelloRequest) returns (HelloReply) { option (nrpc.methodSubject) hello; // 方法级主题 } }四、流式处理与高级特性4.1 流式响应配置通过streamedReply选项启用服务端流式响应rpc Subscribe (EventRequest) returns (EventReply) { option (nrpc.streamedReply) true; // 启用流式响应 }4.2 错误处理机制nRPC定义了标准错误消息结构包含错误类型和详细信息message Error { enum Type { CLIENT 0; // 客户端错误 SERVER 1; // 服务端错误 SERVERTOOBUSY 4; // 服务繁忙 } Type type 1; string message 2; }完整定义见nrpc.proto。五、最佳实践总结命名规范服务名使用PascalCase如GreeterService方法名使用camelCase如sayHello消息名使用PascalCase如HelloRequest版本控制避免删除已使用字段新增字段使用新编号重大变更建议创建新服务如GreeterV2性能优化高频字段使用1-15编号大型消息使用repeated而非bytes合理设置packageSubjectParams减少主题长度通过遵循以上规范您可以构建出清晰、高效且兼容nRPC框架的protobuf定义。更多示例可参考项目中的examples目录包含完整的服务定义和使用场景。【免费下载链接】nrpcnRPC is like gRPC, but over NATS项目地址: https://gitcode.com/gh_mirrors/nr/nrpc创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
nRPC protobuf定义指南：服务与消息设计最佳实践
发布时间：2026/7/28 10:46:50
nRPC protobuf定义指南服务与消息设计最佳实践【免费下载链接】nrpcnRPC is like gRPC, but over NATS项目地址: https://gitcode.com/gh_mirrors/nr/nrpcnRPC是基于NATS协议的高性能RPC框架类似于gRPC但通过NATS消息系统实现通信。本指南将帮助开发者掌握protobuf定义的核心技巧从基础语法到高级功能打造符合nRPC规范的服务接口。一、protobuf基础结构与规范1.1 文件头部声明每个nRPC protobuf文件需以syntax proto3;声明开始并指定package和go_package等核心选项syntax proto3; package helloworld; option go_package github.com/nats-rpc/nrpc/examples/helloworld/helloworld;1.2 导入nRPC扩展nRPC提供专用的protobuf扩展定义需通过import语句引入import nrpc.proto;该文件位于项目根目录nrpc.proto包含服务发现、消息路由等关键扩展字段。二、消息设计最佳实践2.1 基础消息结构消息字段应遵循必填字段前置可选字段后置原则使用合理的字段编号1-15为单字节编码优先使用// 标准请求消息示例 message HelloRequest { string name 1; // 必选字段 int32 timeout 2; // 可选字段 } // 标准响应消息示例 message HelloReply { string message 1; int32 code 2; }2.2 特殊消息类型nRPC预定义了常用空消息类型可直接使用无需重复定义Void: 空消息体nrpc.protoNoRequest: 无请求参数nrpc.protoNoReply: 无响应结果nrpc.proto三、服务定义与配置3.1 基础服务定义服务定义需明确包含请求/响应类型采用PascalCase命名规范// 服务定义示例 service Greeter { // 简单RPC方法 rpc SayHello (HelloRequest) returns (HelloReply) {} }完整示例可参考examples/helloworld/helloworld/helloworld.proto。3.2 高级服务配置通过nRPC扩展选项可自定义服务路由行为// 自定义主题前缀 option (nrpc.packageSubject) custom.prefix; // 服务级主题配置 service Greeter { option (nrpc.serviceSubject) greet; rpc SayHello (HelloRequest) returns (HelloReply) { option (nrpc.methodSubject) hello; // 方法级主题 } }四、流式处理与高级特性4.1 流式响应配置通过streamedReply选项启用服务端流式响应rpc Subscribe (EventRequest) returns (EventReply) { option (nrpc.streamedReply) true; // 启用流式响应 }4.2 错误处理机制nRPC定义了标准错误消息结构包含错误类型和详细信息message Error { enum Type { CLIENT 0; // 客户端错误 SERVER 1; // 服务端错误 SERVERTOOBUSY 4; // 服务繁忙 } Type type 1; string message 2; }完整定义见nrpc.proto。五、最佳实践总结命名规范服务名使用PascalCase如GreeterService方法名使用camelCase如sayHello消息名使用PascalCase如HelloRequest版本控制避免删除已使用字段新增字段使用新编号重大变更建议创建新服务如GreeterV2性能优化高频字段使用1-15编号大型消息使用repeated而非bytes合理设置packageSubjectParams减少主题长度通过遵循以上规范您可以构建出清晰、高效且兼容nRPC框架的protobuf定义。更多示例可参考项目中的examples目录包含完整的服务定义和使用场景。【免费下载链接】nrpcnRPC is like gRPC, but over NATS项目地址: https://gitcode.com/gh_mirrors/nr/nrpc创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
