快速入门

先决条件

• Kotlin 1.3 或更高版本

• JDK 7 或更高版本

• Android SDK，API 级别 16 或更高

  1. 安装 Android Studio 或 Android 命令行工具。

  2. 通过设置以下环境变量，让其他工具和脚本知道您的 Android SDK 位置

     export ANDROID_SDK_ROOT="<path-to-your-android-sdk>"
     

• 一台已设置 USB 调试 的 Android 设备或一个 Android 虚拟设备

获取示例代码

示例代码是 grpc-kotlin 代码库的一部分。

1. 将代码库下载为 zip 文件 并解压，或克隆代码库

   git clone https://github.com/grpc/grpc-kotlin
   

2. 切换到 examples 目录

   cd grpc-kotlin/examples
   

运行示例

1. 编译服务器

   ./gradlew installDist
   

2. 运行服务器

   ./server/build/install/server/bin/hello-world-server
   Server started, listening on 50051
   

3. 在另一个终端中，构建客户端并将其安装到您的设备上

   ./gradlew :android:installDebug
   

4. 从您的设备启动客户端应用。

5. 在名称框中输入“Alice”，然后点击发送。您将看到以下响应

   Hello Alice
   

恭喜您！您刚刚运行了一个使用 gRPC 的客户端-服务器应用。

更新 gRPC 服务

在本节中，您将通过添加一个额外的服务器方法来更新应用。gRPC 服务使用 protocol buffers 定义。要了解如何在 .proto 文件中定义服务，请参阅基础教程。现在，您需要知道的是，服务器和客户端 stub 都有一个 SayHello() RPC 方法，该方法接受来自客户端的 HelloRequest 参数并返回服务器的 HelloReply，并且该方法的定义如下所示：

// 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;
}

打开 protos/src/main/proto/io/grpc/examples 文件夹中的 helloworld/hello_world.proto，并添加一个新的 SayHelloAgain() 方法，该方法使用相同的请求和响应类型：

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  // Sends another greeting
  rpc SayHelloAgain (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;
}

记得保存文件！

更新应用

当您构建示例时，构建过程会重新生成 HelloWorldProtoGrpcKt.kt，其中包含生成的 gRPC 客户端和服务器类。这也会重新生成用于填充、序列化和检索我们的请求和响应类型的类。

但是，您仍然需要在示例应用的手写部分中实现和调用新方法。

更新服务器

按照 Kotlin 快速入门页面的更新服务器中给出的说明操作。

更新客户端

按照以下步骤操作

1. 打开 client/src/main/kotlin/io/grpc/examples 文件夹中的 helloworld/MainActivity.kt。

2. 找到包含对 sayHello() 调用的函数。您将看到以下代码行：

   val response = greeter.sayHello(request)
   responseText.text = response.message
   

3. 添加对 sayHelloAgain() 的调用，并更改响应消息的创建方式。将上面的代码行替换为以下内容：

   val response = greeter.sayHello(request)
   val againResponse = greeter.sayHelloAgain(request)
   val message = "${response.message}\n${againResponse.message}"
   responseText.text = message
   

运行更新后的应用

像之前一样运行客户端和服务器。在 examples 目录中执行以下命令：

1. 编译服务器

   ./gradlew installDist
   

2. 运行服务器

   ./server/build/install/server/bin/hello-world-server
   Server started, listening on 50051
   

3. 在另一个终端中，构建客户端并将其安装到您的设备上

   ./gradlew :android:installDebug
   

4. 从您的设备启动客户端应用。

5. 在消息框中输入“Alice”，然后点击发送。您将看到以下响应

   Hello Alice
   Hello again Alice
   

下一步

• 了解 gRPC 如何在gRPC 简介和核心概念中工作。
• 完成 Kotlin/JVM 的基础教程。
• 查阅API 参考。