.proto文件编写

2019-12-20

proto编写

1	.proto文件以包声明开头
2	// 字段类型
3	bool，int32，float，double，和string

范例

syntax = "proto3";
package admin;

// 内部运营权限管理服务
service AdminGrpc {
  rpc GetAuthInfo (AdminRequest) returns (AdminResponse);
  rpc AddUser (AdminRequest) returns (AdminResponse);
  rpc DeleteUser (AdminRequest) returns (AdminResponse);
  rpc UpdateUser (AdminRequest) returns (AdminResponse);
}

// 请求参数
message AdminRequest {
  // 用户名
  string user_name = 1;

  // 用户类型(默认管理员)
  enum UserType {
    NORMAL = 0; // 普通用户
    ADMIN = 1; // 管理员
  }
  UserType use_type = 2;

  // 用户手机号
  string phone = 3;

  // 权限信息返回类型
  enum AuthInfoResType {
    ALL = 0; // 全部信息
    MODULE = 1; // 按模块化信息
    AUTH = 2; // 单权限信息
  }
  AuthInfoResType auth_res_type = 4;

  // 功能模块类型
  enum ModuleType {
    PLATFORM = 0; // 平台管理中心权限
    BUSINESS = 1; // 企业管理权限
    FINANCIAL = 2; // 金融管理权限
    REPORT_FORM = 3; // 报表分析权限
    USER_BEHAVIOR = 4; // 用户行为分析
    REPORT_MANAGE = 5; // 报告管理权限
    DEVICE = 6; // 设备管理权限
    SYSTEM = 7; // 系统管理权限
  }
  ModuleType module_type = 5;

  // 单权限类型
  enum AuthType {
    CAR_ACCOUNT = 0; // 台账
    CAR_ACCOUNT_BTN_EXPORT = 1; // 台账按钮导出
    CAR_ACCOUNT_LIST_OPERATION = 2; // 台账列表操作
    CAR_ACCOUNT_LIST_INSTALL_TIME = 3; // 安装时间
    CAR_ACCOUNT_LIST_STATE = 4; // 状态
    CAR_ACCOUNT_LIST_CITY = 5; // 安装城市
    CAR_ACCOUNT_LIST_MILEAGE = 6; // 里程
  }
  AuthType auth_type = 6;

  // API提供的body
  string data = 7;
}

// 数据返回
message AdminResponse {
    string msg = 1;
    string error = 2;
    string data = 3;
}

自动生成代码

python -m grpc_tools.protoc -I ./ --python_out=. --grpc_python_out=. admin.proto

// xxxx_pb2.py包含我们生成的请求和响应类，xxxx_pb2_grpc.py并包含我们生成的客户端和服务器类

注意

1.proto3中默认参数是可选，不可进行显示的声明optional // proto2可以

2.proto3中不允许使用必需字段(required) // proto2可以

3.proto3中不允许显式声明默认值 // proto2可以