java或者kotlin在gradle中如何使用grpc

gralde 配置#

kotlin 要使用 grpc 需要配置ksp这个插件所以第一步就是添加ksp插件#

1
plugins {
2
    id("com.google.devtools.ksp") version "xxx.xxx"
3
}

添加protobuf插件#

1
plugins {
2
    id("com.google.devtools.ksp") version "xxx.xxx"
3
    id("com.google.protobuf") version "xxx.xxx"
4
}

添加grpc的依赖#

这里要特别注意下grpc-netty中的netty可能会和其他依赖中的netty冲突，需要你自己排除掉其中一个的netty。

1
dependencies {
2
    implementation("io.grpc:grpc-core:last.release")
3
    runtimeOnly("io.grpc:grpc-netty:last.release")
4
    implementation("io.grpc:grpc-stub:last.release")
5
    implementation("io.grpc:grpc-kotlin-stub:last.release")
6
    implementation("io.grpc:grpc-protobuf:last.release")
7
    implementation("io.grpc:protoc-gen-grpc-kotlin:last.release")
8
    implementation("com.google.protobuf:protobuf-java-util:last.release")
9
    implementation("com.google.protobuf:protobuf-kotlin:last.release")
10
}

添加相关配置用来生成grpc的java代码#

1
import com.google.protobuf.gradle.id
2
......
3
protobuf {
4
    protoc {
5
        artifact = "com.google.protobuf:protoc:4.27.0"
6
    }
7
    plugins {
8
        id("grpc") {
9
            artifact = "io.grpc:protoc-gen-grpc-java:1.64.0"
10
        }
11
        id("grpckt") {
12
            artifact = "io.grpc:protoc-gen-grpc-kotlin:1.3.0:jdk8@jar"
13
        }
14
    }
15
    generateProtoTasks {
16
        all().forEach {
17
            it.plugins {
18
                id("grpc")
19
                id("grpckt")
20
            }
21
            it.builtins {
22
                id("kotlin")
23
            }
24
        }
25
    }
26

27
    sourceSets {
28
        main {
29
            proto {
30
                srcDir("src/main/resources/protos") // 模块下的proto文件夹
31
//        include("**/*.proto") 或者这样
32
            }
33
        }
34
    }
35

36
}

完整的配置#

1
import com.google.protobuf.gradle.id
2
......
3

4
plugins {
5
    id("com.google.devtools.ksp") version "xxx.xxx"
6
    id("com.google.protobuf") version "xxx.xxx"
7
    ......
8
}
9

10
......
11
protobuf {
12
    protoc {
13
        artifact = "com.google.protobuf:protoc:4.27.0"
14
    }
15
    plugins {
16
        id("grpc") {
17
            artifact = "io.grpc:protoc-gen-grpc-java:1.64.0"
18
        }
19
        id("grpckt") {
20
            artifact = "io.grpc:protoc-gen-grpc-kotlin:1.3.0:jdk8@jar"
21
        }
22
    }
23
    generateProtoTasks {
24
        all().forEach {
25
            it.plugins {
26
                id("grpc")
27
                id("grpckt")
28
            }
29
            it.builtins {
30
                id("kotlin")
31
            }
32
        }
33
    }
34

35
    sourceSets {
36
        main {
37
            proto {
38
                srcDir("src/main/resources/protos") // 模块下的proto文件夹
39
//        include("**/*.proto") 或者这样
40
            }
41
        }
42
    }
43

44
}