gRPC 接口设计规范与最佳实践.docxVIP

gRPC接口设计规范与最佳实践

一、基础命名规范（Protobuf3）

1.文件与包

文件名：lower_snake_to，例：user_to

package：反向域名，防止命名冲突，pany.module

protobuf

syntax=proto3;

packagepany.user;

optiongo_package=pb/user;userpb;

optionjava_multiple_files=true;

optionjava_package=pany.user.pb;

optionjava_outer_classname=UserProto;

Go：optiongo_package=输出路径;包名

Java：开启java_multiple_files，不要全部塞到一个Outer类

2.服务Service

服务名：PascalCase大驼峰，后缀加Service

protobuf

//正确

serviceUserService{}

//错误

serviceuser{}

方法名：PascalCase大驼峰，动词开头

protobuf

rpcGetUser(GetUserRequest)returns(GetUserResponse);

rpcCreateUser(CreateUserRequest)re