当前位置：首页 > news >正文

21-java-grpc-demo-1

news 2025/10/18 13:10:34

java #grpc

Java gRPC 实战：从零构建高效的RPC服务

代码仓库

https://gitee.com/suveng/java_grpc_demo_1

引言：为什么选择gRPC？

在现代分布式系统中，服务间通信已成为架构设计的核心环节。传统的RESTful API虽然简单易用，但在高性能场景下往往显得力不从心。gRPC作为Google开源的高性能RPC框架，凭借其基于HTTP/2的传输协议、Protocol Buffers的序列化格式以及强大的代码生成能力，正在成为微服务架构中的首选通信方案。

本文将通过一个完整的Java gRPC示例项目，深入探讨如何从零开始构建一个高效的RPC服务。我们将从项目结构、关键代码实现到执行流程，全方位解析gRPC的工作原理和最佳实践，帮助读者快速掌握这一强大的技术栈。

项目概览与技术栈

我们的示例项目是一个简单的问候服务，包含服务器端和客户端实现。项目采用Maven构建，使用Java 21作为开发语言，集成了gRPC 1.58.0和Protocol Buffers 3.21.12。

项目结构


java-grpc-demo/├── pom.xml                              # Maven配置文件├── src/│   └── main/│       ├── java/com/example/grpc/│       │   ├── GreeterServer.java      # gRPC服务器实现│       │   ├── GreeterClient.java      # gRPC客户端实现│       │   └── DemoApp.java            # 演示应用程序│       └── proto/│           └── greeting.proto           # Protocol Buffers定义文件└── README.md                           # 项目说明文档

核心依赖配置

在pom.xml中，我们配置了以下关键依赖：


<dependencies>    <!-- gRPC核心依赖 -->    <dependency>        <groupId>io.grpc</groupId>        <artifactId>grpc-netty-shaded</artifactId>        <version>${grpc.version}</version>    </dependency>    <dependency>        <groupId>io.grpc</groupId>        <artifactId>grpc-protobuf</artifactId>        <version>${grpc.version}</version>    </dependency>    <dependency>        <groupId>io.grpc</groupId>        <artifactId>grpc-stub</artifactId>        <version>${grpc.version}</version>    </dependency>    <!-- Protocol Buffers支持 -->    <dependency>        <groupId>com.google.protobuf</groupId>        <artifactId>protobuf-java</artifactId>        <version>${protobuf.version}</version>    </dependency></dependencies>

关键代码解析

1. Protocol Buffers服务定义

gRPC的核心是使用Protocol Buffers定义服务接口。在我们的greeting.proto文件中：


syntax = "proto3";package com.example.grpc;option java_package = "com.example.grpc";option java_multiple_files = true;// 定义问候服务service Greeter {  // 发送问候的RPC方法  rpc SayHello (HelloRequest) returns (HelloReply) {}  // 再次发送问候的RPC方法  rpc SayHelloAgain (HelloRequest) returns (HelloReply) {}}// 请求消息，包含用户名message HelloRequest {  string name = 1;}// 响应消息，包含问候语message HelloReply {  string message = 1;}

这个定义文件描述了：

一个名为Greeter的服务，包含两个RPC方法
请求消息HelloRequest，包含一个字符串字段name
响应消息HelloReply，包含一个字符串字段message

2. 服务器端实现

在GreeterServer.java中，我们实现了gRPC服务器：


public class GreeterServer {  private static final Logger logger = Logger.getLogger(GreeterServer.class.getName());  private Server server;  private void start() throws IOException {    // 服务器监听端口50051    int port = 50051;    server = ServerBuilder.forPort(port)        .addService(new GreeterImpl())  // 添加服务实现        .build()        .start();    logger.info("Server started, listening on " + port);    // 添加JVM关闭钩子，确保服务器优雅关闭    Runtime.getRuntime().addShutdownHook(new Thread() {      @Override      public void run() {        System.err.println("*** shutting down gRPC server since JVM is shutting down");        try {          GreeterServer.this.stop();        } catch (InterruptedException e) {          e.printStackTrace(System.err);        }        System.err.println("*** server shut down");      }    });  }  // 服务实现类，继承自动生成的基类  static class GreeterImpl extends GreeterGrpc.GreeterImplBase {    @Override    public void sayHello(HelloRequest req, StreamObserver<HelloReply> responseObserver) {      // 构建响应消息      HelloReply reply = HelloReply.newBuilder().setMessage("Hello " + req.getName()).build();      // 发送响应      responseObserver.onNext(reply);      // 标记响应完成      responseObserver.onCompleted();    }    @Override    public void sayHelloAgain(HelloRequest req, StreamObserver<HelloReply> responseObserver) {      HelloReply reply = HelloReply.newBuilder().setMessage("Hello again " + req.getName()).build();      responseObserver.onNext(reply);      responseObserver.onCompleted();    }  }}

服务器实现的关键点：

使用ServerBuilder创建服务器，监听指定端口
通过addService()方法注册服务实现
实现服务接口时，需要处理StreamObserver来完成响应
添加JVM关闭钩子确保服务器优雅关闭

3. 客户端实现

在GreeterClient.java中，我们实现了gRPC客户端：


public class GreeterClient {  private final ManagedChannel channel;  private final GreeterGrpc.GreeterBlockingStub blockingStub;  // 构造客户端，连接到指定主机和端口  public GreeterClient(String host, int port) {    this(ManagedChannelBuilder.forAddress(host, port)        // 使用明文传输（生产环境应使用TLS）        .usePlaintext()        .build());  }  // 问候方法，调用服务器的两个RPC方法  public void greet(String name) {    logger.info("Will try to greet " + name + " ...");    HelloRequest request = HelloRequest.newBuilder().setName(name).build();    try {      // 调用SayHello方法      HelloReply response = blockingStub.sayHello(request);      logger.info("Greeting: " + response.getMessage());      // 调用SayHelloAgain方法      response = blockingStub.sayHelloAgain(request);      logger.info("Greeting again: " + response.getMessage());    } catch (StatusRuntimeException e) {      logger.log(Level.WARNING, "RPC failed: {0}", e.getStatus());    }  }}

客户端实现的关键点：

使用ManagedChannelBuilder创建到服务器的连接
通过GreeterGrpc.newBlockingStub()创建阻塞式存根
构建请求消息并调用RPC方法
处理可能的RPC异常

4. 演示应用程序

DemoApp.java是一个完整的演示应用程序，展示了如何同时运行服务器和客户端：


public class DemoApp {    public static void main(String[] args) {        System.out.println("=== Java gRPC Demo ===");        // 在单独线程中启动服务器        ExecutorService serverExecutor = Executors.newSingleThreadExecutor();        serverExecutor.submit(() -> {            try {                GreeterServer.main(new String[]{});            } catch (Exception e) {                System.err.println("Server error: " + e.getMessage());            }        });        // 给服务器启动时间        try {            Thread.sleep(2000);        } catch (InterruptedException e) {            Thread.currentThread().interrupt();        }        // 运行客户端测试        try {            GreeterClient client = new GreeterClient("localhost", 50051);            System.out.println("\n--- Testing with 'World' ---");            client.greet("World");            System.out.println("\n--- Testing with 'gRPC' ---");            client.greet("gRPC");            System.out.println("\n--- Testing with 'Java' ---");            client.greet("Java");            client.shutdown();        } catch (Exception e) {            System.err.println("Client error: " + e.getMessage());        }        // 关闭服务器        try {            System.out.println("\nShutting down server...");            serverExecutor.shutdownNow();            serverExecutor.awaitTermination(5, TimeUnit.SECONDS);            System.out.println("Demo completed successfully!");        } catch (InterruptedException e) {            Thread.currentThread().interrupt();            System.err.println("Shutdown interrupted");        }    }}