日本語

This library is a gRPC client library compatible with Kotlin Multiplatform. It provides a common gRPC API across JVM, JavaScript, iOS, macOS, Linux, and Windows platforms. On JVM it uses grpc-java, on JavaScript it uses gRPC-Web over Ktor HttpClient, and on native platforms (iOS, macOS, Linux, Windows) it uses Rust/Tonic via FFI.

Below is how to use it with Kotlin on the supported platforms using Gradle. If you are using it on an Apple platform, please refer to kgrpc-spm or kgrpc-cocoapods. Additionally, please check the test code as well.

repositories {
    mavenCentral()
}

dependencies {
+   implementation("work.socialhub.kgrpc:core:0.0.1")
}

repositories {
+   maven { url = uri("https://repo.repsy.io/mvn/uakihir0/public") }
}

dependencies {
+   implementation("work.socialhub.kgrpc:core:0.0.1-SNAPSHOT")
}

All of the above can be added to and used in regular Java projects, too. All you have to do is to use the suffix -jvm when listing the dependency.

Here is a sample Maven configuration:

<dependency>
    <groupId>work.socialhub.kgrpc</groupId>
    <artifactId>core-jvm</artifactId>
    <version>[VERSION]</version>
</dependency>

val channel = Channel.Builder
    .forAddress("localhost", 50051)
    .usePlaintext()
    .build()

val channel = Channel.Builder
    .forAddress("example.com", 443)
    .useTransportSecurity()
    .build()

val stub = MyServiceStub(channel)
val response = stub.myMethod(request)

val channel = Channel.Builder
    .forAddress("localhost", 50051)
    .usePlaintext()
    .intercept(object : CallInterceptor {
        override fun onSendHeaders(headers: Metadata): Metadata {
            headers.put("authorization", "Bearer $token")
            return headers
        }
    })
    .build()

• Channel - gRPC connection (configured via Channel.Builder)
• Message / MessageCompanion - Protobuf message serialization/deserialization
• Stub - Generated service stubs for making RPC calls
• CallInterceptor - Intercept and modify RPC metadata, messages, and status

MIT License

Akihiro Urushihara