EditText及输入法使用技巧总结

日常开发中，主要的输入事件方式有触摸事件和系统按键外以及输入法输入文字等。现在就来总结下EditText和输入法的常见使用方式，整理一些常见的问题和解决方法。

输入法开关：

打开输入法：

fun showSoftInput(view: View) {
    val imm = view.context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
    imm.showSoftInput(view, InputMethodManager.SHOW_FORCED)
}

关闭输入法：

fun hideSoftInput(view: View) {
    val imm = view.context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
    imm.hideSoftInputFromWindow(view.windowToken, 0)
}

打开or关闭输入法：如果输入法打开则关闭，如果没打开则打开。

fun toggleSoftInput(view: View) {
    val imm = view.context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
    imm.toggleSoftInput(0, InputMethodManager.HIDE_NOT_ALWAYS)
}

注：view为当前获取焦点的view。否则无效。activity.getCurrentFocus()可以找到当前获取焦点的view。一般是EditView。

问题：打开一个页面，我希望新页面的EditView获取焦点并打开输入法。

方法1，在xml布局里设置让EditView获取焦点。但是不可靠，后受父布局焦点的影响。在fragment里不确定。

方法2，代码强制打开输入法。那么先要让EditView获取焦点再开发输入法。然而初始化时，view往往还没有绘制或没有获取到焦点。所以需要如下操作：

// 等绘制完成后，再等待0.1秒，因为绘制完时并不能马上获取焦点。
editText.postDelayed({ 
    editText.focusOpenSoftInput() 
}, 100)
// 获取焦点并打开输入法。
fun EditText.focusOpenSoftInput() {
    setSelection(text?.length ?: 0)// 光标置尾。
    isFocusable = true 
    isFocusableInTouchMode = true
    requestFocus() // 获取焦点
    SoftInputUtil.showSoftInput(this) // 打开输入法。
}

注：进来时打开输入法。记得在返回时关闭输入法，否则输入法会一直停留在屏幕上。
（按系统的返回键会默认关闭输入法，但是摁自己写的后退按钮，并不会自动关闭，所以需要手动操作。）

限制输入：

业务需要，我们常需要限制用户输入，比如限制长度等，还会在输入变化后监听回调。这两件事往往会在一起处理，

限制长度简单的做法，在XML里给EditText设置属性：

android:maxLength="10"

注：限制输入截断时，如果输入的时复杂符号（如表情😊，单个表情并不是一个字符），如果简单截取会出现截成半个，小朋友是不是有很多❓(会出现几个“？”）。

注：限制与监听如果分开，必须保证先限制输入再处理监听回调。否则会回调未限制的文本。

所以我就写在一个listener里：

fun EditText.doAfterTextChanged(afterTextChanged: (s: Editable?) -> Unit, maxRule: (s: Editable) -> Boolean) {
    this.addTextChangedListener(object : TextWatcher {
        override fun beforeTextChanged(s: CharSequence?, start: Int, count: Int, after: Int) {
        }
        override fun onTextChanged(s: CharSequence?, start: Int, before: Int, count: Int) {
        }
        override fun afterTextChanged(s: Editable?) {
            val edit = this@doAfterTextChanged
            val selectionStart = edit.selectionStart
            val selectionEnd = edit.selectionEnd
            val str = edit.text?.toString().orEmpty()
            if (s != null && maxRule(s)) {
                val end = if (str.length > selectionStart) selectionStart else str.length
                // 返回指定索引之前的字符（Unicode 代码点）。
                val count = str.codePointCount(0, end)
                val st = if (count > 0) {
                    // 返回此 String 的指定文本范围中的 Unicode 代码点数。
                    str.offsetByCodePoints(0, count - 1)
                } else {
                    selectionStart - 1
                }
                // 删除多余输入的字（不会显示出来）。
                s.delete(st, selectionEnd)
                edit.text = s
                edit.setSelection(s.length)//设置光标在最后
            }
            afterTextChanged(s)
        }
    })
}

其中：关键方法（计算 Unicode 编码的代码点）

// 返回指定索引之前的字符（Unicode 代码点）。
String.codePointCount(beginIndex: Int, endIndex: Int):Int
// 返回此 String 的指定文本范围中的 Unicode 代码点数。
String.offsetByCodePoints(index: Int, codePointOffset: Int):Int

限制规则：maxRule: (s: Editable) -> Boolean 暴露出来自定义实现。例如：

// 限制输入长度。
fun EditText.doAfterTextChangedLimitLength(afterTextChanged: (s: Editable?) -> Unit, maxLength: Int = Int.MAX_VALUE) {
    this.doAfterTextChanged(afterTextChanged, { it.length > maxLength })
}
// 限制输入字节大小。
fun EditText.doAfterTextChangedLimitByte(afterTextChanged: (s: Editable?) -> Unit, maxByteSize: Int = Int.MAX_VALUE) {
    this.doAfterTextChanged(afterTextChanged, {
        it.toString().toByteArray(Charsets.UTF_8).size > maxByteSize
    })
}

PS：高阶函数里Editable?保留Editable比转换成String更好，因为它并不一定是String，大多是Spannable。

监听具体按键

需求中有时需要监听输入法上的搜索键，返回键，删除键，空格键或者具体的字母键。
分两种：一种时输入法右下角的返回键，可以变成搜索键。只需要在xml 里给EditText设置：

// 软键盘下方变成“搜索“
android:imeOptions="actionSearch"
android:singleLine="true" // 不让换行。
// 软键盘下方变成“完成”
android:imeOptions="actionDone" 
// 软键盘下方变成“发送”
android:imeOptions="actionSend"

监听返回按键：例如搜索。

editText.setOnEditorActionListener { _, actionId, event ->
            if (actionId == EditorInfo.IME_ACTION_SEARCH && event.action == KeyEvent.ACTION_DOWN) {
                // do something
            }
            return@setOnEditorActionListener true
        }
另一种为具体按键监听：例如删除键。
editText.setOnKeyListener { _, keyCode, event ->
            if (keyCode == KeyEvent.KEYCODE_DEL && event.action == KeyEvent.ACTION_DOWN) {
                // do something
            }
            return@setOnKeyListener false
        }

注：event.action 需要指定，否则按下会回调，抬起又会回调一次。
模拟删除：
开发中我可能需要点击某个按钮逐个删除EditText上的文字。
一般做法：

editText.text.delete(st,en)

缺点：如果editText上的文字是Spannable并设置了ImageSpan之类的，（一个Span可能占多个字符）要么整个删除，要么整个保留。

我们发现用软件的DEL键删除时，不会出现删半个的问题。由此，得到启发，我们可以模拟DEL按键。

// 主动dispatch一个按键事件。
editText.dispatchKeyEvent(KeyEvent(KeyEvent.ACTION_DOWN, KeyEvent.KEYCODE_DEL))
如果需要按住连续删除（有一定时间间隔）
private var isTouch :Boolean = false
private val delayed: Long = 50L
// 给按钮设置Touch事件。
private fun initView()
        vDelete.setOnTouchListener { _, event ->
            when (event.action) {
                MotionEvent.ACTION_DOWN -> {
                    isTouch = true
                    deleteEdit()
                }
                MotionEvent.ACTION_UP, MotionEvent.ACTION_CANCEL -> {
                    isTouch = false
                }
            }
            // 消费掉事件。使 click 无效。看具体需求。
            return@setOnTouchListener true
}
  
// 按住递归删除。
private fun deleteEdit() {
        if (editText?.text.isNullOrEmpty()) return
        editText?.dispatchKeyEvent(KeyEvent(KeyEvent.ACTION_DOWN, KeyEvent.KEYCODE_DEL))
        editText?.postDelayed({
            if (isTouch) {
                deleteEdit()
            }
        }, delayed)
}

模拟输入：
比如点击某个表情或按钮，给editText输入某个字符或者Spannable（即CharSequence）。

// 在光标末尾插入CharSequence。
editText.run {
      text.insert(selectionEnd, inputCharSequence)
}

PS：对EditText或者TextView的字符操作，尽量用CharSequence少用String，（因为不一定是String，大部分情况都不是。）

总结

目前先整理这几点，欢迎小伙伴们继续补充～

配一个图