2020-02-06 gRPC从入门到破产(1)最简单的HelloWorld

用惯了Spring全家桶,偶尔也尝试一下小清新的gRPC吧
为啥叫“从入门到破产”呢?因为中文输入法打“gRPC”出来的第一个就是“个人破产”,咱也总不能干啥都“从入门到入土”,“从入门到放弃”吧,偶尔也来点别的,哈哈。

本文已经与(2)整合后发在了我的个人网站,欢迎访问:http://www.wendev.site/article/25

一些废话

做完个人网站之后就一直处于非常颓废的状态,而最近总算找到要学的新东西了——gRPC

为什么要学gRPC?还不是因为闲得都要发霉了,急需补充新知识啊,而且我一直觉得gRPC比Dubbo“小清新”多了,非常想找个机会一探究竟。

其实是最近要做一个比较大的项目,涉及到Python和Java混编的问题,为了解决这个问题,所以需要一个可以跨语言的RPC框架。本来想用性能更高的Thrift,但是这东西的参考资料实在太少了,所以选择了资料更多的gRPC。而且gRPC是Google开发的,大厂出品值得信赖啊。

Refrence

  • OSChina翻译的gRPC中文文档
  • grpc-java github仓库

开始!

pom.xml

建一个Maven工程,并且引入以下依赖和插件:



    4.0.0

    site.wendev
    grpc-helloworld
    1.0-SNAPSHOT

    
        
        
            io.grpc
            grpc-all
            1.27.0
        

        
        
            javax.annotation
            javax.annotation-api
            1.3.2
        
    

    
        
            
                
                kr.motd.maven
                os-maven-plugin
                1.6.2
            
        
        
            
                org.xolstice.maven.plugins
                protobuf-maven-plugin
                0.6.1
                
                    com.google.protobuf:protoc:3.11.3:exe:${os.detected.classifier}
                    grpc-java
                    io.grpc:protoc-gen-grpc-java:1.27.0:exe:${os.detected.classifier}
                    /Users/jiangwen/tools/protoc-3.11.3/bin/protoc
                
                
                    
                        
                            compile
                            compile-custom
                        
                    
                
            
        
    

不需要Spring Initializr了,莫名感觉非常爽

proto文件的编写与代码生成

gRPC使用HTTP2作为通信协议,使用Google开源的protobuf作为序列化和反序列化协议,所以需要编写.proto文件,定义服务和其他相关信息:

hello_world.proto

syntax = "proto3";

option java_package = "site.wendev.grpc";
option java_outer_classname = "HelloWorldProto";

package helloworld;

service HelloWorld {
    rpc SayHello (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
    string name = 1;
}

message HelloReply {
    string message = 1;
}

简单来说,这段代码定义了一个发送一条信息的服务,并且定义了请求信息——包含name参数和响应信息——包含message参数。

然后使用Maven插件生成代码:

这两个插件都需要使用。

生成的文件如下,这两个文件里包含了我们需要的一些东西:

接着把它们放到项目里,就可以使用了:

服务端与客户端

这个因为太复杂,就照搬官方github仓库里的了。因为我的类名与官方的不一样,所以稍微改了改:

服务端(HelloWorldServer.java):

package site.wendev.grpc;

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

import java.io.IOException;
import java.util.logging.Logger;

public class HelloWorldServer {
    public static final Logger logger = Logger.getLogger(HelloWorldServer.class.getName());
    private Server server;

    private void start() throws IOException {
        int port = 50051;
        server = ServerBuilder.forPort(port)
                .addService(new GreeterImpl())
                .build()
                .start();
        logger.info("Server started, listening on " + port);
        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
            System.err.println("*** shutting down gRPC server since JVM is shutting down");
            HelloWorldServer.this.stop();
            System.err.println("*** server shut down");
        }));
    }

    private void stop() {
        if (server != null) {
            server.shutdown();
        }
    }

    private void blockUntilShutdown() throws InterruptedException {
        if (server != null) {
            server.awaitTermination();
        }
    }

    public static void main(String[] args) throws IOException, InterruptedException {
        final HelloWorldServer server = new HelloWorldServer();
        server.start();
        server.blockUntilShutdown();
    }

    static class GreeterImpl extends HelloWorldGrpc.HelloWorldImplBase {

        @Override
        public void sayHello(HelloWorldProto.HelloRequest req, StreamObserver responseObserver) {
            HelloWorldProto.HelloReply reply = HelloWorldProto.HelloReply.newBuilder().setMessage("Hello " + req.getName()).build();
            responseObserver.onNext(reply);
            responseObserver.onCompleted();
        }
    }
}

客户端(HelloWorldClient.java):

package site.wendev.grpc;

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

import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;

public class HelloWorldClient {
    private static final Logger logger = Logger.getLogger(HelloWorldClient.class.getName());

    private final ManagedChannel channel;
    private final HelloWorldGrpc.HelloWorldBlockingStub blockingStub;

    public HelloWorldClient(String host, int port) {
        this(ManagedChannelBuilder.forAddress(host, port)
                .usePlaintext()
                .build());
    }

    HelloWorldClient(ManagedChannel channel) {
        this.channel = channel;
        blockingStub = HelloWorldGrpc.newBlockingStub(channel);
    }

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

    public void greet(String name) {
        logger.info("client request ==============" + name + " ...");
        HelloWorldProto.HelloRequest request = HelloWorldProto.HelloRequest.newBuilder().setName(name).build();
        HelloWorldProto.HelloReply response;
        try {
            response = blockingStub.sayHello(request);
        } catch (StatusRuntimeException e) {
            logger.log(Level.WARNING, "RPC failed: {0}", e.getStatus());
            return;
        }
        logger.info("response: ===============" + response.getMessage());
    }

    public static void main(String[] args) throws Exception {
        HelloWorldClient client = new HelloWorldClient("localhost", 50051);
        try {
            String user = "world===============";
            if (args.length > 0) {
                user = args[0];
            }
            client.greet(user);
        } finally {
            client.shutdown();
        }
    }
}

运行

与Spring Cloud一样,需要先启动服务端(服务提供者),再启动客户端(服务消费者)。

启动服务端:

启动客户端:

客户端在启动时会向服务端发送请求(这个请求在greet方法里定义了),而客户端得到响应后,就立刻关闭了。

踩坑记录

这次的两个坑都是缺依赖,没有其他的什么坑。

坑1:使用Maven插件生成代码失败

在生成客户端的代码时,报了这么一个错误:

Could not transfer artifact io.grpc:protoc-gen-grpc-java:exe:${os.detected.classifier}:1.27.0 from/to alimaven (http://maven.aliyun.com/nexus/content/groups/public/): TransferFailedException

多番排查无果后,发现是缺了一个依赖(在build节点下):

        
            
                
                kr.motd.maven
                os-maven-plugin
                1.6.2
            
        

加上这个依赖,就可以成功生成了。

坑2:Error:(23, 18) java: 找不到符号 符号: 类 Generated 位置: 程序包javax.annotation.Generated

这个错误发生在自动生成的代码中。

查了一下,这个其实也是缺少依赖导致的,加上它就好了:


        
            javax.annotation
            javax.annotation-api
            1.3.2
        

你可能感兴趣的:(2020-02-06 gRPC从入门到破产(1)最简单的HelloWorld)