Merge pull request #24 from MMMzq/dev

Dev

Author: MMMzq

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [2.2.0]
+* 重构底层的实现方式以规避一些隐晦的bug
+
+* Refactor the underlying implementation to avoid some hidden bugs
+
 ## [2.1.1]
 * showSimpleNotification和showNotification方法添加`onTap`,`onLongPress`参数
 

README.md

@@ -51,7 +51,7 @@ Loading|Text|CustomWidget
 #### 1. add dependencies into you project pubspec.yaml file
 ``` dart
 dependencies:
-     bot_toast: ^2.1.1
+     bot_toast: ^2.2.0
 ```
 
 #### 2. import BotToast lib

README_zh.md

@@ -55,7 +55,7 @@ Loading|Text|CustomWidget
 #### 1. pubspec.yaml文件里添加依赖
 ``` dart
 dependencies:
-     bot_toast: ^2.1.0
+     bot_toast: ^2.2.0
 ```
 
 #### 2. 导入BotToast库

example/android/gradle.properties

@@ -1 +1,2 @@
 org.gradle.jvmargs=-Xmx1536M
+android.enableR8=true

example/lib/main.dart

@@ -42,7 +42,7 @@ class EnterPage extends StatelessWidget {
           alignment: Alignment.topCenter,
           child: SingleChildScrollView(
             child: Container(
-              margin: EdgeInsets.only(top: 5),
+              margin: EdgeInsets.only(top: 30),
               child: Column(children: <Widget>[
                 Text(
                   "Notification",

lib/bot_toast.dart

@@ -2,5 +2,5 @@ library bot_toast;
 
 export 'src/basis.dart';
 export 'src/bot_toast_init.dart' show BotToastInit;
-export 'src/toast.dart';
+export 'src/toast.dart' hide safeRun;
 export 'src/toast_navigator_observer.dart';

lib/src/bot_toast_init.dart

@@ -1,24 +1,32 @@
 import 'package:flutter/material.dart';
 
-final GlobalKey<_BotToastInitState> botToastInitKey =
-GlobalKey<_BotToastInitState>();
+import 'bot_toast_manager.dart';
+
+final GlobalKey<BotToastInitState> _botToastInitKey =
+GlobalKey<BotToastInitState>();
+
+BotToastManager get botToastManager {
+  assert(_botToastInitKey?.currentState?._botToastManager != null);
+  return _botToastInitKey.currentState._botToastManager;
+}
 
 class BotToastInit extends StatefulWidget {
   final Widget child;
 
   BotToastInit({@required this.child})
       : assert(child != null),
-        super(key: botToastInitKey);
+        super(key: _botToastInitKey);
 
   @override
-  _BotToastInitState createState() => _BotToastInitState();
+  BotToastInitState createState() => BotToastInitState();
 }
 
-class _BotToastInitState extends State<BotToastInit> {
+class BotToastInitState extends State<BotToastInit> {
   bool _needInit;
-
   bool get needInit => _needInit;
 
+  BotToastManager _botToastManager;
+
   void reset() {
     _needInit = false;
   }
@@ -32,9 +40,16 @@ class _BotToastInitState extends State<BotToastInit> {
   @override
   void initState() {
     _needInit = true;
+    _botToastManager = BotToastManager(this);
     super.initState();
   }
 
+  @override
+  void dispose() {
+    _botToastManager.dispose();
+    super.dispose();
+  }
+
   @override
   void didUpdateWidget(BotToastInit oldWidget) {
     _needInit = true;

lib/src/bot_toast_manager.dart

@@ -1,60 +1,146 @@
+import 'package:bot_toast/src/toast_widget/toast_widget.dart';
 import 'package:flutter/material.dart';
+import '../bot_toast.dart';
+import 'bot_toast_init.dart';
+import 'toast.dart';
 
-class BotToastManager extends StatefulWidget {
-  const BotToastManager({Key key}) : super(key: key);
 
-  @override
-  BotToastManagerState createState() => BotToastManagerState();
-}
+class BotToastManager {
+  final Map<String, Map<UniqueKey, OverlayEntry>> _map = {};
+  NavigatorState _navigatorState;
+  BotToastNavigatorObserverProxy _observerProxy;
+  BotToastInitState botToastInitState;
+
+  BotToastManager(this.botToastInitState);
 
-class BotToastManagerState extends State<BotToastManager> {
-  final Map<String, Map<UniqueKey, IndexedSemantics>> _map = {};
-  int index = 0;
 
-  @override
-  Widget build(BuildContext context) {
-    List<IndexedSemantics> children = _map.values.fold([], (value, items) {
-      return value..addAll(items.values);
+  void dispose() {
+    if (_observerProxy != null) {
+      BotToastNavigatorObserver.unregister(_observerProxy);
+    }
+    _children.forEach((item) {
+      item.remove();
     });
-    children.sort((a, b) => a.index.compareTo(b.index));
-    return Stack(children: children);
+    _children.clear();
   }
 
-  ///这里不使用传进来的key,是因为该key在这里担当的是一个UUid的职责,
-  ///不应该用在widget里面,
-  ///那为什么有需要自己new 一个UniqueKey()
-  ///这表明这个Widget在这里面是独一无二的,
-  ///这会防止一些隐晦的bug,
-  ///例如:如果不加入该UniqueKey将会导致
-  ///[BotToast.showEnhancedWidget]onlyOne功能失效,
-  ///主要是因为flutter,只是根据runtimeType来进行判断的话
-  ///会导致调错了各个Toast的dispose
-  void insert(String groupKey, UniqueKey key, Widget widget) {
-    setState(() {
-      _map[groupKey] ??= {};
-      _map[groupKey][key] = IndexedSemantics(
-        index: index++,
-        child: widget,
-        key: UniqueKey(),
+
+  ///需要监听didPush是因为,当Navigator的Route集合为空再推一个Route会导致这个页面覆盖_BotToastManager上面,挡住了Toast,因此要手动移动到最后
+  ///在1.7.8版本以下,一般是在使用[Navigator.pushAndRemoveUntil]才可能发生这种情况
+  void _checkNavigatorState(BuildContext context) {
+    assert(BotToastNavigatorObserver.debugInitialization, """
+    Please initialize properly!
+    Example:
+    BotToastInit(
+      child: MaterialApp(
+        title: 'BotToast Demo',
+        navigatorObservers: [BotToastNavigatorObserver()],
+        home: XxxPage()
+      ),
+    );
+    """);
+
+    void visitor(Element element) {
+      assert(() {
+        if (element.widget is Localizations &&
+            ((element as StatefulElement).state as dynamic).locale == null) {
+          return false;
+        }
+        return true;
+      }(), 'Initialization error : locale==null');
+      if (element.widget is Navigator) {
+        if (_navigatorState == null ||
+            _navigatorState != (element as StatefulElement).state) {
+          _navigatorState = (element as StatefulElement).state;
+        }
+      } else {
+        element.visitChildElements(visitor);
+      }
+    }
+
+    context.visitChildElements(visitor);
+
+    assert(_navigatorState != null, '''
+         Initialization error.
+         The initialization method has been modified in version 2.0.
+         do you wrapped you app widget like this?
+         
+         BotToastInit(
+               child: MaterialApp(
+                 navigatorObservers: [BotToastNavigatorObserver()],
+                 home: XxxPage(),
+               ),
+             );
+      ''');
+
+
+
+    if (_observerProxy == null) {
+      _observerProxy = BotToastNavigatorObserverProxy(
+        didPush: (route, _) {
+          if (route.isFirst && _children.isNotEmpty) {
+            _navigatorState.overlay
+                .rearrange(_children, below: _children.first);
+          }
+        },
       );
+      BotToastNavigatorObserver.register(_observerProxy);
+    }
+  }
+
+  List<OverlayEntry> get _children =>
+      _map.values.fold([], (value, items) {
+        return value..addAll(items.values);
+      });
+
+
+  void insert(String groupKey, UniqueKey key, Widget widget) {
+    _map[groupKey] ??= {};
+    final uniqueKey = UniqueKey();
+    final overlayEntry = OverlayEntry(builder: (_) =>
+        ProxyDispose(key: uniqueKey, child: widget, disposeCallback: () {
+          _map[groupKey]?.remove(key);
+        },));
+    _map[groupKey][key] = overlayEntry;
+    safeRun(() {
+      assert(botToastInitState != null);
+      if (botToastInitState.needInit) {
+        botToastInitState.reset();
+        _checkNavigatorState(botToastInitState.context);
+      }
+      _navigatorState.overlay.insert(overlayEntry);
     });
   }
 
   void remove(String groupKey, UniqueKey key) {
-    setState(() {
-      _map[groupKey]?.remove(key);
+    safeRun(() {
+      final result = _map[groupKey]?.remove(key);
+      if (result != null) {
+        result.remove();
+      }
     });
   }
 
   void removeAll(String groupKey) {
-    setState(() {
+    safeRun(() {
+      _map[groupKey]?.forEach((key, value) {
+        assert(value != null);
+        value.remove();
+      });
       _map[groupKey]?.clear();
     });
   }
 
   void cleanAll() {
-    setState(() {
+    safeRun(() {
+      List<OverlayEntry> children = _children;
+      assert(children.every((test) => test != null));
+      children.forEach((item) {
+        item.remove();
+      });
       _map.clear();
     });
   }
 }
+
+