如何用Kotlin与Jetpack Compose构建类Gboard的安卓自定义键盘？

一、核心实现流程 #

1. 给InputMethodService添加LifecycleOwner支持 #

InputMethodService本身不实现LifecycleOwner，我们可以通过LifecycleRegistry手动绑定生命周期事件，让Compose的生命周期API能正常工作：

class ComposeKeyboardService : InputMethodService(), LifecycleOwner {
    private lateinit var lifecycleRegistry: LifecycleRegistry

    override fun onCreate() {
        super.onCreate()
        lifecycleRegistry = LifecycleRegistry(this)
        lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_CREATE)
    }

    override fun onDestroy() {
        lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY)
        super.onDestroy()
    }

    override fun onStartInputView(info: EditorInfo?, restarting: Boolean) {
        super.onStartInputView(info, restarting)
        lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_START)
        // 挂载Compose键盘视图
        setInputView(
            ComposeView(this).apply {
                setContent {
                    CustomKeyboardUI(onKeyPressed = { key ->
                        currentInputConnection?.commitText(key, 1)
                    })
                }
            }
        )
    }

    override fun onFinishInputView(finishingInput: Boolean) {
        lifecycleRegistry.handleLifecycleEvent(Lifecycle.Event.ON_STOP)
        super.onFinishInputView(finishingInput)
    }

    override fun getLifecycle(): Lifecycle = lifecycleRegistry
}

2. 编写Compose键盘UI #

用Compose的声明式语法快速构建键盘布局，处理按键交互：

@Composable
fun CustomKeyboardUI(onKeyPressed: (String) -> Unit) {
    Column(
        modifier = Modifier.fillMaxWidth().background(Color.LightGray),
        verticalArrangement = Arrangement.SpaceEvenly
    ) {
        // 字母按键行
        Row(
            modifier = Modifier.fillMaxWidth(),
            horizontalArrangement = Arrangement.SpaceEvenly
        ) {
            listOf("Q", "W", "E", "R", "T", "Y", "U", "I", "O", "P").forEach { key ->
                KeyboardKey(text = key) { onKeyPressed(key) }
            }
        }
        // 删除键示例
        Row(
            modifier = Modifier.fillMaxWidth().padding(top = 8.dp),
            horizontalArrangement = Arrangement.Center
        ) {
            KeyboardKey(text = "删除") {
                currentInputConnection?.deleteSurroundingText(1, 0)
            }
        }
    }
}

@Composable
fun KeyboardKey(text: String, onClick: () -> Unit) {
    Button(
        onClick = onClick,
        modifier = Modifier.size(64.dp).padding(2.dp),
        colors = ButtonDefaults.buttonColors(backgroundColor = Color.White)
    ) {
        Text(text = text, fontSize = 18.sp)
    }
}

3. 配置Manifest与IME元数据 #

在AndroidManifest.xml中注册服务并声明IME权限：

<service
    android:name=".ComposeKeyboardService"
    android:label="@string/custom_keyboard"
    android:permission="android.permission.BIND_INPUT_METHOD">
    <meta-data
        android:name="android.view.im"
        android:resource="@xml/keyboard_config" />
    <intent-filter>
        <action android:name="android.view.InputMethod" />
    </intent-filter>
</service>

创建res/xml/keyboard_config.xml定义键盘子类型：

<?xml version="1.0" encoding="utf-8"?>
<input-method xmlns:android="http://schemas.android.com/apk/res/android">
    <subtype
        android:label="@string/english_keyboard"
        android:imeSubtypeMode="keyboard"
        android:imeSubtypeLocale="en_US" />
</input-method>

二、生命周期管理的关键细节 #

• 严格同步Service生命周期与LifecycleRegistry事件：onCreate对应ON_CREATE，onStartInputView对应ON_START，onFinishInputView对应ON_STOP，onDestroy对应ON_DESTROY，确保Compose的LaunchedEffect、rememberCoroutineScope等API能正确响应生命周期变化。
• 键盘视图的创建与销毁绑定onStartInputView和onFinishInputView，避免不必要的内存占用。

三、Compose vs XML：选型建议 #

• 优先选Compose：如果项目已经采用Compose技术栈，或者需要动态切换键盘布局（比如字母/数字/符号模式），Compose的状态驱动模式比XML更简洁易维护，无需手动更新View或处理 findViewById。
• XML适用场景：仅需固定布局的简单键盘，且团队对XML更熟悉时，XML可以快速实现，但长期来看，Compose的可扩展性更强。
• 两者核心逻辑均基于InputMethodService，只是UI层实现不同，IME的核心机制（输入连接、生命周期同步）完全一致。

四、常见问题处理 #

• 避免空指针：确保在onStartInputView之后访问currentInputConnection，此时输入连接已初始化。
• 性能优化：用remember缓存静态按键数据，给自定义数据类添加@Stable注解，减少不必要的Compose重组。

内容的提问来源于stack exchange，提问作者Mujeeb