gRPC实践之proto及Maven插件概念及使用详解

syntax = "proto3"; // 定义使用的语法版本，这里是proto3
package com.example.grpc; // 定义package，用于在其他文件中引用该文件定义的类型
// 定义配置项 
// - java_package ：定义生成的Java类的包名
// - java_outer_classname  : 定义生成的Java类的类名
option java_multiple_files = true;
// 接口类
service UserService {
  rpc query (UserRequest) returns (UserResponse);
}
// 定义消息类型
message UserRequest {
  string name = 1; // 字段类型和名称，以及字段标识符，用于序列化和反序列化
}
// 这里的消息类型是返回值
message UserResponse {
  string name = 1;
  int32 age = 2;
  string address = 3;
  // 这里定义一个枚举
  enum PhoneType { MOBILE = 0; HOME = 1; WORK = 2; } 
  // 这里定义一个内部对象
  repeated PhoneNumber phones = 4;
  message PhoneNumber {
    string number = 1;
    PhoneType type = 2;
  }
}

@Resource
UserServiceGrpc.UserServiceBlockingStub userService;
UserRequest userRequest = UserRequest.newBuilder().setName("test").build();
UserResponse user = userService.query(userRequest);

// 注解中就标注了请求的路径和请求体，返回体
// 没看 grpc 源码，但是猜测里面会通过这个注解构建请求
@io.grpc.stub.annotations.RpcMethod(
    fullMethodName = SERVICE_NAME + '/' + "query",
    // 这个就对应着 .proto 中配置的 message 对象
    requestType = com.example.grpc.UserRequest.class,
    responseType = com.example.grpc.UserResponse.class,
    methodType = io.grpc.MethodDescriptor.MethodType.UNARY)
// 这里返回的实际上是一个 MethodDescriptor 对象
public static io.grpc.MethodDescriptor getQueryMethod() {
  io.grpc.MethodDescriptor getQueryMethod;
  // Spring 注入的时候应该是没有多线程风险的，这个可能是为了其他加载方式准备，上了一把锁
  // PS : 这里是一个经典的单例模式，不过代码太长被我屏蔽了
  synchronized (UserServiceGrpc.class) {
      // 省略具体的build逻辑，这里设置了很多内部参数，方法名等等
      UserServiceGrpc.getQueryMethod = getQueryMethod =
            io.grpc.MethodDescriptor.<....>newBuilder()
            // ... 省略
            .build();
      }
  return getQueryMethod;
}

//  对应的class对象里面方法大同小异
public static final class UserServiceStub extends io.grpc.stub.AbstractAsyncStub<UserServiceStub> {
  // 简单的构造器，这里传入了一个 channel ，表示与服务端通信的通道  
  private UserServiceStub(
      io.grpc.Channel channel, io.grpc.CallOptions callOptions) {
    super(channel, callOptions);
  }
  // 调用 new 完成 build
  protected UserServiceStub build
  // 发起具体的 query 请求
  public void query(com.example.grpc.UserRequest request,
      io.grpc.stub.StreamObserver<com.example.grpc.UserResponse> responseObserver)

public interface UserRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:com.example.grpc.UserRequest)
    com.google.protobuf.MessageOrBuilder {
  /**
   * <code>string name = 1;</code>
   */
  java.lang.String getName();
  /**
   * <code>string name = 1;</code>
   */
  com.google.protobuf.ByteString
      getNameBytes();
}

example.OuterClass.Person person = example.OuterClass.Person.newBuilder() .setName("Alice") .setId(123) .build();