Square/Wire项目中的gRPC支持详解-优快云博客

Square/Wire项目中的gRPC支持详解

wire gRPC and protocol buffers for Android, Kotlin, Swift and Java. 项目地址: https://gitcode.com/gh_mirrors/wir/wire

概述

Square/Wire是一个强大的Protocol Buffers实现，特别针对Kotlin和Java平台进行了优化。在gRPC支持方面，Wire提供了完整的解决方案，能够根据protobuf服务定义生成客户端和服务端接口代码。本文将深入解析Wire对gRPC的支持特性，包括配置方式、代码生成模式以及实际应用场景。

基本配置

Wire通过Gradle插件提供灵活的gRPC代码生成配置。在构建脚本中，我们可以针对Kotlin目标进行详细设置：

wire {
  kotlin {
    // 定义生成代码的角色：client或server
    rpcRole = 'server'
    // 仅服务端有效：定义调用风格
    rpcCallStyle = 'suspending'
    // 是否为每个RPC方法生成独立接口
    singleMethodServices = false
  }
}

这些配置项决定了生成的代码结构和风格，开发者可以根据实际需求灵活组合。

服务定义示例

为了更好地理解Wire的gRPC支持，我们以一个典型的RouteGuide服务为例：

service RouteGuide {
  // 简单RPC
  rpc GetFeature(Point) returns (Feature) {}
  
  // 服务端流式RPC
  rpc ListFeatures(Rectangle) returns (stream Feature) {}
  
  // 客户端流式RPC
  rpc RecordRoute(stream Point) returns (RouteSummary) {}
  
  // 双向流式RPC
  rpc RouteChat(stream RouteNote) returns (stream RouteNote) {}
}

客户端代码生成

当配置为客户端角色时(rpcRole = 'client')，Wire会生成如下接口：

interface RouteGuideClient : Service {
  fun GetFeature(): GrpcCall<Point, Feature>
  fun ListFeatures(): GrpcStreamingCall<Rectangle, Feature>
  fun RecordRoute(): GrpcStreamingCall<Point, RouteSummary>
  fun RouteChat(): GrpcStreamingCall<RouteNote, RouteNote>
}

Wire会根据RPC类型自动选择适当的返回类型：

普通RPC返回GrpcCall
流式RPC返回GrpcStreamingCall

客户端运行时

Wire提供了一个轻量级的gRPC客户端运行时：

val grpcClient = GrpcClient.Builder()
  .client(OkHttpClient.Builder().protocols(listOf(Protocol.H2_PRIOR_KNOWLEDGE)).build())
  .baseUrl(serverUrl)
  .build()
val routeGuideClient = grpcClient.create(RouteGuideClient::class)

这个运行时简化了客户端的创建和使用过程，开发者可以专注于业务逻辑的实现。

服务端代码生成

Wire支持两种服务端代码风格：阻塞式和协程式。

阻塞式API

配置为阻塞式风格时(rpcCallStyle = 'blocking')，生成的接口如下：

interface RouteGuideBlockingServer : Service {
  fun GetFeature(request: Point): Feature
  fun ListFeatures(request: Rectangle, response: MessageSink<Feature>)
  fun RecordRoute(request: MessageSource<Point>): RouteSummary
  fun RouteChat(request: MessageSource<RouteNote>, response: MessageSink<RouteNote>)
}

Wire提供了MessageSource和MessageSink来处理流式数据，这些API适合传统的阻塞式编程模型。

协程式API

配置为协程式风格时(rpcCallStyle = 'suspending')，生成的接口如下：

interface RouteGuideServer : Service {
  suspend fun GetFeature(request: Point): Feature
  fun ListFeatures(request: Rectangle, response: SendChannel<Feature>)
  fun RecordRoute(request: ReceiveChannel<Point>): RouteSummary
  fun RouteChat(request: ReceiveChannel<RouteNote>, response: SendChannel<RouteNote>)
}

这种风格充分利用了Kotlin协程的优势，使用SendChannel和ReceiveChannel处理流式数据，适合现代异步编程。

客户端接口实现

Wire提供了便捷的方式来创建客户端接口实现，特别适合测试场景：

Kotlin实现

class FakeRouteGuideClient : RouteGuideClient {
  override fun GetFeature() = GrpcCall { request ->
    Feature(name = "test", location = request)
  }

  override fun RouteChat() = GrpcStreamingCall { requests, responses ->
    try {
      requests.consumeEach { routeNote ->
        responses.send(RouteNote(message = "ACK: ${routeNote.message}"))
      }
    } finally {
      responses.close()
    }
  }
}

Java实现

public class FakeRouteGuideClient implements RouteGuideClient {
  @Override public GrpcCall<Point, Feature> GetFeature() {
    return GrpcCalls.grpcCall(request -> 
      new Feature.Builder()
        .name("test")
        .location(request)
        .build()
    );
  }
}

依赖配置

要使用Wire的gRPC功能，需要在项目中添加以下依赖：

implementation("com.squareup.wire:wire-runtime:LATEST_VERSION")
implementation("com.squareup.wire:wire-grpc-client:LATEST_VERSION")

服务端模块变更

Wire 5之后，gRPC服务端相关功能已迁移到独立项目中。迁移时需要注意：

更新依赖坐标：

-com.squareup.wire:wire-grpc-server:<wire-version>
+com.squareup.wiregrpcserver:server:<new-repo-version>

添加生成器依赖：

classpath("com.squareup.wiregrpcserver:server-generator:<new-repo-version>")

配置方式变更：

wire {
  custom {
    schemaHandlerFactory = com.squareup.wire.kotlin.grpcserver.GrpcServerSchemaHandler.Factory()
    options = mapOf(
      "singleMethodServices" to "false",
      "rpcCallStyle" to "suspending"
    )
    exclusive = false
  }
  kotlin {
    rpcRole = "server"
    // 其他配置...
  }
}