Android实现点击输入框以外的区域隐藏软键盘（附带源码）

于 2025-04-28 00:15:00 发布
阅读量698 收藏 25
点赞数 18
分类专栏： Android实战项目 文章标签： android
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_61840987/article/details/147546917
版权

一、项目介绍

在移动端应用中，常常需要在用户点击输入框（EditText、TextInputEditText 等）以外的区域时，自动收起软键盘，以避免键盘遮挡内容或影响 UX。虽然 Android 提供了多种隐藏键盘的方法，但要做到“点击任意非输入区域隐藏键盘”往往需要在 Activity、Fragment 或自定义 View 中进行额外处理。

本项目将手把手演示如何：

  1. 在 Activity 中拦截触摸事件并隐藏键盘

  2. 在 Fragment 中应用相同思路

  3. 封装为 Kotlin 扩展函数 和 工具类，一行代码即可激活

  4. 支持 多层嵌套 View、RecyclerView、ScrollView 等复杂布局

  5. 兼容 AndroidX、Jetpack Compose 两种方案

  6. 处理 WindowSoftInputMode、状态栏/导航栏 等边界情况

最终，我们将提供一个可复用组件 KeyboardHelper，以及 Compose 中的 HideKeyboardOnTouchOutside 修饰器，帮助你在任何项目中快速集成。

二、相关知识

在动手之前，需要掌握以下核心概念：

  1. InputMethodManager

    • 系统软键盘管理器，用于显示或隐藏键盘

    • 常用方法：

val imm = context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
imm.hideSoftInputFromWindow(view.windowToken, 0)
imm.showSoftInput(view, InputMethodManager.SHOW_IMPLICIT)

  • View.dispatchTouchEvent & onTouchEvent

    • Activity 通过重写 dispatchTouchEvent(MotionEvent ev) 拦截所有触摸事件

    • 在 Fragment 或自定义 View 中可通过设置触摸监听或重写相应方法

  • ViewGroup.setOnHierarchyChangeListener

    • 在复杂布局中，可遍历所有子 View，给不需要拦截的子 View 设置 clickable=true，或者在父容器捕获点击

  • WindowSoftInputMode

    • 在 AndroidManifest.xml 的 Activity 标签上设置，如：

android:windowSoftInputMode="adjustResize|stateHidden"

    • 可控制键盘弹出时布局如何调整和初始状态

  2. Jetpack Compose

    • 用 LocalSoftwareKeyboardController 隐藏键盘

    • 利用 Modifier.pointerInput 拦截点击并执行隐藏

三、实现思路

我们将分步实现以下几种方案，最后整合为通用组件：

  1. Activity.dispatchTouchEvent 拦截方案

    • 在 dispatchTouchEvent 中判断当前焦点是否为 EditText，且点击位置是否在其外部，若是，则隐藏键盘并清除焦点

  2. View.OnTouchListener 方案

    • 给根布局（例如 ConstraintLayout、CoordinatorLayout）设置触摸监听，点击时隐藏键盘

  3. Fragment 中的处理

    • 在 onViewCreated 中给根 View 设置触摸监听，或在宿主 Activity 中暴露接口

  4. Kotlin 扩展与工具类封装

    • 封装函数 Activity.hideKeyboard()、View.hideKeyboard()，以及 Activity.setupHideKeyboardOnTouch() 等一行集成 API

  5. Compose 方案

    • 定义 Modifier.hideKeyboardOnTap()，在 Composable 区域点击时隐藏键盘

  6. Edge Cases

    • 处理 Dialog、PopupWindow、WebView 等场景

    • 处理 多窗口 与 分屏

    • 处理 软键盘手动收起 与 系统导航手势

四、环境与依赖

// app/build.gradle
apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'

android {
  compileSdkVersion 34
  defaultConfig {
    applicationId "com.example.hidekeyboard"
    minSdkVersion 21
    targetSdkVersion 34
  }
  buildFeatures { viewBinding true }
  kotlinOptions { jvmTarget = "1.8" }
}

dependencies {
  implementation 'androidx.appcompat:appcompat:1.6.1'
  implementation 'androidx.core:core-ktx:1.10.1'
  implementation 'androidx.fragment:fragment-ktx:1.5.7'
  implementation "androidx.compose.ui:ui:1.4.0"
  implementation "androidx.compose.foundation:foundation:1.4.0"
  implementation "androidx.compose.material:material:1.4.0"
}

五、整合代码

// =======================================================
// 文件: AndroidManifest.xml
// 描述: 示例 Activity 配置 windowSoftInputMode
// =======================================================
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.hidekeyboard">
  <application ...>
    <activity
        android:name=".MainActivity"
        android:windowSoftInputMode="adjustResize|stateHidden">
      <intent-filter>
        <action android:name="android.intent.action.MAIN"/>
        <category android:name="android.intent.category.LAUNCHER"/>
      </intent-filter>
    </activity>
  </application>
</manifest>

// =======================================================
// 文件: res/layout/activity_main.xml
// 描述: 根布局为 ConstraintLayout，包含两个 EditText 和一个 Button
// =======================================================
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/rootLayout"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:padding="16dp">

  <EditText
      android:id="@+id/etFirst"
      android:layout_width="0dp"
      android:layout_height="wrap_content"
      android:hint="输入框 1"
      app:layout_constraintTop_toTopOf="parent"
      app:layout_constraintStart_toStartOf="parent"
      app:layout_constraintEnd_toEndOf="parent"/>

  <EditText
      android:id="@+id/etSecond"
      android:layout_width="0dp"
      android:layout_height="wrap_content"
      android:hint="输入框 2"
      app:layout_constraintTop_toBottomOf="@id/etFirst"
      app:layout_constraintStart_toStartOf="parent"
      app:layout_constraintEnd_toEndOf="parent"
      android:layout_marginTop="16dp"/>

  <Button
      android:id="@+id/btnSubmit"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="提交"
      app:layout_constraintTop_toBottomOf="@id/etSecond"
      app:layout_constraintStart_toStartOf="parent"
      android:layout_marginTop="24dp"/>
</androidx.constraintlayout.widget.ConstraintLayout>

// =======================================================
// 文件: KeyboardHelper.kt
// 描述: 封装隐藏键盘的工具类和扩展函数
// =======================================================
package com.example.hidekeyboard

import android.app.Activity
import android.content.Context
import android.view.MotionEvent
import android.view.View
import android.view.inputmethod.InputMethodManager
import androidx.core.view.ViewCompat
import androidx.fragment.app.Fragment

/** 隐藏软键盘 */
fun Activity.hideKeyboard() {
  currentFocus?.let { view ->
    val imm = getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
    imm.hideSoftInputFromWindow(view.windowToken, 0)
    view.clearFocus()
  }
}

/** 在任意 View 上隐藏键盘 */
fun View.hideKeyboard() {
  val imm = context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
  imm.hideSoftInputFromWindow(windowToken, 0)
  clearFocus()
}

/** 判断触摸点是否在该 View 内 */
fun View.isTouchInside(ev: MotionEvent): Boolean {
  val loc = IntArray(2)
  getLocationOnScreen(loc)
  val x = ev.rawX.toInt() - loc[0]
  val y = ev.rawY.toInt() - loc[1]
  return x >= 0 && x < width && y >= 0 && y < height
}

/**
 * 为 Activity 设置点击输入框以外区域隐藏键盘功能
 * 使用方法：在 Activity.onCreate 中调用 setupHideKeyboard(rootLayout)
 */
fun Activity.setupHideKeyboardOnTouch(root: View) {
  // 为 rootView 设置触摸监听
  root.setOnTouchListener { v, ev ->
    if (ev.action == MotionEvent.ACTION_DOWN) {
      currentFocus?.let { focusView ->
        // 如果当前焦点是输入框，且点击在焦点之外
        if (focusView is View &&
            focusView !is ViewGroup &&  // EditText 等
            !focusView.isTouchInside(ev)
        ) {
          hideKeyboard()
        }
      }
    }
    // 保证点击事件继续被下层处理
    false
  }
}

/** Fragment 中调用该方法隐藏键盘 */
fun Fragment.setupHideKeyboardOnTouch(root: View) {
  activity?.setupHideKeyboardOnTouch(root)
}

// =======================================================
// 文件: MainActivity.kt
// 描述: Activity 演示 dispatchTouchEvent 拦截与工具类方案
// =======================================================
package com.example.hidekeyboard

import android.os.Bundle
import android.view.MotionEvent
import androidx.appcompat.app.AppCompatActivity
import com.example.hidekeyboard.databinding.ActivityMainBinding

class MainActivity : AppCompatActivity() {
  private lateinit var binding: ActivityMainBinding

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    binding = ActivityMainBinding.inflate(layoutInflater)
    setContentView(binding.root)

    // 方案A：工具类，在根布局上注册全局触摸监听
    setupHideKeyboardOnTouch(binding.rootLayout)

    // 方案B：dispatchTouchEvent 拦截
    //（注释方案 A 上面的调用测试下方 dispatchTouchEvent 方案）
  }

  override fun dispatchTouchEvent(ev: MotionEvent): Boolean {
    if (ev.action == MotionEvent.ACTION_DOWN) {
      currentFocus?.let { view ->
        // 点击不在输入框内，则隐藏
        if (view is View && !view.isTouchInside(ev)) {
          hideKeyboard()
        }
      }
    }
    return super.dispatchTouchEvent(ev)
  }
}

// =======================================================
// 文件: FragmentDemo.kt
// 描述: 在 Fragment 中使用工具类隐藏键盘
// =======================================================
package com.example.hidekeyboard

import android.os.Bundle
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import androidx.fragment.app.Fragment
import com.example.hidekeyboard.databinding.FragmentDemoBinding

class FragmentDemo : Fragment() {
  private var _binding: FragmentDemoBinding? = null
  private val binding get() = _binding!!
  override fun onCreateView(
    inflater: LayoutInflater, container: ViewGroup?,
    savedInstanceState: Bundle?
  ): View {
    _binding = FragmentDemoBinding.inflate(inflater, container, false)
    return binding.root
  }

  override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
    super.onViewCreated(view, savedInstanceState)
    // 只需在根布局上调用
    setupHideKeyboardOnTouch(binding.root)
  }
  override fun onDestroyView() {
    super.onDestroyView()
    _binding = null
  }
}

// =======================================================
// 文件: ComposeHelpers.kt
// 描述: Jetpack Compose 中隐藏键盘方案
// =======================================================
package com.example.hidekeyboard

import android.view.MotionEvent
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.text.KeyboardActions
import androidx.compose.foundation.text.KeyboardOptions
import androidx.compose.material.OutlinedTextField
import androidx.compose.runtime.*
import androidx.compose.ui.ExperimentalComposeUiApi
import androidx.compose.ui.Modifier
import androidx.compose.ui.input.pointer.pointerInput
import androidx.compose.ui.platform.*

@OptIn(ExperimentalComposeUiApi::class)
fun Modifier.hideKeyboardOnTap(): Modifier {
  val keyboardController = LocalSoftwareKeyboardController.current
  return pointerInput(Unit) {
    awaitPointerEventScope {
      while (true) {
        val ev = awaitPointerEvent()
        if (ev.changes.any { it.changedToUp() }) {
          keyboardController?.hide()
        }
      }
    }
  }
}

// Usage in Composable:
/*
@Composable
fun DemoScreen() {
  Box(modifier = Modifier
    .fillMaxSize()
    .hideKeyboardOnTap()
  ) {
    var text by remember { mutableStateOf("") }
    OutlinedTextField(
      value = text,
      onValueChange = { text = it },
      modifier = Modifier.fillMaxWidth(),
      keyboardOptions = KeyboardOptions.Default,
      keyboardActions = KeyboardActions(onDone = {
        LocalSoftwareKeyboardController.current?.hide()
      })
    )
  }
}
*/

六、代码解读

  1. KeyboardHelper 工具类

    • hideKeyboard() 和 View.hideKeyboard()：统一调用 InputMethodManager 隐藏键盘并清除焦点

    • isTouchInside(ev)：判断触摸点是否在某 View 区域内

    • setupHideKeyboardOnTouch(root)：在根布局设置 OnTouchListener，点击空白区域时隐藏键盘

  2. dispatchTouchEvent 方案

    • 在 Activity.dispatchTouchEvent 中拦截所有触摸事件，判断当前焦点和点击区域，隐藏键盘

    • 适合不想在布局层添加监听的场景

  3. Fragment 中的集成

    • 复用 Activity 的工具函数，在 Fragment.onViewCreated 中调用，即可获得相同效果

  4. Jetpack Compose 方案

    • 定义 Modifier.hideKeyboardOnTap()，利用 pointerInput 捕获点击并调用 LocalSoftwareKeyboardController.hide()

    • 在 OutlinedTextField 的 KeyboardActions.onDone 中隐藏键盘

七、性能与优化

  1. 避免多重监听

    • 若已在 Activity 中使用 dispatchTouchEvent 方案，无需在子布局重复注册触摸监听

  2. 限定监听区域

    • 若页面中仅部分区域需要隐藏，可将监听器绑定到对应容器而非全局根布局

  3. 兼容性

    • 对于 Dialog、PopupWindow、BottomSheetDialogFragment 等弹窗，也可在其根布局上或 dispatchTouchEvent 中同样拦截

  4. 防抖处理

    • 若存在频繁触摸时意外收起键盘，可在工具函数中加入点击节流

八、项目总结与拓展

本文全面演示了在 Android 中多种场景下“点击输入框以外区域隐藏软键盘”的最佳实践，并封装了可复用的工具函数和 Compose 修饰器。这样，无论是传统 View 架构还是现代 Compose，都能快速、一致地实现优雅的键盘隐藏交互。

拓展方向

  1. 监听键盘状态：使用 ViewTreeObserver 或 WindowInsets 监听键盘弹起收起，做布局调整

  2. 结合 RxJava/Kotlin Flow：将键盘事件包装成流，响应式处理

  3. 自定义焦点导航：在隐藏键盘后自动导航到下一个输入框，提升表单体验

  4. 多语言与无障碍：为无障碍用户提供额外提示，如自动隐藏键盘时发出语音反馈

九、FAQ

Q1：为何有时 dispatchTouchEvent 无效？
A1：可能是 Dialog、PopupWindow 或 RecyclerView 拦截了触摸事件，请确保在最高层拦截，或为相应 View 挂载触摸监听。

Q2：点击 ScrollView 内部空白区域无效？
A2：ScrollView 默认不接收点击事件，可在布局 XML 中 android:clickable="true" 并调用 setupHideKeyboardOnTouch。

Q3：Compose 方案怎样避免拦截子控件的交互？
A3：将 pointerInput 放在容器最外层，并在需要处理区域外侧使用 pointerInput，或在事件后 awaitPointerEventScope 不消耗事件。

Q4：clearFocus() 之后点击还会立即弹出键盘？
A4：确保目标 EditText 未设置 android:focusableInTouchMode="true"，或在隐藏后手动调用 view.clearFocus()。

Q5：如何关闭硬件键盘（物理键盘）？
A5：物理键盘无法被 InputMethodManager 控制，只能在 EditText 上禁用，如 android:imeOptions="flagNoExtractUi"。

评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值