Android自定义IME：用自定义布局替代Keyboard并兼容KeyboardView相关方法

实现思路 #

要在保留setKeyboard()和setOnKeyboardActionListener()功能的前提下使用自定义布局，核心是在自定义布局中嵌入系统KeyboardView，后续通过获取该KeyboardView实例调用核心方法，同时可自由扩展布局的其他部分（如工具栏、装饰元素）。

步骤1：创建自定义输入法布局 #

在res/layout/下新建布局文件（如keyboard_custom.xml），按需添加自定义元素，核心保留KeyboardView并指定ID：

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="vertical">

    <!-- 自定义顶部栏（可选） -->
    <TextView
        android:layout_width="match_parent"
        android:layout_height="40dp"
        android:gravity="center"
        android:text="我的自定义输入法"
        android:background="#f5f5f5"
        android:textColor="#333"/>

    <!-- 核心KeyboardView，可自定义样式属性 -->
    <android.inputmethodservice.KeyboardView
        android:id="@+id/custom_keyboard_view"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:keyBackground="@drawable/custom_key_bg"
        android:keyTextColor="#2196F3"
        android:keyTextSize="22sp"
        android:horizontalGap="2dp"
        android:verticalGap="2dp"/>

</LinearLayout>

步骤2：修改InputMethodService代码 #

在onCreateInputView()中加载自定义布局，获取KeyboardView实例后调用核心方法：

@Override
public View onCreateInputView() {
    // 加载自定义布局
    View rootLayout = getLayoutInflater().inflate(R.layout.keyboard_custom, null);
    
    // 获取布局中的KeyboardView
    KeyboardView keyboardView = rootLayout.findViewById(R.id.custom_keyboard_view);
    
    // 加载Keyboard XML配置
    Keyboard numberKeyboard = new Keyboard(this, R.xml.numberpad);
    keyboardView.setKeyboard(numberKeyboard);
    
    // 设置按键监听器（当前类需实现OnKeyboardActionListener接口）
    keyboardView.setOnKeyboardActionListener(this);
    
    return rootLayout;
}

步骤3：自定义按键样式（可选） #

若需为不同按键设置差异化样式，可在numberpad.xml中针对单个Key配置属性：

<?xml version="1.0" encoding="utf-8"?>
<Keyboard xmlns:android="http://schemas.android.com/apk/res/android"
    android:keyWidth="10%p"
    android:keyHeight="55dp">
    <Row>
        <Key android:codes="49" android:keyLabel="1" android:keyEdgeFlags="left"
             android:keyBackground="@drawable/key_num_normal"/>
        <Key android:codes="50" android:keyLabel="2" android:keyBackground="@drawable/key_num_normal"/>
        <!-- 其他数字按键... -->
        <!-- 自定义删除键，使用图标代替文字 -->
        <Key android:codes="-5" android:keyIcon="@drawable/ic_backspace"
             android:keyBackground="@drawable/key_action_bg"/>
    </Row>
</Keyboard>

步骤4：实现按键事件处理 #

确保你的InputMethodService实现KeyboardView.OnKeyboardActionListener接口，重写方法处理按键逻辑：

public class CustomInputMethod extends InputMethodService implements KeyboardView.OnKeyboardActionListener {

    // ...其他生命周期代码...

    @Override
    public void onKey(int primaryCode, int[] keyCodes) {
        InputConnection inputConn = getCurrentInputConnection();
        if (inputConn == null) return;

        switch (primaryCode) {
            case Keyboard.KEYCODE_DELETE:
                // 处理删除事件
                inputConn.deleteSurroundingText(1, 0);
                break;
            case Keyboard.KEYCODE_CANCEL:
                // 处理收起键盘
                requestHideSelf(0);
                break;
            default:
                // 处理普通字符输入
                inputConn.commitText(String.valueOf((char) primaryCode), 1);
                break;
        }
    }

    // 重写其他接口方法（空实现即可，按需补充）
    @Override public void onPress(int primaryCode) {}
    @Override public void onRelease(int primaryCode) {}
    @Override public void onText(CharSequence text) {}
    @Override public void swipeLeft() {}
    @Override public void swipeRight() {}
    @Override public void swipeDown() {}
    @Override public void swipeUp() {}
}

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