软键盘挡住输入框问题的终极解决方案

时间 2020-05-08

标签键盘挡住输入问题终极解决方案繁體版

原文原文链接

做者：腾儿飞
连接：https://www.jianshu.com/p/306482e17080
来源：简书java

前言

开发作得久了，总免不了会遇到各类坑。
而在Android开发的路上，『软键盘挡住了输入框』这个坑，可谓是一个旷日持久的巨坑——来来来，咱们慢慢看。android

入门篇

最基本的状况，如图所示：在页面底部有一个EditText，若是不作任何处理，那么在软键盘弹出的时候，就有可能会挡住EditText。

对于这种状况的处理其实很简单，只须要在AndroidManifest文件中对activity设置：android:windowSoftInputMode的值adjustPan或者adjustResize便可，像这样：布局

<activity android:name=".MainActivity" android:windowSoftInputMode="adjustPan"  > ... </activity>

通常来讲，他们均可以解决问题，固然，adjustPan跟adjustResize的效果略有区别。测试

adjustPan是把整个界面向上平移，使输入框露出，不会改变界面的布局；
adjustResize则是从新计算弹出软键盘以后的界面大小，至关因而用更少的界面区域去显示内容，输入框通常天然也就在内了。

↑↑↑ OK，这只是入门，基本上地球上全部的Android工程师都能搞定。
别急，看下面~this

加上WebView试试看？坑来了……

上面的入门篇中，软键盘是由原生的EditText触发弹出的。而在H五、Hybrid几乎已经成为App标配的时候，咱们常常还会碰到的状况是：软键盘是由WebView中的网页元素所触发弹出的。google

状况描述

这时候，状况就会变得复杂了:spa

首先，页面是非全屏模式的状况下，给activity设置adjustPan会失效。
其次，页面是全屏模式的状况，adjustPan跟adjustResize都会失效。

——解释一下，这里的全屏模式便是页面是全屏的，包括Application或activity使用了Fullscreen主题、使用了『状态色着色』、『沉浸式状态栏』、『Immersive Mode』等等——总之，基本上只要是App本身接管了状态栏的控制，就会产生这种问题。code

下面这个表格能够简单列举了具体的状况。orm

为何说它是个坑？"issue 5497"

上面表格的这种状况并不是是Google所指望的，理想的状况固然是它们都能正常生效才对——因此这实际上是Android系统自己的一个BUG。server

为何文章开头说这是个坑呢？
——由于这个BUG从Android1.x时代（2009年）就被报告了，而一直到了现在的Android7.0（2016年）仍是没有修复……/(ㄒoㄒ)/
能够说这不只是个坑，并且仍是个官方挖的坑~

"issue 5497"，详情传送门 ☞ Issue 5497 - android -WebView adjustResize windowSoftInputMode breaks when activity is fullscreen - Android Open Source Project - Issue Tracker - Google Project Hosting

固然了，无论坑是谁挖的，最终仍是要开发者来解决。

遇到坑以后，有两种方法能够过去：躲，或者填。

躲坑姿式

如前文所示，出现坑的条件是：带有WebView的activity使用了全屏模式或者adjustPan模式。
那么躲坑的姿式就很简单了——
若是activity中有WebView，就不要使用全屏模式，而且把它的windowSoftInputMode值设为adjustResize就行了嘛

怎么样，是否是很简单？😑

填坑姿式

但总有些时候，是须要全屏模式跟WebView兼得的，这时候，躲坑就不行了，咱们须要一个新的填坑的姿式。幸亏，开发者的智慧是无穷的，这个坑出现了这么多年，仍是有人找到了一些解决方案的。

AndroidBug5497Workaround

我我的认为最好的解决方案是这个：AndroidBug5497Workaround，只须要一个神奇的AndroidBug5497Workaround类。

看名字就知道，它是专门用来对付"5497"问题的，使用步骤也是超级简单：

把AndroidBug5497Workaround类复制到项目中
在须要填坑的activity的onCreate方法中添加一句AndroidBug5497Workaround.assistActivity(this)便可。

通过测试，基本在各个Android版本上均可用，效果基本与设置了adjustResize至关。

它的原理是什么？

这个炫酷AndroidBug5497Workaround类，其实并非很复杂，只有几十行代码，先贴在这里：

public class AndroidBug5497Workaround { // For more information, see https://code.google.com/p/android/issues/detail?id=5497
    // To use this class, simply invoke assistActivity() on an Activity that already has its content view set.

    public static void assistActivity (Activity activity) { new AndroidBug5497Workaround(activity); } private View mChildOfContent; private int usableHeightPrevious; private FrameLayout.LayoutParams frameLayoutParams; private AndroidBug5497Workaround(Activity activity) { FrameLayout content = (FrameLayout) activity.findViewById(android.R.id.content); mChildOfContent = content.getChildAt(0); mChildOfContent.getViewTreeObserver().addOnGlobalLayoutListener(new ViewTreeObserver.OnGlobalLayoutListener() { public void onGlobalLayout() { possiblyResizeChildOfContent(); } }); frameLayoutParams = (FrameLayout.LayoutParams) mChildOfContent.getLayoutParams(); } private void possiblyResizeChildOfContent() { int usableHeightNow = computeUsableHeight(); if (usableHeightNow != usableHeightPrevious) { int usableHeightSansKeyboard = mChildOfContent.getRootView().getHeight(); int heightDifference = usableHeightSansKeyboard - usableHeightNow; if (heightDifference > (usableHeightSansKeyboard/4)) { // keyboard probably just became visible
                frameLayoutParams.height = usableHeightSansKeyboard - heightDifference; } else { // keyboard probably just became hidden
                frameLayoutParams.height = usableHeightSansKeyboard; } mChildOfContent.requestLayout(); usableHeightPrevious = usableHeightNow; } } private int computeUsableHeight() { Rect r = new Rect(); mChildOfContent.getWindowVisibleDisplayFrame(r); return (r.bottom - r.top);// 全屏模式下： return r.bottom
 } }

代码大体是作了这么几件事：

1.找到activity的根View

看一下入口的代码：

FrameLayout content = (FrameLayout) activity.findViewById(android.R.id.content);
mChildOfContent = content.getChildAt(0);

其中，第一行中的android.R.id.content所指的View，是Android全部Activity界面上开发者所能控制的区域的根View。

若是Activity是全屏模式，那么android.R.id.content就是占满所有屏幕区域的。

若是Activity是普通的非全屏模式，那么android.R.id.content就是占满除状态栏以外的全部区域。

其余状况，如Activity是弹窗、或者7.0之后的分屏样式等，android.R.id.content也是弹窗的范围或者分屏所在的半个屏幕——这些状况较少，就暂且不考虑了。

咱们常常用的setContentView(View view)/setContent(int layRes)其实就是把咱们指定的View或者layRes放到android.R.id.content里面，成为它的子View。

因此，而后，第二行content.getChildAt(0)获取到的mChildOfContent，其实也就是用以获取到咱们用setContentView放进去的View。

2.设置一个Listener监听View树变化

mChildOfContent.getViewTreeObserver().addOnGlobalLayoutListener({ //简化了写法
 possiblyResizeChildOfContent(); });

View.getViewTreeObserver()能够获取一个ViewTreeObserver对象——这个对象是一个观察者，专门用以监听当前View树所发生的一些变化。这里所注册的addOnGlobalLayoutListener，就是会在当前的View树的全局布局（GlobalLayout）发生变化、或者其中的View可视状态有变化时，进行通知回调。

——『软键盘弹出』，则是会触发这个事件的一个源。 (软键盘弹出会使GlobalLayout发生变化)

也就是说，如今能监听到『软键盘弹出』的事件了。

3.界面变化以后，获取"可用高度"

当软键盘弹出了以后，接下来的事情是获取改变以后的界面的可用高度（能够被开发者用以显示内容的高度）。
直接看代码：

private int computeUsableHeight() {
        Rect rect = new Rect();
        mChildOfContent.getWindowVisibleDisplayFrame(rect);
        // rect.top实际上是状态栏的高度，若是是全屏主题，直接 return rect.bottom就能够了
        return (rect.bottom - rect.top);
    }

View.getWindowVisibleDisplayFrame(Rect rect)，这行代码可以获取到的Rect——就是界面除去了标题栏、除去了被软键盘挡住的部分，所剩下的矩形区域——如图所示，红框中的区域。

Rect区域示意图

↑也能够看出：

rect.top值，其实就是标题栏的高度。（实际上，这也经常被用做为获取标题栏高度的方法）
屏幕高度-rect.bottom，是软键盘的高度。（获取软键盘高度的方法也出现了）

这时，就有：

全屏模式下，可用高度 = rect.bottom
非全屏模式，可用高度 = rect.bottom - rect.top

4.最后一步，重设高度

咱们计算出的可用高度，是目前在视觉效果上能看到的界面高度。但当前界面的实际高度是比可用高度要多出一个软键盘的距离的。
因此，最后一步，就是把界面高度置为可用高度——大功告成。

private void possiblyResizeChildOfContent() {
        int usableHeightNow = computeUsableHeight();
        if (usableHeightNow != usableHeightPrevious) {
            int usableHeightSansKeyboard = mChildOfContent.getRootView().getHeight();
            int heightDifference = usableHeightSansKeyboard - usableHeightNow;
            if (heightDifference > (usableHeightSansKeyboard/4)) {
                // keyboard probably just became visible
                frameLayoutParams.height = usableHeightSansKeyboard - heightDifference;
            } else {
                // keyboard probably just became hidden
                frameLayoutParams.height = usableHeightSansKeyboard;
            }
            mChildOfContent.requestLayout();
            usableHeightPrevious = usableHeightNow;
        }
    }

上面的代码里添加了一个"heightDifference > (usableHeightSansKeyboard/4)"的判断，这是为了去除无谓的干扰。由于能触发OnGlobalLayout事件的缘由有不少，不止是软键盘的弹出变化，还包括各类子View的隐藏显示变化等，它们对界面高度的影响有限。加上了这个判断以后，只有界面的高度变化超过1/4的屏幕高度，才会进行从新设置高度，基本能保证代码只响应软键盘的弹出。

总结

总结起来，就是这样：

普通Activity（不带WebView），直接使用adjustpan或者adjustResize
若是带WebView：
- a) 若是非全屏模式，可使用adjustResize
- b) 若是是全屏模式，则使用AndroidBug5497Workaround进行处理。

OK，以上就是一段关于『软键盘挡住输入框』的爬坑之旅。