一种更优雅的Flutter Dialog解决方案

时间  2020-12-06
标签 html git github web redux 网络 app 框架 less 异步 栏目 HTML 繁體版
原文   原文链接

前言

系统自带的Dialog实际上就是Push了一个新页面，这样存在不少好处，可是也存在一些很难解决的问题html

  • 必须传BuildContextgit

    • loading弹窗通常都封装在网络框架中，多传个context参数就很头疼；用fish_redux还好，effect层直接能拿到context，要是用bloc还得在view层把context传到bloc或者cubit里面。。。

  • 没法穿透暗色背景，点击dialog后面的页面github

    • 这个是真头痛，想了不少办法，都没能在自带的dialog上面解决这个问题

  • 系统自带Dialog写成的Loading弹窗，在网络请求和跳转页面的状况，会存在路由混乱的状况web

    • 情景复盘：loading库通常封装在网络层，某个页面提交完表单，要跳转页面，提交操做完成，进行页面跳转，loading关闭是在异步回调中进行（onError或者onSuccess），会出现执行了跳转操做时，弹窗还未关闭，延时一小会关闭，由于用的都是pop页面方法，会把跳转的页面pop掉
    • 上面是一种很常见的场景，涉及到复杂场景更加难以预测，解决方法也有：定位页面栈的栈顶是不是Loading弹窗，选择性Pop，实现麻烦

上面这些痛点，简直个个致命，固然，还存在一些其它的解决方案，例如：redux

  • 页面顶级使用Stack
  • 使用Overlay

很明显，使用Overlay可移植性最好，目前不少Toast和dialog三方库即是使用该方案，使用了一些loading库，看了其中源码，穿透背景解决方案，和预期想要的效果截然不同、一些dialog库自带toast显示，可是toast显示却又不能和dialog共存（toast属于特殊的信息展现，理应能独立存在），致使我须要多依赖一个Toast库网络

SmartDialog

基于上面那些难以解决的问题，只能本身去实现，花了一些时间，实现了一个Pub包，基本该解决的痛点都已解决了，用于实际业务没什么问题app

效果

smartDialog

引入

dependencies:
  flutter_smart_dialog: any

使用

  • 主入口配置框架

    • 在主入口这地方须要配置下，这样就能够不传BuildContext使用Dialog了
    • 只须要在MaterialApp的builder参数处配置下便可
void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: SmartDialogPage(),
      builder: (BuildContext context, Widget child) {
        return Material(
          type: MaterialType.transparency,
          child: FlutterSmartDialog(child: child),
        );
      },
    );
  }
}

使用FlutterSmartDialog包裹下child便可，下面就能够愉快的使用SmartDialog了less

  • 使用Toast异步

    • msg：必传信息
    • time：可选，Duration类型
    • alignment：可选，控制toast位置
    • 若是想使用花里胡哨的Toast效果，使用show方法定制就好了，炒鸡简单喔，懒得本身写的，抄下个人ToastWidget，改下属性就好了哈
SmartDialog.showToast('test toast');

  • 使用Loading

    • msg：可选，loading动画下面的文字信息（默认：加载中...）
//open loading
SmartDialog.showLoading();

//delay off
await Future.delayed(Duration(seconds: 2));
SmartDialog.dismiss();

  • 自定义dialog

    • 使用SmartDialog.instance.show()方法便可，里面含有众多'Temp'为后缀的参数，和下述无'Temp'为后缀的参数功能一致
    • 特殊属性isUseExtraWidget：是否使用额外覆盖浮层，可与主浮层独立开；可与loading，dialog之类独立开，自带的showToast即是开启了该配置，可与loading共存
SmartDialog.show(
    alignmentTemp: Alignment.bottomCenter,
    clickBgDismissTemp: true,
    widget: Container(
      color: Colors.blue,
      height: 300,
    ),
);

  • SmartDialog配置参数说明

    • 为了不instance里面暴露过多属性，致使使用不便，此处诸多参数使用instance中的config属性管理
    • 使用config设置的属性都是全局的，将这些属性单独使用Config管理，是为了方便修改和管理这些属性，也是为了使SmartDialog类更易维护
参数 功能说明
alignment 控制自定义控件位于屏幕的位置<br/>Alignment.center: 自定义控件位于屏幕中间，且是动画默认为：渐隐和缩放，可以使用isLoading选择动画<br/>Alignment.bottomCenter、Alignment.bottomLeft、Alignment.bottomRight：自定义控件位于屏幕底部，动画默认为位移动画，自下而上，可以使用animationDuration设置动画时间<br/>Alignment.topCenter、Alignment.topLeft、Alignment.topRight：自定义控件位于屏幕顶部，动画默认为位移动画，自上而下，可以使用animationDuration设置动画时间<br/>Alignment.centerLeft：自定义控件位于屏幕左边，动画默认为位移动画，自左而右，可以使用animationDuration设置动画时间<br/> Alignment.centerRight：自定义控件位于屏幕左边，动画默认为位移动画，自右而左，可以使用animationDuration设置动画时间
isPenetrate 默认:false；是否穿透遮罩背景,交互遮罩以后控件，true：点击能穿透背景，false：不能穿透；穿透遮罩设置为true，背景遮罩会自动变成透明（必须）
clickBgDismiss 默认：false；点击遮罩，是否关闭dialog---true：点击遮罩关闭dialog，false：不关闭
maskColor 遮罩颜色
animationDuration 动画时间
isUseAnimation 默认：true；是否使用动画
isLoading 默认：true；是否使用Loading动画；true:内容体使用渐隐动画 false：内容体使用缩放动画，仅仅针对中间位置的控件
isExist 默认：false；主体SmartDialog（OverlayEntry）是否存在在界面上
isExistExtra 默认：false；额外SmartDialog（OverlayEntry）是否存在在界面上

  • Config属性使用，举个栗子

    • 内部已初始化相关属性；若是须要定制，可在主入口处，初始化本身想要的属性
SmartDialog.instance.config
    ..clickBgDismiss = true
    ..isLoading = true
    ..isUseAnimation = true
    ..animationDuration = Duration(milliseconds: 270)
    ..isPenetrate = true
    ..maskColor = Colors.black.withOpacity(0.1)
    ..isExist = false
    ..isExistExtra = false
    ..alignment = Alignment.center;
  • 返回事件，关闭弹窗解决方案

使用Overlay的依赖库，基本都存在一个问题，难以对返回事件的监听，致使触犯返回事件难以关闭弹窗布局之类，想了不少办法，没办法在依赖库中解决该问题，此处提供一个BaseScaffold，在每一个页面使用BaseScaffold，便能解决返回事件关闭Dialog问题

typedef ScaffoldParamVoidCallback = void Function();

class BaseScaffold extends StatefulWidget {
    const BaseScaffold({
        Key key,
        this.appBar,
        this.body,
        this.floatingActionButton,
        this.floatingActionButtonLocation,
        this.floatingActionButtonAnimator,
        this.persistentFooterButtons,
        this.drawer,
        this.endDrawer,
        this.bottomNavigationBar,
        this.bottomSheet,
        this.backgroundColor,
        this.resizeToAvoidBottomPadding,
        this.resizeToAvoidBottomInset,
        this.primary = true,
        this.drawerDragStartBehavior = DragStartBehavior.start,
        this.extendBody = false,
        this.extendBodyBehindAppBar = false,
        this.drawerScrimColor,
        this.drawerEdgeDragWidth,
        this.drawerEnableOpenDragGesture = true,
        this.endDrawerEnableOpenDragGesture = true,
        this.isTwiceBack = false,
        this.isCanBack = true,
        this.onBack,
    })  : assert(primary != null),
    assert(extendBody != null),
    assert(extendBodyBehindAppBar != null),
    assert(drawerDragStartBehavior != null),
    super(key: key);

    ///系统Scaffold的属性
    final bool extendBody;
    final bool extendBodyBehindAppBar;
    final PreferredSizeWidget appBar;
    final Widget body;
    final Widget floatingActionButton;
    final FloatingActionButtonLocation floatingActionButtonLocation;
    final FloatingActionButtonAnimator floatingActionButtonAnimator;
    final List<Widget> persistentFooterButtons;
    final Widget drawer;
    final Widget endDrawer;
    final Color drawerScrimColor;
    final Color backgroundColor;
    final Widget bottomNavigationBar;
    final Widget bottomSheet;
    final bool resizeToAvoidBottomPadding;
    final bool resizeToAvoidBottomInset;
    final bool primary;
    final DragStartBehavior drawerDragStartBehavior;
    final double drawerEdgeDragWidth;
    final bool drawerEnableOpenDragGesture;
    final bool endDrawerEnableOpenDragGesture;

    ///增长的属性
    ///点击返回按钮提示是否退出页面,快速点击俩次才会退出页面
    final bool isTwiceBack;

    ///是否能够返回
    final bool isCanBack;

    ///监听返回事件
    final ScaffoldParamVoidCallback onBack;

    @override
    _BaseScaffoldState createState() => _BaseScaffoldState();
}

class _BaseScaffoldState extends State<BaseScaffold> {
    //上次点击时间
    DateTime _lastPressedAt; 

    @override
    Widget build(BuildContext context) {
        return WillPopScope(
            child: Scaffold(
                appBar: widget.appBar,
                body: widget.body,
                floatingActionButton: widget.floatingActionButton,
                floatingActionButtonLocation: widget.floatingActionButtonLocation,
                floatingActionButtonAnimator: widget.floatingActionButtonAnimator,
                persistentFooterButtons: widget.persistentFooterButtons,
                drawer: widget.drawer,
                endDrawer: widget.endDrawer,
                bottomNavigationBar: widget.bottomNavigationBar,
                bottomSheet: widget.bottomSheet,
                backgroundColor: widget.backgroundColor,
                resizeToAvoidBottomPadding: widget.resizeToAvoidBottomPadding,
                resizeToAvoidBottomInset: widget.resizeToAvoidBottomInset,
                primary: widget.primary,
                drawerDragStartBehavior: widget.drawerDragStartBehavior,
                extendBody: widget.extendBody,
                extendBodyBehindAppBar: widget.extendBodyBehindAppBar,
                drawerScrimColor: widget.drawerScrimColor,
                drawerEdgeDragWidth: widget.drawerEdgeDragWidth,
                drawerEnableOpenDragGesture: widget.drawerEnableOpenDragGesture,
                endDrawerEnableOpenDragGesture: widget.endDrawerEnableOpenDragGesture,
            ),
            onWillPop: _dealWillPop,
        );
    }

    ///控件返回按钮
    Future<bool> _dealWillPop() async {
        if (widget.onBack != null) {
            widget.onBack();
        }

        //处理弹窗问题
        if (SmartDialog.instance.config.isExist) {
            SmartDialog.dismiss();
            return false;
        }

        //若是不能返回，后面的逻辑就不走了
        if (!widget.isCanBack) {
            return false;
        }

        if (widget.isTwiceBack) {
            if (_lastPressedAt == null ||
                DateTime.now().difference(_lastPressedAt) > Duration(seconds: 1)) {
                //两次点击间隔超过1秒则从新计时
                _lastPressedAt = DateTime.now();

                //弹窗提示
                SmartDialog.showToast("再点一次退出");
                return false;
            }
            return true;
        } else {
            return true;
        }
    }
}

几个问题解决方案

穿透背景

  • 穿透背景有俩个解决方案，这里都说明下

AbsorbPointer、IgnorePointer

当时想解决穿透暗色背景，和背景后面的控件互动的时候，我几乎立马想到这俩个控件，先了解下这俩个控件吧

  • AbsorbPointer

    • 阻止子树接收指针事件，AbsorbPointer自己能够响应事件，消耗掉事件

    • absorbing 属性（默认true）

      • true：拦截向子Widget传递的事件 false：不拦截
AbsorbPointer(
    absorbing: true,
    child: Listener(
        onPointerDown: (event){
            print('+++++++++++++++++++++++++++++++++');
        },
    )
)

  • IgnorePointer

    • 阻止子树接收指针事件，IgnorePointer自己没法响应事件，其下的控件能够接收到点击事件（父控件）

    • ignoring 属性（默认true）

      • true：拦截向子Widget传递的事件 false：不拦截
IgnorePointer(
    ignoring: true,
    child: Listener(
        onPointerDown: (event){
            print('----------------------------------');
        },
    )
)

分析

  • 这里来分析下，首先AbsorbPointer这个控件是不合适的，由于AbsorbPointer自己会消费触摸事件，事件被AbsorbPointer消费掉，会致使背景后的页面没法获取到触摸事件；IgnorePointer自己没法消费触摸事件，又因为IgnorePointer和AbsorbPointer都具备屏蔽子Widget获取触摸事件的做用，这个貌似靠谱，这里试了，能够和背景后面的页面互动！可是又存在一个十分坑的问题
  • 由于使用IgnorePointer屏蔽子控件的触摸事件，而IgnorePointer自己又不消耗触摸事件，会致使没法获取到背景的点击事件！这样点击背景会没法关闭dialog弹窗，只能手动关闭dialog；各类尝试，实在没办法获取到背景的触摸事件，此种穿透背景的方案只能放弃

Listener、behavior

这种方案，成功实现想要的穿透效果，这里了解下behavior的几种属性

  • deferToChild：仅当一个孩子被命中测试击中时，屈服于其孩子的目标才会在其范围内接收事件
  • opaque：不透明目标可能会受到命中测试的打击，致使它们既在其范围内接收事件，又在视觉上阻止位于其后方的目标也接收事件
  • translucent：半透明目标既能够接收其范围内的事件，也能够在视觉上容许目标后面的目标也接收事件

有戏了！很明显translucent是有但愿的，尝试了几回，而后成功实现了想要的效果

注意，这边有几个坑点，提一下

  • 务必使用Listener控件来使用behavior属性，使用GestureDetector中behavior属性会存在一个问题，通常来讲：都是Stack控件里面的Children，里面有俩个控件，分上下层，在此处，GestureDetector设置behavior属性，俩个GestureDetector控件上下叠加，会致使下层GestureDetector获取不到触摸事件，很奇怪；使用Listener不会产生此问题
  • 咱们的背景使用Container控件，我这里设置了Colors.transparent，直接会致使下层接受不到触摸事件，color为空才能使下层控件接受到触摸事件，此处不要设置color便可

下面是写的一个验证小示例

class TestLayoutPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return _buildBg(children: [
      //下层
      Listener(
        onPointerDown: (event) {
          print('下层蓝色区域++++++++');
        },
        child: Container(
          height: 300,
          width: 300,
          color: Colors.blue,
        ),
      ),

      //上层 事件穿透
      Listener(
        behavior: HitTestBehavior.translucent,
        onPointerDown: (event) {
          print('上层区域---------');
        },
        child: Container(
          height: 200,
          width: 200,
        ),
      ),
    ]);
  }

  Widget _buildBg({List<Widget> children}) {
    return Scaffold(
      appBar: AppBar(title: Text('测试布局')),
      body: Center(
        child: Stack(
          alignment: Alignment.center,
          children: children,
        ),
      ),
    );
  }
}

Toast和Loading冲突

  • 这个问题，从理论上确定会存在的，由于通常Overlay库只会使用一个OverlayEntry控件，这会致使，全局只能存在一个浮窗布局，Toast本质是一个全局弹窗，Loading也是一个全局弹窗，使用其中一个都会致使另外一个消失

  • Toast明显是应该独立于其余弹窗的一个消息提示，封装在网络库中的关闭弹窗的dismiss方法，也会将Toast消息在不适宜的时候关闭，在实际开发中就碰到此问题，只能多引用一个Toast三方库来解决，在规划这个dialog库的时候，就想到必须解决此问题

    • 此处内部多使用了一个OverlayEntry来解决该问题，提供了相关参数来分别控制，完美使Toast独立于其它的dialog弹窗
    • 多增长一个OverlayEntry都会让内部逻辑和方法使用急剧复杂，维护也会变得不可预期，故额外只多提供一个OverlayEntry；若是须要更多，可copy本库，自行定义，实现该库相关源码，都力求能让人看明白，相信你们copy使用时不会感到晦涩难懂
  • FlutterSmartDialog提供OverlayEntry和OverlayEntryExtra能够高度自定义，相关实现，可查看内部实现
  • FlutterSmartDialog内部已进行相关实现，使用show()方法中的isUseExtraWidget区分

最后

这个库花了一些时间去构思和实现，算是解决几个很大的痛点

  • 若是你们对返回事件有什么好的处理思路，麻烦在评论里告知，谢谢！

FlutterSmartDialog一些信息

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程