flutter_boost.dart 8.63 KB
Newer Older
Jidong Chen's avatar
init  
Jidong Chen committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * The MIT License (MIT)
 * 
 * Copyright (c) 2019 Alibaba Group
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
import 'dart:async';
25
import 'dart:io';
Jidong Chen's avatar
init  
Jidong Chen committed
26

27
import 'package:flutter/cupertino.dart';
Jidong Chen's avatar
init  
Jidong Chen committed
28
import 'package:flutter/material.dart';
Yacumima's avatar
dev  
Yacumima committed
29
import 'container/boost_container.dart';
30
import 'container/container_coordinator.dart';
Yacumima's avatar
dev  
Yacumima committed
31
import 'container/container_manager.dart';
Jidong Chen's avatar
init  
Jidong Chen committed
32

Yacumima's avatar
Yacumima committed
33
import 'channel/boost_channel.dart';
Jidong Chen's avatar
init  
Jidong Chen committed
34 35 36 37 38
import 'container/container_coordinator.dart';
import 'observers_holders.dart';

export 'container/boost_container.dart';
export 'container/container_manager.dart';
39
export 'flutter_boost_api.dart';
Jidong Chen's avatar
init  
Jidong Chen committed
40 41 42

typedef Widget PageBuilder(String pageName, Map params, String uniqueId);

43 44
typedef Route PrePushRoute(String url, String uniqueId, Map params,
    Route route);
45

46 47 48 49
typedef void PostPushRoute(String url, String uniqueId, Map params, Route route,
    Future result);

typedef Route FlutterBoostRouteBuilder(Widget widget);
50

Jidong Chen's avatar
init  
Jidong Chen committed
51 52 53
class FlutterBoost {
  static final FlutterBoost _instance = FlutterBoost();
  final GlobalKey<ContainerManagerState> containerManagerKey =
54
  GlobalKey<ContainerManagerState>();
Jidong Chen's avatar
init  
Jidong Chen committed
55
  final ObserversHolder _observersHolder = ObserversHolder();
Yacumima's avatar
Yacumima committed
56
  final BoostChannel _boostChannel = BoostChannel();
Jidong Chen's avatar
Jidong Chen committed
57

Jidong Chen's avatar
init  
Jidong Chen committed
58 59 60 61 62
  static FlutterBoost get singleton => _instance;

  static ContainerManagerState get containerManager =>
      _instance.containerManagerKey.currentState;

zjq's avatar
zjq committed
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
  static void onPageStart() {
    WidgetsBinding.instance.addPostFrameCallback((_) {
      singleton.channel.invokeMethod<Map>('pageOnStart').then((Map pageInfo) {
        if (pageInfo == null || pageInfo.isEmpty) return;

        if (pageInfo.containsKey("name") &&
            pageInfo.containsKey("params") &&
            pageInfo.containsKey("uniqueId")) {
          ContainerCoordinator.singleton.nativeContainerDidShow(
              pageInfo["name"], pageInfo["params"], pageInfo["uniqueId"]);
        }
      });
    });
  }

78 79 80
  static TransitionBuilder init({TransitionBuilder builder,
    PrePushRoute prePush,
    PostPushRoute postPush}) {
zjq's avatar
zjq committed
81
    if (Platform.isAndroid) {
zjq's avatar
zjq committed
82 83 84
      onPageStart();
    } else if (Platform.isIOS) {
      assert(() {
85
            () async {
zjq's avatar
zjq committed
86 87 88 89
          onPageStart();
        }();
        return true;
      }());
90 91
    }

Jidong Chen's avatar
init  
Jidong Chen committed
92 93 94 95
    return (BuildContext context, Widget child) {
      assert(child is Navigator, 'child must be Navigator, what is wrong?');

      final BoostContainerManager manager = BoostContainerManager(
96 97 98 99
          key: _instance.containerManagerKey,
          initNavigator: child,
          prePushRoute: prePush,
          postPushRoute: postPush);
Jidong Chen's avatar
init  
Jidong Chen committed
100 101 102 103 104 105 106 107 108 109 110

      if (builder != null) {
        return builder(context, manager);
      } else {
        return manager;
      }
    };
  }

  ObserversHolder get observersHolder => _observersHolder;

Yacumima's avatar
Yacumima committed
111
  BoostChannel get channel => _boostChannel;
Jidong Chen's avatar
Jidong Chen committed
112

zjq's avatar
zjq committed
113
  FlutterBoost() {
Yacumima's avatar
Yacumima committed
114
    ContainerCoordinator(_boostChannel);
Jidong Chen's avatar
Jidong Chen committed
115 116
  }

Jidong Chen's avatar
init  
Jidong Chen committed
117 118 119 120 121 122 123 124 125 126
  ///Register a default page builder.
  void registerDefaultPageBuilder(PageBuilder builder) {
    ContainerCoordinator.singleton.registerDefaultPageBuilder(builder);
  }

  ///Register a map builders
  void registerPageBuilders(Map<String, PageBuilder> builders) {
    ContainerCoordinator.singleton.registerPageBuilders(builders);
  }

justin's avatar
justin committed
127
  Future<Map<dynamic, dynamic>> open(String url,
128
      {Map<String, dynamic> urlParams,
129
        Map<String, dynamic> exts}) {
余玠's avatar
余玠 committed
130
    Map<String, dynamic> properties = new Map<String, dynamic>();
Yacumima's avatar
Yacumima committed
131 132 133
    properties["url"] = url;
    properties["urlParams"] = urlParams;
    properties["exts"] = exts;
134 135
    return channel.invokeMethod<Map<dynamic, dynamic>>('openPage', properties);
  }
136 137


138 139 140 141 142 143 144 145 146
  /**
   *
   * when flutter page->flutter page,do not open the new Activity Container
   *
   **/
  Future<Map<dynamic, dynamic>> openInCurrentContainer(String url,
      {Map<String, dynamic> urlParams,
        Map<String, dynamic> exts,
        FlutterBoostRouteBuilder routeBuilder}) {
147

148 149 150
//    if(!ContainerCoordinator.singleton.isFlutterPageUrl(url)){
//      return open(url, urlParams: urlParams, exts: exts);
//    }
151 152 153 154 155 156 157 158

    String  uniqueId='${url}_${DateTime.now().millisecondsSinceEpoch}';

    final Widget page = ContainerCoordinator.singleton.createPage(
        url, urlParams, uniqueId);

    final Route<Map<dynamic, dynamic>> route = routeBuilder != null
        ? routeBuilder(page)
159 160 161
        : defaultRoute(page);

    FlutterBoost.containerManager?.onstageContainer?.multipleRouteMode = true;
162 163 164 165 166

    return FlutterBoost.containerManager?.onstageContainer?.push(route);

  }

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
  Route<Map<dynamic, dynamic>> defaultRoute(Widget page) {
    if (Platform.isIOS) {
      return CupertinoPageRoute<Map<dynamic, dynamic>> (
        builder: (BuildContext context) => page
      );
    }

    return MaterialPageRoute<Map<dynamic, dynamic>>(builder: (BuildContext context) => page);

//    PageRouteBuilder<Map<dynamic, dynamic>>(
//        pageBuilder: (BuildContext context,
//            Animation<double> animation,
//            Animation<double> secondaryAnimation,) =>
//        page)
  }

183
  /**
184
   * close flutter page but not close container if there has more than one page in contaienr
185 186 187
   */
  bool closeInCurrentContainer<T extends Object>([T result]) {
    return FlutterBoost.containerManager?.onstageContainer?.pop(result);
Jidong Chen's avatar
Jidong Chen committed
188 189
  }

zjq's avatar
zjq committed
190
  Future<bool> close(String id,
191
      {Map<String, dynamic> result, Map<String, dynamic> exts}) {
192 193 194 195 196 197 198 199 200 201 202

    //判断当前onStage的容器是不是通过openInCurrentContainer打开过界面
    if (FlutterBoost.containerManager?.onstageContainer?.multipleRouteMode ?? false) {
      return Future.value(closeInCurrentContainer(result));
    }

    return closeInternal(id, result: result, exts: exts);
  }

  Future<bool> closeInternal(String id,
      {Map<String, dynamic> result, Map<String, dynamic> exts}) {
Yacumima's avatar
Yacumima committed
203
    assert(id != null);
Jidong Chen's avatar
Jidong Chen committed
204

Jidong Chen's avatar
Jidong Chen committed
205
    BoostContainerSettings settings = containerManager?.onstageSettings;
余玠's avatar
余玠 committed
206
    Map<String, dynamic> properties = new Map<String, dynamic>();
Jidong Chen's avatar
Jidong Chen committed
207

zjq's avatar
zjq committed
208
    if (exts == null) {
209
      exts = Map<String, dynamic>();
Jidong Chen's avatar
Jidong Chen committed
210 211 212 213
    }

    exts["params"] = settings.params;

zjq's avatar
zjq committed
214
    if (!exts.containsKey("animated")) {
Jidong Chen's avatar
Jidong Chen committed
215 216 217
      exts["animated"] = true;
    }

Yacumima's avatar
Yacumima committed
218
    properties["uniqueId"] = id;
Jidong Chen's avatar
Jidong Chen committed
219

Yacumima's avatar
Yacumima committed
220 221
    if (result != null) {
      properties["result"] = result;
Jidong Chen's avatar
Jidong Chen committed
222
    }
Jidong Chen's avatar
Jidong Chen committed
223

Yacumima's avatar
Yacumima committed
224 225
    if (exts != null) {
      properties["exts"] = exts;
Jidong Chen's avatar
Jidong Chen committed
226
    }
Yacumima's avatar
Yacumima committed
227
    return channel.invokeMethod<bool>('closePage', properties);
228

Jidong Chen's avatar
init  
Jidong Chen committed
229 230
  }

231 232


zjq's avatar
zjq committed
233 234
  Future<bool> closeCurrent(
      {Map<String, dynamic> result, Map<String, dynamic> exts}) {
Jidong Chen's avatar
Jidong Chen committed
235
    BoostContainerSettings settings = containerManager?.onstageSettings;
zjq's avatar
zjq committed
236 237
    if (exts == null) {
      exts = Map<String, dynamic>();
Jidong Chen's avatar
Jidong Chen committed
238 239
    }
    exts["params"] = settings.params;
zjq's avatar
zjq committed
240
    if (!exts.containsKey("animated")) {
Jidong Chen's avatar
Jidong Chen committed
241 242
      exts["animated"] = true;
    }
zjq's avatar
zjq committed
243
    return close(settings.uniqueId, result: result, exts: exts);
Jidong Chen's avatar
init  
Jidong Chen committed
244 245
  }

zjq's avatar
zjq committed
246 247
  Future<bool> closeByContext(BuildContext context,
      {Map<String, dynamic> result, Map<String, dynamic> exts}) {
Jidong Chen's avatar
Jidong Chen committed
248
    BoostContainerSettings settings = containerManager?.onstageSettings;
zjq's avatar
zjq committed
249 250
    if (exts == null) {
      exts = Map<String, dynamic>();
Jidong Chen's avatar
Jidong Chen committed
251 252
    }
    exts["params"] = settings.params;
zjq's avatar
zjq committed
253
    if (!exts.containsKey("animated")) {
Jidong Chen's avatar
Jidong Chen committed
254 255
      exts["animated"] = true;
    }
zjq's avatar
zjq committed
256
    return close(settings.uniqueId, result: result, exts: exts);
Jidong Chen's avatar
init  
Jidong Chen committed
257 258 259 260 261 262 263 264
  }

  ///register for Container changed callbacks
  VoidCallback addContainerObserver(BoostContainerObserver observer) =>
      _observersHolder.addObserver<BoostContainerObserver>(observer);

  ///register for Container lifecycle callbacks
  VoidCallback addBoostContainerLifeCycleObserver(
265
      BoostContainerLifeCycleObserver observer) =>
Jidong Chen's avatar
init  
Jidong Chen committed
266 267 268
      _observersHolder.addObserver<BoostContainerLifeCycleObserver>(observer);

  ///register callbacks for Navigators push & pop
yangwu.jia's avatar
yangwu.jia committed
269 270
  void addBoostNavigatorObserver(NavigatorObserver observer) =>
      ContainerNavigatorObserver.boostObservers.add(observer);
Jidong Chen's avatar
init  
Jidong Chen committed
271
}