gRPC 一键生成 API 服务：只需几个步骤，快速上手

2022-12-31 18:30:45

gRPC 实践中 proto 和 Maven 插件的使用指南

了解 proto

proto 是一种消息结构和服务定义的语言。它由 Google 开发，旨在提供一种独立于语言和平台的方式来定义 API。通过使用 proto，您可以轻松地生成客户端和服务器代码，这些代码可以在各种编程语言和平台上使用。

使用 protobuf 编译器

要生成 proto 代码，您需要使用 protobuf 编译器。这是一个命令行工具，可以将 proto 文件编译成特定语言的代码。在 Maven 项目中，可以使用 protobuf Maven 插件来自动执行此过程。

<dependency>
  <groupId>com.google.protobuf</groupId>
  <artifactId>protobuf-maven-plugin</artifactId>
  <version>0.8.18</version>
</dependency>

在您的 pom.xml 文件中添加此依赖项后，您可以在项目中使用以下命令编译 proto 文件：

mvn protobuf:compile

这将生成 Java 代码，这些代码包含您 proto 文件中定义的 API 服务的接口和实现代码。

使用 gRPC 依赖项

要使用 gRPC 的 API，您需要在 Maven 项目中添加 gRPC 依赖项：

<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-stub</artifactId>
  <version>1.48.0</version>
</dependency>

构建和启动 gRPC 服务器

使用 gRPC 的 API，您可以构建和启动服务器，该服务器将处理客户端请求。以下是一个使用 Java 构建和启动 gRPC 服务器的示例：

public class GreeterServer {
  public static void main(String[] args) throws IOException, InterruptedException {
    Server server = ServerBuilder.forPort(50051).addService(new GreeterImpl()).build();
    server.start();
    server.awaitTermination();
  }
}

调用 gRPC API

要调用 gRPC API，可以使用 gRPC 的 API 来创建客户端存根。以下是一个使用 Java 调用 gRPC API 的示例：

public class GreeterClient {
  public static void main(String[] args) throws IOException, InterruptedException {
    ManagedChannel channel = ManagedChannelBuilder.forAddress("localhost", 50051).usePlaintext().build();
    GreeterGrpc.GreeterBlockingStub stub = GreeterGrpc.newBlockingStub(channel);
    HelloRequest request = HelloRequest.newBuilder().setName("world").build();
    HelloReply response = stub.sayHello(request);
    System.out.println(response.getMessage());
  }
}

常见问题解答

如何安装 protobuf 编译器？
- 在命令行终端中输入 brew install protobuf。
如何添加 protobuf 依赖项？
- 在您的 pom.xml 文件中添加以下依赖项：<dependency> <groupId>com.google.protobuf</groupId> <artifactId>protobuf-java</artifactId> <version>3.21.9</version> </dependency>。
如何编译 proto 文件？
- 使用以下命令：protoc --java_out=src/main/java -I. *.proto。
如何添加 gRPC 依赖项？
- 在您的 pom.xml 文件中添加以下依赖项：<dependency> <groupId>io.grpc</groupId> <artifactId>grpc-stub</artifactId> <version>1.48.0</version> </dependency>。
如何构建和启动 gRPC 服务器？
- 创建一个新的 Java 类并实现 GreeterGrpc.GreeterImplBase 接口。然后，使用 ServerBuilder 类构建和启动服务器。