Important

此项目的开发已迁移至 SaltifyDev/saltify 仓库下。

---

Milky SDK for Kotlin

特性

• 基于 Ktor Client 和 Kotlinx Serialization 实现
• 兼容 JVM / Native / JS / WASM 平台
• 支持 Milky 协议的所有功能
  • 例外：不支持通过 WebHook 事件推送监听事件

Tip

使用时，你需要在项目中添加一个 Ktor Client 引擎依赖，例如 ktor-client-cio、ktor-client-okhttp 等。

用例

见 ClientTest.kt

初始化

val client = MilkyClient {
    addressBase = "http://localhost:3000"
    eventConnectionType = EventConnectionType.WebSocket
    // accessToken = "..."

    // 直接定义插件
    plugin("name") {
        // ...
    }

    // 导入插件
    install(myPlugin)
}

// 释放 client
client.close()

定义插件

val myPlugin = milkyPlugin {
    onStart {
        // ...
    }

    command("say") {
        val content = greedyStringParameter("content", "words to repeat")

        onExecute {
            respond {
                text(content.value)
            }
        }

        onFailure {
            respond {
                text("Command run failed: $it")
            }
        }
    }

    // ...
}

调用 API

val loginInfo = client.getLoginInfo()

client.sendGroupMessage(123456789L) {
    text("Hello from Milky🥛!")
    image("https://example.com/example.jpg")
    image("https://example.com/example2.jpg", subType = "sticker")
}

监听事件

// 连接事件服务
client.connectEvent()

// 监听消息事件，并创建 Job 以便后续取消监听
val job = launch {
    client.on<Event.MessageReceive> {
        when (val data = it.data) {
            is IncomingMessage.Group -> {
                println("Group message from ${data.senderId} in ${data.group.groupId}:")
                println(milkyJsonModule.encodeToString(data.segments))
            }
            is IncomingMessage.Friend -> {
                println("Private message from ${data.senderId}:")
                println(milkyJsonModule.encodeToString(data.segments))
            }
            else -> {} 
        }
    }
}

// 退出时取消监听
job.cancel()
// tips: disconnectEvent() 不会被 client.close() 自动调用
client.disconnectEvent()

异常处理

runBlocking {
    client.on<IllegalStateException> { _, e ->
        println("Receive exception: ${e.message}")
        if (e.message != "test exception") {
            this@runBlocking.cancel(CancellationException(e.message, e))
        }
    }
}