Jetpack Compose中不使用TextField如何监听软键盘事件

Modifier.onKeyEvent() 仅响应硬件键盘事件是框架设计的预期行为：软键盘（IME输入法）的输入不会走Android原生KeyEvent派发链路，所有文本提交、编辑、删除操作都是通过InputConnection接口从输入法进程传递到当前焦点窗口，直接监听键事件自然无法捕获软键盘输入。

自定义文本输入组件要接收软键盘输入，不需要依赖系统TextField组件，直接对接输入法输入连接即可，核心步骤如下：

• 维护组件基础状态：包括当前输入文本内容、光标/选区位置、焦点状态，焦点获取时主动拉起软键盘，焦点丢失时收起软键盘。
• 实现自定义InputConnection：继承BaseInputConnection重写核心回调方法，所有软键盘输入操作都会通过这些方法回调，你可以在回调中插入自定义文本转换逻辑：

  不要使用空实现的InputConnection，否则绝大多数第三方输入法会识别不到有效输入目标，出现弹不出键盘、输入无响应的问题
  必须重写的核心方法：

  • commitText()：接收输入法提交的最终上屏内容，普通字符输入、联想词选择、手写/语音识别结果上屏都会走这个回调
  • setComposingText()：接收输入法的组合态文本，比如拼音输入过程中未确认的候选拼音串、带预编辑标记的输入内容
  • deleteSurroundingText()：接收删除操作，软键盘退格键、输入法手势删除、批量删除都会走这个回调
  • finishComposingText()：接收预编辑结束事件，比如拼音选字完成、确认输入提交
  • sendKeyEvent()：兼容部分输入法派发的特殊键事件，比如回车、方向键、功能键
• 对接系统输入法服务：组件获取焦点时，调用InputMethodManager的restartInput方法，把你实现的自定义InputConnection注册给系统，软键盘后续就会把所有输入事件派发到这个连接实例上。

// 自定义输入状态维护类
class TextFieldValueState {
    var text: StringBuilder = StringBuilder()
    var cursorPos: Int = 0
    var composingStart: Int = -1
    var composingEnd: Int = -1

    fun insertText(insertStr: String) {
        text.insert(cursorPos, insertStr)
        cursorPos += insertStr.length
    }

    fun deleteBefore(count: Int) {
        val deleteCount = minOf(count, cursorPos)
        text.delete(cursorPos - deleteCount, cursorPos)
        cursorPos -= deleteCount
    }
}

// 自定义输入Modifier
fun Modifier.customInput(
    state: TextFieldValueState,
    onValueChange: (String) -> Unit
): Modifier = composed {
    val ctx = LocalContext.current
    val imm = remember { ctx.getSystemService(InputMethodManager::class.java) }
    val hostView = LocalView.current
    val inputConnection = remember {
        object : BaseInputConnection(hostView, true) {
            override fun commitText(commitStr: CharSequence?, newCursorPos: Int): Boolean {
                commitStr?.toString()?.let {
                    // 此处可插入自定义文本转换逻辑
                    state.insertText(it)
                    onValueChange(state.text.toString())
                }
                return true
            }

            override fun deleteSurroundingText(beforeLen: Int, afterLen: Int): Boolean {
                state.deleteBefore(beforeLen)
                onValueChange(state.text.toString())
                return true
            }

            override fun getTextBeforeCursor(length: Int, flags: Int): CharSequence {
                val start = maxOf(0, state.cursorPos - length)
                return state.text.substring(start, state.cursorPos)
            }

            override fun getTextAfterCursor(length: Int, flags: Int): CharSequence {
                val end = minOf(state.text.length, state.cursorPos + length)
                return state.text.substring(state.cursorPos, end)
            }
        }
    }

    this
        .focusable()
        .onFocusChanged { focusState ->
            if (focusState.isFocused) {
                imm.restartInput(hostView)
                imm.showSoftInput(hostView, 0)
            } else {
                imm.hideSoftInputFromWindow(hostView.windowToken, 0)
            }
        }
        .onKeyEvent { event ->
            // 此处仅处理硬件键盘事件即可
            false
        }
}

• 不要依赖KeyEvent.KEYCODE_DEL判断软键盘退格：超过半数的第三方输入法不会发送这个键事件，必须重写deleteSurroundingText才能覆盖所有删除场景
• 必须正确返回光标前后的文本内容：如果getTextBeforeCursor、getTextAfterCursor返回空或者内容错误，会导致输入法联想、光标移动、删除功能异常
• 文本转换逻辑不要写在onKeyEvent回调里：所有软键盘文本输入都走InputConnection回调，在对应回调中处理转换才能覆盖全部输入场景

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