AndroidでgRPCクライアント

AndroidでgRPCクライアントの実装をしようと思ってチュートリアル読んだけど、すっと分からなかったのでメモ。まずは、Goで簡単なgRPCサーバーとクライアントを実装、その後クライアントをAndrodアプリとして実装する、というのをやってみました。

実装してみたソースコードはここです↓

github.com

gRPCがどんなものなのか触る

まず、Goで実装してみる。以下の記事が進めやすかったです、ありがとうございます。

zenn.dev

この記事の通りに進める。

• protoファイルでクライアント・サーバー間のインタフェースを定義する
• protocコマンドでprotoファイルからクライアントとサーバーの通信部分についてコード自動生成する
• 自動生成したコードを利用するサーバーとクライアントを実装し動かして雰囲気を掴む

クライアントをAndroidアプリで実装する

上記のGoで実装したクライアントはCLIを持つプログラム。このクライアントをAndroidアプリにしてみる。

gRPC公式のQuick start

まずはgRPCの公式ドキュメントのAndroidのページを見に行く。

Quick start | Kotlin for Android | gRPC

以下のプロジェクトを使って説明されている。確認したときの最新のtagは v1.3.0 。

grpc-kotlin/examples at v1.3.0 · grpc/grpc-kotlin

このプロジェクトはgradleで構成されている。色々あってどこを見ればいいかすぐに分からなかったけど、AndroidアプリでgRPCクライアントについては3つのディレクトリ（Gradleのモジュール）だけを見れば良い。

• examples/protos
• examples/stub-android
• examples/android

examples/protos はprotoファイルが置いてあるモジュール。 examples/android はgRPCクライアントとなるAndroidアプリのモジュール。

では example/stub-android は？

stub

example/stub-android は、protoファイルからクライアントコードを自動生成するためのモジュール。生成されたクライアントコードをstubと呼ぶ。クライアントとなるAndroidアプリのソースコードからstubのメソッドを普通のメソッドとして呼び出すが、stubが提供しているメソッドの実態はサーバー側で実装されている。つまり、RPCとなる。

ユニットテストで仮の実装としてスタブという言葉を使うことがあるけど、仮の実装というわけではない。

stubについて、gRPC公式で軽く触れられている。

Androidアプリつくる

上記のexampleを参考に作ってみた。

github.com

project_root/app がAndroidアプリ、 feature/grpc-client サブモジュールがgRPCクライアントのソースコードで、公式exampleの android に相当する。

このAndroidアプリは client_stub モジュールに依存する。他にもgRPC関連のライブラリにも依存する。

dependencies {
    implementation(project(path: ":client_stub"))
    ...

    // gRPC
    implementation("io.grpc:grpc-kotlin-stub:$grpc_kotlin_version")
    implementation("com.google.protobuf:protobuf-kotlin-lite:$protobuf_version")
    implementation("io.grpc:grpc-android:$grpc_android_version")
    implementation("io.grpc:grpc-okhttp:$grpc_android_version")
}

feature/grpc-client/build.gradle

client_stub はprotoファイルからコード自動生成するモジュール。Android Libraryモジュールとする。

公式exampleの build.gradle を参考に色々いじってみる。

protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:$protobuf_version"
    }
    plugins {
        java {
            artifact = "io.grpc:protoc-gen-grpc-java:$grpc_version"
        }
        grpc {
            artifact = "io.grpc:protoc-gen-grpc-java:$grpc_version"
        }
        grpckt {
            artifact = "io.grpc:protoc-gen-grpc-kotlin:$grpc_kotlin_version:jdk7@jar"
        }
    }
    ...
}

client_stub/build.gradle

以下の3つそれぞれとprotocコマンドとの対応をイメージすると把握しやすい。Java実装のstubを自動生成しないといけないというのが最初とっつきづらかった。

• com.google.protobuf:protoc
  • protoc コマンド自体
• io.grpc:protoc-gen-grpc-java
  • Javaで実装されたstubを生成
  • Goの例で言うと protoc コマンドのオプション --go-grpc_out ã‚„ --go-grpc_opt
• io.grpc:protoc-gen-grpc-kotlin
  • Kotlinで実装された上記のJava実装stubのラッパー

protocから自動生成したstubã‚’Android Libraryモジュールとして、 project_root/app から参照できれば、あとは公式exampleのandroidを見ながら実装すれば良い。

おしまい

protocコマンドで生成できるととっつきやすいのですが、Android Libraryモジュールにしたい場合はGradleでやれると楽ですねぇ。今回は client_stub を同一プロジェクトにしましたが、別リポジトリとしてaarã‚’publishするのが良さそうです。