Java 開發 gRPC 服務和客戶端


一、gRPC 簡介

gRPC 是Go實現的:一個高性能,開源,將移動和HTTP/2放在首位通用的RPC框架。使用gRPC可以在客戶端調用不同機器上的服務端的方法,而客戶端和服務端的開發語言和

運行環境可以有很多種,基本涵蓋了主流語言和平台。雙方交互的協議可以在proto文件中定義,客戶端和服務端可以很方便的通過工具生成協議和代理代碼。而消息的編碼是采

google protocol buffer,數據量小、速度快。

gRPC具有以下特點:

(1)基於 HTTP/2, 繼而提供了連接多路復用、Body 和 Header 壓縮等機制。可以節省帶寬、降低TCP鏈接次數、節省CPU使用和延長電池壽命等。

(2)支持主流開發語言(C, C++, Python, PHP, Ruby, NodeJS, C#, Objective-C、Golang、Java)

(3)IDL (Interface Definition Language) 層使用了 Protocol Buffers, 非常適合團隊的接口設計

下面我們就通過一個java的例子來看看怎么使用gRPC。

二、配置pom文件,導入gRPC的依賴和插件

新的工程創建出來之后,我們就可以先配置基礎的maven相關的配置了,這里我們可以抄襲下官網的相關配置:

<properties>
  <grpc.version>1.4.0</grpc.version><!-- CURRENT_GRPC_VERSION -->
</properties>
<dependencies>
  <dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-netty</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>
  <dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-testing</artifactId>
    <version>${grpc.version}</version>
    <scope>test</scope>
  </dependency>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.11</version>
    <scope>test</scope>
  </dependency>
  <dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-core</artifactId>
    <version>1.9.5</version>
    <scope>test</scope>
  </dependency>
</dependencies>
<build>
  <extensions>
    <extension>
      <groupId>kr.motd.maven</groupId>
      <artifactId>os-maven-plugin</artifactId>
      <version>1.4.1.Final</version>
    </extension>
  </extensions>
  <plugins>
    <plugin>
      <groupId>org.xolstice.maven.plugins</groupId>
      <artifactId>protobuf-maven-plugin</artifactId>
      <version>0.5.0</version>
      <configuration>
        <protocArtifact>com.google.protobuf:protoc:3.3.0:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
       </configuration>
      <executions>
        <execution>
          <goals>
            <goal>compile</goal>
            <goal>compile-custom</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

三、編寫 proto 文件,並編譯產生對應的 java文件

簡單起見,這里直接用的 helloworld.proto 文件,內容如下:

syntax = "proto3";

option java_multiple_files = true; 
option java_package = "io.grpc.examples.helloworld"; 
option java_outer_classname = "HelloWorldProto"; 
option objc_class_prefix = "HLW";

package helloworld;

// The greeting service definition. 
service Greeter { 
  // Sends a greeting 
  rpc SayHello (HelloRequest) returns (HelloReply) {} 
}

// The request message containing the user's name. 
message HelloRequest { 
  string name = 1; 
}

// The response message containing the greetings 
message HelloReply { 
  string message = 1; 

這里注意下:如果客戶端和服務端使用的語言不同,例如客戶端使用Java,服務端是C++,務必保持 proto文件完全一致。

之后我們參看官網給的教程進行編寫服務端以及客戶端的信息情況,在寫好proto之后進行mvn install一下就會在target文件夾的相應目錄下創建出了默認的類

此時,我們只需要將這些類復制到我們java代碼的目錄中去,並開發服務端和客戶端即可。

四、服務端開發

服務端代碼如下,運行這個類的 main 方法,就可以在 50051 端口啟動服務。

public class HelloWorldServer {

    private static final Logger logger = Logger.getLogger(HelloWorldServer.class.getName());


    private int port = 50051; 
    private Server server;

    private void start() throws IOException{ 
        server = ServerBuilder.forPort(port) 
                .addService(new GreeterImpl()) 
                .build() 
                .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"); 
                HelloWorldServer.this.stop(); 
                System.err.println("*** server shut down"); 
            } 
        }); 
    }

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

    // block 一直到退出程序 
    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(); 
    }


    // 實現 定義一個實現服務接口的類 
    private class GreeterImpl extends GreeterGrpc.AbstractGreeter {

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

五、客戶端開發

public class HelloWorldClient {

    private final ManagedChannel channel; 
    private final GreeterGrpc.GreeterBlockingStub blockingStub; 
    private static final Logger logger = Logger.getLogger(HelloWorldClient.class.getName());

    public HelloWorldClient(String host,int port){ 
        channel = ManagedChannelBuilder.forAddress(host,port) 
                .usePlaintext(true) 
                .build();

        blockingStub = GreeterGrpc.newBlockingStub(channel); 
    }


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

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

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

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM