Flutter 计算键盘高度以及打开关闭监听

一、缘由

Flutter弹窗里面有输入框,就会导致键盘顶起输入框.键盘弹起速度比较慢,所以看起来就是弹窗卡了.

解决这个问题有两个思路:
  • 弹窗给一个bottomPadding,这个值跟随系统键盘高度(MediaQueryData.fromWindow(window).viewInsets.bottom)变化
  • 在登录页面提前获取键盘高度,然后在需要弹窗的页面直接加上键盘高度
    我试了下方案一,其实还是有些卡顿,准备使用方案二解决.

二、实践思路

目前Flutter没有直接提供键盘高度和打开关闭的监听,所以我们需要自己封装一下.
主要思路是根据WidgetsBindingObserver中的didChangeMetrics方法不断监听键盘的高度.记录下,取出最大值即可.如果我们想要监听键盘完全打开或者关闭.就需要自己记录键盘高度的状态,bottom == 0时候键盘没展示,bottom == keyboardHeight表示键盘在最高位置.剩下都是就是弹出或者关闭的过程中.

用户可以手动改变键盘模式,例如改成手写,就会导致键盘变高,再从手写改成九键,会导致键盘变矮.变高我们任然是计算弹出最大值即可.变低这种情况不太好处理.我是判断了之前键盘是打开状态,然后在键盘变化的时候去延迟一下获取.由于键盘从手写变成九键很快,只需要稍微延迟,就能拿到变化后的值.

除了键盘高度计算,获取到键盘高度后保存本地,方便其他界面不去WidgetsBinding.instance.addObserver也能获取键盘高度.我还做了下键盘完全展开和关闭的监听.由于KeyBoardObserver是单列,也可以直接通过keyboardHeight字段获取键盘高度.
keyboardHeight 是键盘实时高度,直接放到布局的padding中会抖动,这种情况直接使用getKeyBordHeight()获取上一次键盘高度。

三、代码实现

import 'dart:math';
import 'dart:ui';

import 'package:flutter/cupertino.dart';
import 'package:shared_preferences/shared_preferences.dart';

/// initState中添加 WidgetsBinding.instance.addObserver(KeyBoardObserver.instance);
/// dispose中添加 WidgetsBinding.instance.removeObserver(KeyBoardObserver.instance);
/// 这个是实时变化的键盘高度
typedef FunctionType = void Function(bool isKeyboardShow);

class KeyBoardObserver extends WidgetsBindingObserver {
  double keyboardHeight = 0;
  bool? isKeyboardShow;
  bool? _preKeyboardShow;
  bool? isOpening;
  static const KEYBOARD_MAX_HEIGHT = "keyboard_max_height";
  double preBottom = -1;

  double lastBottom = -1;

  ///计算回调次数
  int times = 0;

  KeyBoardObserver._() {
    _getHeightToSp();
  }

  static final KeyBoardObserver _instance = KeyBoardObserver._();

  static KeyBoardObserver get instance => _instance;

  FunctionType? listener;

  void addListener(FunctionType listener) {
    this.listener = listener;
  }

  @override
  void didChangeMetrics() {
    times++;
    debugPrint("didChangeMetrics times $times");

    final bottom = MediaQueryData.fromWindow(window).viewInsets.bottom;
    if (times == 1) {
      Future.delayed(const Duration(milliseconds: 50), () {
        ///重点检测键盘变手写
        if (bottom != 0 && times < 3 && bottom == preBottom) {
          keyboardHeight = bottom;
          listener?.call(bottom == 0);
          saveHeightToSp();
          debugPrint("didChangeMetrics 键盘直走一次的时候记录高度 keyboardHeight:$keyboardHeight");
          times = 0;
          // state.setState(() {});
        }
      });
    }
    // 键盘存在中间态,回调是键盘冒出来的高度
    keyboardHeight = max(keyboardHeight, bottom);

    // if (bottom != 0 && preBottom == bottom) {
    //   keyboardHeight = bottom;
    //   debugPrint("didChangeMetrics 键盘展开 preBottom == bottom keyboardHeight $keyboardHeight");
    //   isKeyboardShow = true;
    // }
    ///折叠屏幕键盘高度会变化  折叠屏幕的适配  有些问题todo
    // if (bottom != 0 && preBottom == bottom && isKeyboardShow == null && bottom > 250) {
    //   keyboardHeight = bottom;
    //   debugPrint("didChangeMetrics 键盘展开 preBottom == bottom keyboardHeight $keyboardHeight");
    //   //isKeyboardShow = true; todo  先不改变状态,看下后面是否有问题
    // }

    if (bottom == 0 && keyboardHeight != 0) {
      debugPrint("didChangeMetrics bottom == 0 keyboardHeight $keyboardHeight");
      isKeyboardShow = false;
    } else if (bottom == keyboardHeight) {
      debugPrint("didChangeMetrics bottom == keyboardHeight bottom $bottom keyboardHeight $keyboardHeight");
      isKeyboardShow = true;
    } else {
      ///键盘打开和收起,都会走这里。
      debugPrint("didChangeMetrics isKeyboardShow == null  _preKeyboardShow $_preKeyboardShow bottom $bottom keyboardHeight $keyboardHeight");
      isKeyboardShow = null;

      if (_preKeyboardShow == false) {
        isOpening = true;
        debugPrint("didChangeMetrics 键盘正在打开");
      }
      if (_preKeyboardShow == true) {
        isOpening = false;
        debugPrint("didChangeMetrics 键盘正在关闭");
      }

      ///当键盘之前处于打开的时候才需要获取  todo 有了次数,这个应该可以去掉
      // if (_preKeyboardShow == true) {
      //   ///从手写切换到拼音,键盘会变小,这个时候无法判断,延迟一下,如果bottom 大于200,那么就是键盘高度。
      //   Future.delayed(const Duration(milliseconds: 100), () {
      //     final height = MediaQueryData.fromWindow(window).viewInsets.bottom;
      //     if (height > 200) {
      //       keyboardHeight = height;
      //       debugPrint("didChangeMetrics 掩饰200ms keyboardHeight $keyboardHeight  键盘高度 bottom $height");
      //       saveHeightToSp();
      //     }
      //   });
      // }
      ///当键盘正在打开的时候才需要
      if (isOpening == true) {
        ///记住当前值,如果大于250,延时50ms,如果当前值和之前值是一样的,则表示键盘最大值,
        if (bottom > 250) {
          lastBottom = bottom;
          Future.delayed(const Duration(milliseconds: 100), () {
            final bottom = MediaQueryData.fromWindow(window).viewInsets.bottom;
            if (lastBottom == bottom && isKeyboardShow == null) {
              keyboardHeight = bottom;
              debugPrint("didChangeMetrics 键盘展开 preBottom == bottom keyboardHeight $keyboardHeight");
              isKeyboardShow = true;
            }
          });
        }
      }
    }

    ///展开和收起   第一次
    if (isKeyboardShow != null && _preKeyboardShow != isKeyboardShow && keyboardHeight != 0) {
      // double bottom = MediaQueryData
      //     .fromWindow(window)
      //     .viewInsets
      //     .bottom;

      ///改变键盘为手写模式也会走这里,但是如果是手写改成9按键(键盘由高变小),不会走这里。
      debugPrint("didChangeMetrics 键盘完全收起或展开再刷新页面 bottom $bottom keyboardHeight $keyboardHeight isKeyboardShow $isKeyboardShow _preKeyboardShow $_preKeyboardShow");
      times = 0;
      // listener?.call(bottom == 0);
      listener?.call(isKeyboardShow == true);

      ///收起时候保存键盘高度
      if (bottom == 0 && keyboardHeight != 0) {
        saveHeightToSp();
      }
    }
    _preKeyboardShow = isKeyboardShow;
    preBottom = bottom;
  }

  Future<void> saveHeightToSp() async {
    final instance = await SharedPreferences.getInstance();
    instance.setDouble(KEYBOARD_MAX_HEIGHT, keyboardHeight);
  }

  void _getHeightToSp() async {
    if (keyboardHeight == 0) {
      final instance = await SharedPreferences.getInstance();
      keyboardHeight = instance.getDouble(KEYBOARD_MAX_HEIGHT) ?? 0;
      debugPrint(" KeyBoardObserver._() keyboardHeight : $keyboardHeight ");
    }
  }

  ///提供给布局直接使用 虽然你不是实时高度,但是不会出现抖动问题
  Future<double> getKeyBordHeight() async {
    final instance = await SharedPreferences.getInstance();
    return instance.getDouble(KEYBOARD_MAX_HEIGHT) ?? 0;
  }
}


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容