Grpc Series II Определение и реализация 4 методов обслуживания Grpc

gRPC

1 Обзор

1.1 Определение услуги

Как и другие службы RPC, GPRC основан на определении службы. Служба определяет имя, входящие параметры и возвращаемые параметры метода удаленного вызова. GRPC по умолчанию использует Protobuf для описания служб. Информацию о protobuf см. в этом блоге.Первая демонстрация Java для Protobuf3

GRPC определяет в общей сложности 4 метода обслуживания:

  1. Унарные RPC (Унарные RPC): это самое простое определение, клиент отправляет запрос, а сервер возвращает результат.
  2. Серверные потоковые RPC (серверные потоковые RPC): клиент отправляет запрос, сервер возвращает поток клиенту, и клиент читает серию сообщений из потока до тех пор, пока все
  3. Клиентские потоковые RPC (клиентские потоковые RPC): клиент отправляет серию сообщений на сервер через поток, а затем ждет, пока сервер прочитает данные и вернет результат обработки.

  4. Двунаправленные потоковые RPC (двунаправленные потоковые RPC): и клиент, и сервер могут независимо отправлять или получать серию сообщений друг другу. Порядок, в котором клиент и сервер считываются и записываются, произвольный.

    Вышеупомянутые сервисные методы определены в файле proto следующим образом:

syntax = "proto3";

option java_multiple_files = true;
option java_package = "com.hry.spring.grpc.mystream";
option java_outer_classname = "HelloStreamEntity";

service HelloStream {
  // A Unary RPC.
  rpc simpleRpc(Simple) returns (SimpleFeature) {}

  // A server-to-client streaming RPC.
  rpc server2ClientRpc(SimpleList) returns (stream SimpleFeature) {}

  // A client-to-server streaming RPC.
  rpc client2ServerRpc(stream Simple) returns (SimpleSummary) {}

  // A Bidirectional streaming RPC.
  rpc bindirectionalStreamRpc(stream Simple) returns (stream Simple) {}
}


message Simple {
  int32 num = 1;
  string name = 2;
}

message SimpleList {
  repeated Simple simpleList = 1;
}

message SimpleFeature {
  string name = 1;
  Simple location = 2;
}

message SimpleSummary {
  int32 feature_count = 2;
}

// 测试类
message SimpleFeatureDatabase {
  repeated SimpleFeature feature = 1;
}

1.2 Синхронный RPC и асинхронный RPC

GRPC поддерживает как синхронный RPC, так и асинхронный RPC. Методы службы синхронных вызовов RPC поддерживают только потоковые RPC (серверные потоковые RPC) и унарные RPC (унарные RPC). Метод службы асинхронных вызовов RPC поддерживает 4 метода.

1.3 Генерация базового кода ###

для справкиПервый пример приветствия, серия GrpcСоздайте базовый класс protobuf и HelloStreamGrpc, см. подробностиэтот код

2. Протестируйте код

Реализуйте серверный и клиентский код здесь

2.1 Сервер

Реализация класса сервера реализована путем наследования HelloStreamGrpc.HelloStreamImplBase.Конкретная реализация интерфейса службы выглядит следующим образом:

/**
     * 服务端类的实现
     *
     */
    private static class HelloStreamService extends HelloStreamGrpc.HelloStreamImplBase {
        private final List<SimpleFeature> features;

        public HelloStreamService(List<SimpleFeature> features) {
            this.features = features;
        }
    ...
  • Реализация сервера Unary RPC (Унарные RPC):
        @Override
        public void simpleRpc(Simple request, StreamObserver<SimpleFeature> responseObserver) {
            SimpleFeature rtn = SimpleFeature.newBuilder().setName(request.getName() + "simpleRpc").setLocation(request)
                    .build();
            logger.info("recevier simpleRpc ： {}", request);
            responseObserver.onNext(rtn);
            responseObserver.onCompleted();
        }
  • Реализация серверных потоковых RPC (Server streaming RPC):
        @Override
        public void server2ClientRpc(SimpleList request, StreamObserver<SimpleFeature> responseObserver) {
            logger.info("recevier server2ClientRpc ： {}", request);
            for (SimpleFeature feature : this.features) {
                Simple simpleLocation = feature.getLocation();
                for (Simple o : request.getSimpleListList()) {
                    if (o.getNum() == simpleLocation.getNum()) {
                        // 推送记录
                        responseObserver.onNext(feature);
                    }
                }
            }
            responseObserver.onCompleted();
        }
  • Реализация сервера Client Streaming RPC (Client Streaming RPC):
/**
         * 接收完所有的请求后，才返回一个对象
         */
        @Override
        public StreamObserver<Simple> client2ServerRpc(StreamObserver<SimpleSummary> responseObserver) {

            return new StreamObserver<Simple>() {
                int feature_count = 0;

                @Override
                public void onNext(Simple value) {
                    // 接收请求
                    logger.info("num={}, client2ServerRpc, content={} ", feature_count, value);
                    feature_count++;
                }

                @Override
                public void onError(Throwable t) {
                    logger.error("Simple cancelled, e={}", t);
                }

                @Override
                public void onCompleted() {
                    logger.info("onCompleted");
                    // 接收所有请求后，返回总数
                    SimpleSummary summary = SimpleSummary.newBuilder().setFeatureCount(feature_count).build();
                    responseObserver.onNext(summary);
                    // 结束请求
                    responseObserver.onCompleted();
                }
            };
        }
  • Реализация сервера двунаправленных потоковых RPC (двунаправленных потоковых RPC):
        /**
         * 每接收一个请求，立即返回一个对象
         */
        @Override
        public StreamObserver<Simple> bindirectionalStreamRpc(StreamObserver<Simple> responseObserver) {
            return new StreamObserver<Simple>() {
                @Override
                public void onNext(Simple value) {
                    logger.info("bindirectionalStreamRpc receive {}", value);
                    for (SimpleFeature feature : features) {
                        Simple simpleLocation = feature.getLocation();
                        if (value.getNum() == simpleLocation.getNum()) {
                            // 接收请求后，马上推送记录
                            Simple rtn = Simple.newBuilder().setName(feature.getName() + "rtn")
                                    .setNum(feature.getLocation().getNum()).build();
                            responseObserver.onNext(rtn);
                        }
                    }
                }

                @Override
                public void onError(Throwable t) {
                    logger.error("bindirectionalStreamRpc cancelled, e={}", t);
                }

                @Override
                public void onCompleted() {
                    responseObserver.onCompleted();
                }
            };
        }

Запустите основной метод сервера:

    private static final Logger logger = LoggerFactory.getLogger(HelloStreamServer.class);

    private final int port;
    private final Server server;

    public HelloStreamServer(int port) throws IOException {
        this.port = port;
        this.server = ServerBuilder.forPort(port).addService(new HelloStreamService(HelloUtil.parseFeatures())).build();
    }

    // 启动服务
    public void start() throws IOException {
        server.start();
        logger.info("Server started, listening on " + port);
        Runtime.getRuntime().addShutdownHook(new Thread() {
            @Override
            public void run() {
                System.err.println("*** shutting down gRPC server since JVM is shutting down");
                HelloStreamServer.this.stop();
                System.err.println("*** server shut down");
            }
        });
    }

    // 启动服务
    public void stop() {
        if (server != null) {
            server.shutdown();
        }
    }

    /**
     * Await termination on the main thread since the grpc library uses daemon
     * threads.
     */
    private void blockUntilShutdown() throws InterruptedException {
        if (server != null) {
            server.awaitTermination();
        }
    }

    public static void main(String[] args) throws Exception {
        java.util.logging.Logger.getGlobal().setLevel(java.util.logging.Level.OFF);
        HelloStreamServer server = new HelloStreamServer(8980);
        server.start();
        server.blockUntilShutdown();
    }

2.2 Клиент

Код реализации клиента: создайте класс-заглушку клиента
HelloStreamBlockingStub blockingStub: блокирует клиент, поддерживает простую унарную службу и службу вызова потокового вывода.
HelloStreamStub asyncStub: асинхронный клиент, поддерживает все типы вызовов

public class HelloStreamClient {
    private static final Logger logger = LoggerFactory.getLogger(HelloStreamClient.class);

    private final ManagedChannel channel;
    private final HelloStreamBlockingStub blockingStub;
    private final HelloStreamStub asyncStub;

    private Random random = new Random();

    public HelloStreamClient(String host, int port) {
        ManagedChannelBuilder<?> channelBuilder = ManagedChannelBuilder.forAddress(host, port).usePlaintext(true);
        channel = channelBuilder.build();
        // 创建一个阻塞客户端，支持简单一元服务和流输出调用服务
        blockingStub = HelloStreamGrpc.newBlockingStub(channel);
        // 创建一个异步客户端，支持所有类型调用
        asyncStub = HelloStreamGrpc.newStub(channel);
    }

    public void shutdown() throws InterruptedException {
        channel.shutdown().awaitTermination(5, TimeUnit.SECONDS);
    }
    ......
    // 创建Simple对象
    private Simple newSimple(int num) {
        return Simple.newBuilder().setName("simple" + num).setNum(num).build();
    }

}
  • Реализация клиента Unary RPC (Унарные RPC):
    /**
     * 一元服务调用
     */
    public void simpleRpc(int num) {
        logger.info("request simpleRpc: num={}", num);
        Simple simple = Simple.newBuilder().setName("simpleRpc").setNum(num).build();
        SimpleFeature feature;
        try {
            feature = blockingStub.simpleRpc(simple);
        } catch (StatusRuntimeException e) {
            logger.info("RPC failed: {0}", e.getStatus());
            return;
        }
        logger.info("simpleRpc end called {}", feature);
    }
  • Клиентская реализация Server Streaming RPC (Server Streaming RPC):
    /**
     * 阻塞服务器流
     */
    public void server2ClientRpc(int num1, int num2) {
        logger.info("request server2ClientRpc num1={}, num2={}", num1, num2);
        Simple simple = Simple.newBuilder().setName("simple" + num1).setNum(num1).build();
        Simple simple2 = Simple.newBuilder().setName("simple" + num2).setNum(num2).build();

        SimpleList simpleList = SimpleList.newBuilder().addSimpleList(simple).addSimpleList(simple2).build();
        Iterator<SimpleFeature> simpleFeatureIter = blockingStub.server2ClientRpc(simpleList);
        for (int i = 1; simpleFeatureIter.hasNext(); i++) {
            SimpleFeature feature = simpleFeatureIter.next();
            logger.info("Result {} : {}", i, feature);
        }
    }
  • Реализация клиента Client Streaming RPC (Client Streaming RPC):
    /**
     * 异步客户端流
     * 
     */
    public void client2ServerRpc(int count) throws InterruptedException {
        logger.info("request client2ServerRpc {}", count);
        final CountDownLatch finishLatch = new CountDownLatch(1);

        StreamObserver<SimpleSummary> responseObserver = new StreamObserver<SimpleSummary>() {
            @Override
            public void onNext(SimpleSummary value) {
                // 返回SimpleSummary
                logger.info("client2ServerRpc onNext : {}", value);
            }

            @Override
            public void onError(Throwable t) {
                logger.error("client2ServerRpc error : {}", t);
                finishLatch.countDown();
            }

            @Override
            public void onCompleted() {
                logger.error("client2ServerRpc finish");
                finishLatch.countDown();
            }
        };
        StreamObserver<Simple> requestObserver = asyncStub.client2ServerRpc(responseObserver);
        try {
            for (int i = 0; i < count; i++) {
                logger.info("simple : {}", i);
                Simple simple = Simple.newBuilder().setName("client2ServerRpc" + i).setNum(i).build();
                requestObserver.onNext(simple);
                Thread.sleep(random.nextInt(200) + 50);
            }
        } catch (RuntimeException e) {
            // Cancel RPC
            requestObserver.onError(e);
            throw e;
        }
        // 结束请求
        requestObserver.onCompleted();

        // Receiving happens asynchronously
        if (!finishLatch.await(1, TimeUnit.MINUTES)) {
            logger.error("client2ServerRpc can not finish within 1 minutes");
        }
    }
  • Клиентская реализация двунаправленных потоковых RPC (двунаправленных потоковых RPC):
    /**
     * 双向流
     * 
     * @throws InterruptedException
     */
    public void bindirectionalStreamRpc() throws InterruptedException {
        logger.info("request bindirectionalStreamRpc");
        final CountDownLatch finishLatch = new CountDownLatch(1);
        StreamObserver<Simple> requestObserver = asyncStub.bindirectionalStreamRpc(new StreamObserver<Simple>() {

            @Override
            public void onNext(Simple value) {
                logger.info("bindirectionalStreamRpc receive message : {}", value);
            }

            @Override
            public void onError(Throwable t) {
                logger.error("bindirectionalStreamRpc Failed: {0}", Status.fromThrowable(t));
                finishLatch.countDown();
            }

            @Override
            public void onCompleted() {
                logger.info("Finished bindirectionalStreamRpc");
                finishLatch.countDown();
            }
        });

        try {
            Simple[] requests = { newSimple(1), newSimple(2), newSimple(3), newSimple(4) };

            for (Simple request : requests) {
                logger.info("Sending message {}", request);
                requestObserver.onNext(request);
            }
        } catch (RuntimeException e) {
            // Cancel RPC
            requestObserver.onError(e);
            throw e;
        }
        requestObserver.onCompleted();

        if (!finishLatch.await(1, TimeUnit.MINUTES)) {
            logger.error("routeChat can not finish within 1 minutes");
        }
    }

запустить клиент

    public static void main(String[] args) throws InterruptedException {
        HelloStreamClient client = new HelloStreamClient("localhost", 8980);
        try {
            // simple rpc
            client.simpleRpc(1);

            // server2ClientRpc
            client.server2ClientRpc(1, 2);

            // client2ServerRpc
            client.client2ServerRpc(2);

            // bindirectionalStreamRpc
            client.bindirectionalStreamRpc();

        } finally {
            client.shutdown();
        }
    }

3. Код

Подробный код смотрите здесьGithub

Категории