如何在 Kotlin for Android 客户端上使用 protobuf 生成 gRPC 代码？

Question

我在 nodejs 中创建了一个 gRPC 服务器（由 AWS 托管），我可以使用本地机器上的 nodejs 客户端实现连接到它。

我正在使用com.google.protobuf 插件从我的.proto 文件中自动生成代码。 我的 gradle 同步工作并且应用程序构建成功，但我找不到生成的代码类。 我正在努力为 Android gRPC 客户端的 Kotlin 找到一个好的实现示例，但我遵循了这些文章：

• gRPC In Kotlin(Android)
• Java Basic Tutorial

我的app/src/main/protos/responder.proto 文件

syntax = "proto3";

option java_package = "protos.grpc";
package responder;

message ConnectionRequest {
    int32 userId = 2;
}

message ConnectionResponse {
    string response = 1;
}

service ResponderService {
    rpc responderConnect (stream ConnectionRequest) returns (stream ConnectionResponse) {};
}

项目build.gradle

// Top-level build file where you can add configuration options common to all sub-projects/modules.

buildscript {
    ext {
        kotlin_version = '1.3.72'
        protobufPluginVersion = '0.8.6'
        grpcVersion = '1.12.0'
        protocVersion = '3.2.0'
    }
    repositories {
        google()
        jcenter()

    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.6.3'
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath "com.google.protobuf:protobuf-gradle-plugin:$protobufPluginVersion"

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
        def nav_version = "2.2.2"
        classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$nav_version"
    }
}

allprojects {
    repositories {
        google()
        jcenter()
        maven { url "https://jitpack.io" }
        mavenCentral()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

还有我应用的build.gradle

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'com.google.protobuf'

android {
    compileSdkVersion 29
    buildToolsVersion "29.0.3"

    defaultConfig {
        applicationId "organisation.responder.two"
        minSdkVersion 19
        targetSdkVersion 29
        versionCode 31
        versionName "2.0"
        multiDexEnabled true

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = "1.8"
    }

}

dependencies {
    ...
    implementation 'io.grpc:grpc-okhttp:1.30.0'
    implementation 'io.grpc:grpc-protobuf-lite:1.30.0'
    implementation 'io.grpc:grpc-stub:1.30.0'
    implementation 'io.grpc:grpc-core:1.30.0'
    compileOnly 'org.apache.tomcat:annotations-api:6.0.53'

    def multidex_version = "2.0.1"
    implementation "androidx.multidex:multidex:$multidex_version"
}

protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:3.12.0"
    }
    plugins {
        javalite {
            artifact = "com.google.protobuf:protoc-gen-javalite:3.0.0"
        }
        grpc {
            artifact = "io.grpc:protoc-gen-grpc-java:1.30.0"
        }
    }
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                remove java
            }
            task.plugins {
                javalite {}
                grpc {
                    // Options added to --grpc_out
                    option 'lite'
                }
            }
        }
    }
}

如上所述，gradle同步成功，项目构建成功。但是自动生成的代码在哪里？

Answer 1

以this build.gradle file为例，我设法使用gradle protobuf插件生成了grpc代码。

包括对我的应用级别 build.gradle 文件的重大更改：

1. 在android 块下的sourceSets 块中添加.proto 文件的路径。

android {
    ...
    sourceSets {
        main {
            proto {
                srcDir 'src/main/protos' <-- path to .proto file
            }
        }
    }
}

1. 更改应用级别 build.gradle 文件中的 protobuf 块

protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:3.12.0"
    }
    plugins {
        grpc {
            artifact = "io.grpc:protoc-gen-grpc-java:1.30.0"
        }
    }
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                remove javanano
                java {
                    option 'lite'
                }
            }

            task.plugins {
                grpc {
                    // Options added to --grpc_out
                    option 'lite'
                }
            }
        }
    }
}

成功同步和构建后，生成的代码文件位于app/build/generated/source/proto/debug/grpc/protos/grpc/ResponderServiceGrpc.java和app/build/generated/source/proto/debug/java/protos/grpc/Responder.java下