krpc

Generates multiplatform RPC code from .proto files, leveraging Wire library. Features plugin integration, schema handler configuration, and allows customizations for code generation tasks.

#rpc
#code-generation

Suggest an edit

JVMKotlin/Native

GitHub stars2

Authorsszkug

Open issues0

LicenseApache License 2.0

Creation dateabout 2 years ago

Last activityover 1 year ago

Latest release1.0.0 (over 1 year ago)

GitHub repository Wiki page

krpc-plugin

Generate kotlin multiplatform RPC code from .proto files.

Krpc base on wire.

Usage

Use plugin

// build.gradle.kts
plugins {
    id("cn.szkug.krpc") version "<version>"
}

wire {
    // wire configuration
}

Import Schema Handler

buildscript {
  repositories {
    mavenCentral()
  }
  dependencies {
    classpath("org.szkug.krpc:schema:<version>")
  }
}

Then configuration WireExtension schema handler with custom.

// build.gradle.kts
wire {
    custom {
        schemaHandlerFactory = KrpcSchemaHandlerFactory.client()
        out = "${layout.buildDirectory.asFile.get()}/generated"
    }
    // wire configuration
}

// must import runtime without plugin
dependencies {
    implementation("org.szkug.krpc:runtime:<version>")
}

Sample

message ActiveReq {
  string os = 1; // System
  string brd = 2; // Device
  string ver = 3; // App Version
  optional int64 uid = 4; // User id if logged in
}

message ActiveResp {}

service ActiveService {

  rpc report(ActiveReq) returns (ActiveResp);

}

This proto file will generate kotlin code like:

interface KrpcActiveService {
    fun report(req: ActiveReq): ActiveResp
}