Kotlin 多平台 KtorClient 代码生成器

Kotlin 多平台 KtorClient 代码生成器

项目仓库

Gitlab

https://gitlab.com/vividcode/multiplatform-ktor-client

Github

https://github.com/vividcodex/multiplatform-ktor-client

Maven Central

• cn.vividcode.multiplatform:ktor-client-api:2.3.10-100-Beta2
• cn.vividcode.multiplatform:ktor-client-ksp:2.3.10-100-Beta2

版本说明

ktor版本-代码生成器版本：例如：2.3.10-1.0.0-Beta2

最新版本

2.3.10-1.0.0-Beta2

依赖说明

模块中已经包含了以下依赖，不需要额外重新添加

io.ktor:ktor-client-core:2.3.10
io.ktor:ktor-client-logging:2.3.10
io.ktor:ktor-client-cio:2.3.10
io.ktor:ktor-client-serialization:2.3.10
io.ktor:ktor-client-content-negotiation:2.3.10
io.ktor:ktor-serialization-kotlinx-json:2.3.10

使用方法

• 请在多平台模块中的 build.gradle.kts 配置一下内容，请按照实际情况编写

plugins {
	id("com.google.devtools.ksp")
}

kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation("cn.vividcode.multiplatform:ktor-client-api:2.3.10-1.0.0-Beta2") 
        }
        iosMain {
            kotlin.srcDir("build/generated/ksp/metadata/commonMain/kotlin") 
        }
    }
}

ksp {
    arg("namespace", "<包名>")
}

dependencies {
    kspCommonMainMetadata("cn.vividcode.multiplatform:ktor-client-ksp:2.3.10-1.0.0-Beta2")
}

tasks.withType<KotlinCompile<*>>().all {
    if (this.name != "kspCommonMainKotlinMetadata") {
        dependsOn("kspCommonMainKotlinMetadata")
    }
}

注解介绍

@Api 接口 标记在接口上

• 名称 baseUrl 类型 String 介绍 接口前缀路径

@GET 方法 GET请求

• 名称 url 类型 String 介绍 接口路径
• 名称 auth 类型 Boolean 默认值 false 介绍 是否需要授权

@POST 方法 POST请求

• 名称 url 类型 String 介绍 接口路径
• 名称 auth 类型 Boolean 默认值 false 介绍 是否需要授权

@PUT 方法 PUT请求

• 名称 url 类型 String 介绍 接口路径
• 名称 auth 类型 Boolean 默认值 false 介绍 是否需要授权

@DELETE 方法 DELETE请求

• 名称 url 类型 String 介绍 接口路径
• 名称 auth 类型 Boolean 默认值 false 介绍 是否需要授权

@Body 参数 请求体

@Form 参数 表单

• 名称 name 类型 String 介绍 表单参数名称

@Query 参数 参数

• 名称 name 类型 String 介绍 参数名称

@Header 参数 请求头

• 名称 name 类型 String 介绍 请求头参数名称

@SHA256 参数 字段SHA256加密

• 名称 layer 类型 Int 默认值 1 介绍 加密层数

注解使用实例

• 只允许使用 suspend 方法
• 支持的返回类型有 Unit ResultBody<*> ByteArray

@Api(baseUrl = "/auth")
interface AuthApi {
    
    /**
     * 登录
     */
    @POST(url = "/login")
    suspend fun login(
        @Form("username") username: String, 
        @Form("password") @SHA256(layer = 2) password: String
    ): ResultBody<LoginMo>
    
    /**
     * 登出
     */
    @POST(url = "/logout", auth = true)
    suspend fun logout()
    
    /**
     * 注册
     */
    @POST(url = "/register")
    suspend fun register(
        @Form("username") username: String,
        @Form("password") @SHA256(layer = 2) password: String,
        @Form("captcha") captcha: String
    ): ResultBody<Unit>
    
    /**
     * 验证码
     */
    @GET(url = "/captcha")
    suspend fun captcha(
        @Query("count") count: Int
    ): ByteArray
}

根据上述实例代码的使用教程

val ktorClient = KtorClient.builder()
    .domain("http://localhost/api")     // 必须填写，所有请求的前缀
    .getToken { "<token>" }             // 必须填写，当注解的 auth = true 后会将token附带在请求头上
    .handleLog { }                      // 默认值：{ }
    .connectTimeout(5000L)              // 默认值：5000L
    .socketTimeout(Long.MAX_VALUE)      // 默认值：Long.MAX_VALUE
    .build()

@Composable
fun Login() {
    val coroutineScope = rememberCoroutineScope()
    Button(
        onClick = {
            coroutineScope.launch {
                ktorClient.authApi.logout()
            }
        }
    ) {
        Text("退出登录")
    }
}