flutter_boost.dart 6.88 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 28

import 'package:flutter/material.dart';

Yacumima's avatar
Yacumima committed
29
import 'channel/boost_channel.dart';
30
import 'container/boost_container.dart';
Jidong Chen's avatar
init  
Jidong Chen committed
31
import 'container/container_coordinator.dart';
32
import 'container/container_manager.dart';
Jidong Chen's avatar
init  
Jidong Chen committed
33 34 35 36 37
import 'observers_holders.dart';

export 'container/boost_container.dart';
export 'container/container_manager.dart';

38 39
typedef PageBuilder = Widget Function(
    String pageName, Map<String, dynamic> params, String uniqueId);
Jidong Chen's avatar
init  
Jidong Chen committed
40

41 42
typedef PrePushRoute = Route<T> Function<T>(String url, String uniqueId,
    Map<String, dynamic> params, Route<dynamic> route);
43

44 45 46 47 48 49 50
typedef PostPushRoute = void Function(
  String url,
  String uniqueId,
  Map<String, dynamic> params,
  Route<dynamic> route,
  Future<dynamic> result,
);
51

Jidong Chen's avatar
init  
Jidong Chen committed
52
class FlutterBoost {
53 54 55 56
  FlutterBoost() {
    ContainerCoordinator(_boostChannel);
  }

Jidong Chen's avatar
init  
Jidong Chen committed
57
  static final FlutterBoost _instance = FlutterBoost();
Jidong Chen's avatar
Jidong Chen committed
58

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

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

64 65 66 67
  final GlobalKey<ContainerManagerState> containerManagerKey =
      GlobalKey<ContainerManagerState>();
  final ObserversHolder _observersHolder = ObserversHolder();
  final BoostChannel _boostChannel = BoostChannel();
zjq's avatar
zjq committed
68

69 70 71
  static void onPageStart() {
    WidgetsBinding.instance.addPostFrameCallback((Duration _) {
      singleton.channel
72 73 74
          .invokeMethod<Map<dynamic, dynamic>>('pageOnStart')
          .then((Map<dynamic, dynamic> _pageInfo) {
        final Map<String, dynamic> pageInfo = _pageInfo?.cast<String, dynamic>();
75 76 77 78 79 80
        if (pageInfo?.isEmpty ?? true) {
          return;
        }
        if (pageInfo.containsKey('name') &&
            pageInfo.containsKey('params') &&
            pageInfo.containsKey('uniqueId')) {
zjq's avatar
zjq committed
81
          ContainerCoordinator.singleton.nativeContainerDidShow(
82 83 84 85 86
            pageInfo['name'] as String,
            (pageInfo['params'] as Map<dynamic, dynamic>)
                ?.cast<String, dynamic>(),
            pageInfo['uniqueId'] as String,
          );
zjq's avatar
zjq committed
87 88 89 90 91
        }
      });
    });
  }

92 93 94 95 96
  static TransitionBuilder init({
    TransitionBuilder builder,
    PrePushRoute prePush,
    PostPushRoute postPush,
  }) {
justin's avatar
justin committed
97
    if (Platform.isAndroid) {
zjq's avatar
zjq committed
98 99
      onPageStart();
    } else if (Platform.isIOS) {
100
      // TODO(AlexVincent525): 未解之谜
zjq's avatar
zjq committed
101 102 103 104 105 106
      assert(() {
        () async {
          onPageStart();
        }();
        return true;
      }());
107 108
    }

Jidong Chen's avatar
init  
Jidong Chen committed
109 110 111 112
    return (BuildContext context, Widget child) {
      assert(child is Navigator, 'child must be Navigator, what is wrong?');

      final BoostContainerManager manager = BoostContainerManager(
113 114 115 116 117
        key: _instance.containerManagerKey,
        initNavigator: child as Navigator,
        prePushRoute: prePush,
        postPushRoute: postPush,
      );
Jidong Chen's avatar
init  
Jidong Chen committed
118 119 120 121 122 123 124 125 126 127 128

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

  ObserversHolder get observersHolder => _observersHolder;

Yacumima's avatar
Yacumima committed
129
  BoostChannel get channel => _boostChannel;
Jidong Chen's avatar
Jidong Chen committed
130

131
  /// Register a default page builder.
Jidong Chen's avatar
init  
Jidong Chen committed
132 133 134 135
  void registerDefaultPageBuilder(PageBuilder builder) {
    ContainerCoordinator.singleton.registerDefaultPageBuilder(builder);
  }

136
  /// Register a map builders
Jidong Chen's avatar
init  
Jidong Chen committed
137 138 139 140
  void registerPageBuilders(Map<String, PageBuilder> builders) {
    ContainerCoordinator.singleton.registerPageBuilders(builders);
  }

141
  Future<Map<dynamic, dynamic>> open(
142 143 144 145 146 147 148 149
    String url, {
    Map<String, dynamic> urlParams,
    Map<String, dynamic> exts,
  }) {
    final Map<String, dynamic> properties = <String, dynamic>{};
    properties['url'] = url;
    properties['urlParams'] = urlParams;
    properties['exts'] = exts;
150
    return channel.invokeMethod<Map<dynamic, dynamic>>('openPage', properties);
Jidong Chen's avatar
Jidong Chen committed
151 152
  }

153 154 155 156 157
  Future<bool> close(
    String id, {
    Map<String, dynamic> result,
    Map<String, dynamic> exts,
  }) {
Yacumima's avatar
Yacumima committed
158
    assert(id != null);
Jidong Chen's avatar
Jidong Chen committed
159

160 161
    final BoostContainerSettings settings = containerManager?.onstageSettings;
    final Map<String, dynamic> properties = <String, dynamic>{};
Jidong Chen's avatar
Jidong Chen committed
162

163
    exts ??= <String, dynamic>{};
Jidong Chen's avatar
Jidong Chen committed
164

165
    exts['params'] = settings.params;
Jidong Chen's avatar
Jidong Chen committed
166

167 168
    if (!exts.containsKey('animated')) {
      exts['animated'] = true;
Jidong Chen's avatar
Jidong Chen committed
169 170
    }

171
    properties['uniqueId'] = id;
Jidong Chen's avatar
Jidong Chen committed
172

Yacumima's avatar
Yacumima committed
173
    if (result != null) {
174
      properties['result'] = result;
Jidong Chen's avatar
Jidong Chen committed
175
    }
Jidong Chen's avatar
Jidong Chen committed
176

Yacumima's avatar
Yacumima committed
177
    if (exts != null) {
178
      properties['exts'] = exts;
Jidong Chen's avatar
Jidong Chen committed
179
    }
Yacumima's avatar
Yacumima committed
180
    return channel.invokeMethod<bool>('closePage', properties);
Jidong Chen's avatar
init  
Jidong Chen committed
181 182
  }

183 184 185 186 187 188 189 190 191
  Future<bool> closeCurrent({
    Map<String, dynamic> result,
    Map<String, dynamic> exts,
  }) {
    final BoostContainerSettings settings = containerManager?.onstageSettings;
    exts ??= <String, dynamic>{};
    exts['params'] = settings.params;
    if (!exts.containsKey('animated')) {
      exts['animated'] = true;
Jidong Chen's avatar
Jidong Chen committed
192
    }
justin's avatar
justin committed
193
    return close(settings.uniqueId, result: result, exts: exts);
Jidong Chen's avatar
init  
Jidong Chen committed
194 195
  }

196 197 198 199 200 201 202 203 204 205
  Future<bool> closeByContext(
    BuildContext context, {
    Map<String, dynamic> result,
    Map<String, dynamic> exts,
  }) {
    final BoostContainerSettings settings = containerManager?.onstageSettings;
    exts ??= <String, dynamic>{};
    exts['params'] = settings.params;
    if (!exts.containsKey('animated')) {
      exts['animated'] = true;
Jidong Chen's avatar
Jidong Chen committed
206
    }
justin's avatar
justin committed
207
    return close(settings.uniqueId, result: result, exts: exts);
Jidong Chen's avatar
init  
Jidong Chen committed
208 209
  }

210
  /// Register for Container changed callbacks
Jidong Chen's avatar
init  
Jidong Chen committed
211 212 213
  VoidCallback addContainerObserver(BoostContainerObserver observer) =>
      _observersHolder.addObserver<BoostContainerObserver>(observer);

214
  /// Register for Container lifecycle callbacks
Jidong Chen's avatar
init  
Jidong Chen committed
215 216 217 218
  VoidCallback addBoostContainerLifeCycleObserver(
          BoostContainerLifeCycleObserver observer) =>
      _observersHolder.addObserver<BoostContainerLifeCycleObserver>(observer);

219
  /// Register callbacks for [Navigator.push] & [Navigator.pop]
yangwu.jia's avatar
yangwu.jia committed
220 221
  void addBoostNavigatorObserver(NavigatorObserver observer) =>
      ContainerNavigatorObserver.boostObservers.add(observer);
Jidong Chen's avatar
init  
Jidong Chen committed
222
}