Java+gRPC+maven+idea构建并发布可执行Jar包

2024-01-01 18:42:40

使用 gRPC、Java、Maven 和 IntelliJ IDEA 构建和发布可执行 JAR 包

在分布式系统和微服务架构日益流行的时代，gRPC 作为一种高性能、高可靠的远程过程调用 (RPC) 框架，备受瞩目。本文将详细介绍使用 Java、gRPC、Maven 和 IntelliJ IDEA 构建和发布可执行 JAR 包的步骤，并提供示例代码，旨在帮助读者快速掌握 gRPC 框架的使用，实现服务端和客户端之间的通信。

环境搭建

首先，确保本地已安装 Java 环境和 Maven 工具。如果没有，请访问相应的官方网站进行下载和安装。此外，还需要安装 gRPC 工具。

项目创建

打开 IntelliJ IDEA，创建一个新的 Java 项目。在项目根目录下，创建一个名为 proto 的目录，用于存放 Protobuf 定义文件。创建一个名为 src/main/java 的目录，用于存放 Java 源代码。

定义 Protobuf 文件

在 proto 目录下，创建一个名为 helloworld.proto 的文件，用于定义服务端和客户端之间通信的数据结构和方法。Protobuf 是一种语言中立的序列化格式，用于定义数据结构，例如消息和枚举。

syntax = "proto3";

package helloworld;

// 定义一个名为 HelloRequest 的消息
message HelloRequest {
    string name = 1;
}

// 定义一个名为 HelloReply 的消息
message HelloReply {
    string message = 1;
}

// 定义一个名为 Greeter 的服务
service Greeter {
    // 定义一个名为 SayHello 的方法
    rpc SayHello (HelloRequest) returns (HelloReply);
}

生成 Java 源代码

在命令行中，进入 proto 目录，使用 gRPC 工具生成 Java 源代码。

protoc --java_out=../src/main/java --grpc-java_out=../src/main/java helloworld.proto

这将生成 HelloRequest、HelloReply 和 GreeterGrpc 等类，这些类用于在服务端和客户端之间发送和接收消息。

创建服务端

在 src/main/java 目录下，创建一个名为 GreeterServer.java 的文件，用于实现服务端。

import io.grpc.Server;
import io.grpc.ServerBuilder;
import io.grpc.stub.StreamObserver;

import java.io.IOException;

public class GreeterServer {

    private Server server;

    public static void main(String[] args) throws IOException, InterruptedException {
        GreeterServer greeterServer = new GreeterServer();
        greeterServer.start();
        greeterServer.awaitTermination();
    }

    private void start() throws IOException {
        server = ServerBuilder.forPort(50051)
                .addService(new GreeterImpl())
                .build()
                .start();
        System.out.println("Server started on port 50051");
    }

    private void awaitTermination() throws InterruptedException {
        server.awaitTermination();
    }

    private static class GreeterImpl extends GreeterGrpc.GreeterImplBase {

        @Override
        public void sayHello(HelloRequest request, StreamObserver<HelloReply> responseObserver) {
            String message = "Hello " + request.getName();
            HelloReply reply = HelloReply.newBuilder().setMessage(message).build();
            responseObserver.onNext(reply);
            responseObserver.onCompleted();
        }
    }
}

此类实现了 GreeterGrpc.GreeterImplBase，并提供了 sayHello 方法的实现。

创建客户端

在 src/main/java 目录下，创建一个名为 GreeterClient.java 的文件，用于实现客户端。

import io.grpc.ManagedChannel;
import io.grpc.ManagedChannelBuilder;
import io.grpc.StatusRuntimeException;
import io.grpc.stub.StreamObserver;

import java.util.concurrent.TimeUnit;

public class GreeterClient {

    private final ManagedChannel channel;
    private final GreeterGrpc.GreeterBlockingStub blockingStub;
    private final GreeterGrpc.GreeterStub asyncStub;

    public GreeterClient() {
        channel = ManagedChannelBuilder.forAddress("localhost", 50051)
                .usePlaintext()
                .build();
        blockingStub = GreeterGrpc.newBlockingStub(channel);
        asyncStub = GreeterGrpc.newStub(channel);
    }

    public void shutdown() throws InterruptedException {
        channel.shutdown().awaitTermination(5, TimeUnit.SECONDS);
    }

    public String sayHello(String name) {
        HelloRequest request = HelloRequest.newBuilder().setName(name).build();
        HelloReply response = blockingStub.sayHello(request);
        return response.getMessage();
    }

    public void sayHelloAsync(String name, StreamObserver<HelloReply> responseObserver) {
        HelloRequest request = HelloRequest.newBuilder().setName(name).build();
        asyncStub.sayHello(request, responseObserver);
    }

    public static void main(String[] args) {
        GreeterClient client = new GreeterClient();
        String message = client.sayHello("World");
        System.out.println(message);
        client.shutdown();
    }
}