flutter_boost.dart 6.45 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/material.dart';
Yacumima's avatar
dev  
Yacumima committed
28 29
import 'container/boost_container.dart';
import 'container/container_manager.dart';
Jidong Chen's avatar
init  
Jidong Chen committed
30

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

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

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

40
typedef Route PrePushRoute(
Yacumima's avatar
dev  
Yacumima committed
41
    String url, String uniqueId, Map params, Route route);
42 43

typedef void PostPushRoute(
Yacumima's avatar
dev  
Yacumima committed
44
    String url, String uniqueId, Map params, Route route, Future result);
45

Jidong Chen's avatar
init  
Jidong Chen committed
46 47 48 49 50
class FlutterBoost {
  static final FlutterBoost _instance = FlutterBoost();
  final GlobalKey<ContainerManagerState> containerManagerKey =
      GlobalKey<ContainerManagerState>();
  final ObserversHolder _observersHolder = ObserversHolder();
Yacumima's avatar
Yacumima committed
51
  final BoostChannel _boostChannel = BoostChannel();
Jidong Chen's avatar
Jidong Chen committed
52

Jidong Chen's avatar
init  
Jidong Chen committed
53 54 55 56 57
  static FlutterBoost get singleton => _instance;

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

zjq's avatar
zjq committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
  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"]);
        }
      });
    });
  }

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

Jidong Chen's avatar
init  
Jidong Chen committed
88 89 90 91
    return (BuildContext context, Widget child) {
      assert(child is Navigator, 'child must be Navigator, what is wrong?');

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

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

  ObserversHolder get observersHolder => _observersHolder;

Yacumima's avatar
Yacumima committed
107
  BoostChannel get channel => _boostChannel;
Jidong Chen's avatar
Jidong Chen committed
108

zjq's avatar
zjq committed
109
  FlutterBoost() {
Yacumima's avatar
Yacumima committed
110
    ContainerCoordinator(_boostChannel);
Jidong Chen's avatar
Jidong Chen committed
111 112
  }

Jidong Chen's avatar
init  
Jidong Chen committed
113 114 115 116 117 118 119 120 121 122
  ///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);
  }

余玠's avatar
余玠 committed
123
  Future<Map<String, dynamic>> open(String url,
124
      {Map<String, dynamic> urlParams, Map<String, dynamic> exts}) {
余玠's avatar
余玠 committed
125
    Map<String, dynamic> properties = new Map<String, dynamic>();
Yacumima's avatar
Yacumima committed
126 127 128
    properties["url"] = url;
    properties["urlParams"] = urlParams;
    properties["exts"] = exts;
余玠's avatar
余玠 committed
129
    return channel.invokeMethod<Map<String, dynamic>>('openPage', properties);
Jidong Chen's avatar
Jidong Chen committed
130 131
  }

zjq's avatar
zjq committed
132
  Future<bool> close(String id,
133
      {Map<String, dynamic> result, Map<String, dynamic> exts}) {
Yacumima's avatar
Yacumima committed
134
    assert(id != null);
Jidong Chen's avatar
Jidong Chen committed
135

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

zjq's avatar
zjq committed
139
    if (exts == null) {
140
      exts = Map<String, dynamic>();
Jidong Chen's avatar
Jidong Chen committed
141 142 143 144
    }

    exts["params"] = settings.params;

zjq's avatar
zjq committed
145
    if (!exts.containsKey("animated")) {
Jidong Chen's avatar
Jidong Chen committed
146 147 148
      exts["animated"] = true;
    }

Yacumima's avatar
Yacumima committed
149
    properties["uniqueId"] = id;
Jidong Chen's avatar
Jidong Chen committed
150

Yacumima's avatar
Yacumima committed
151 152
    if (result != null) {
      properties["result"] = result;
Jidong Chen's avatar
Jidong Chen committed
153
    }
Jidong Chen's avatar
Jidong Chen committed
154

Yacumima's avatar
Yacumima committed
155 156
    if (exts != null) {
      properties["exts"] = exts;
Jidong Chen's avatar
Jidong Chen committed
157
    }
Yacumima's avatar
Yacumima committed
158
    return channel.invokeMethod<bool>('closePage', properties);
Jidong Chen's avatar
init  
Jidong Chen committed
159 160
  }

zjq's avatar
zjq committed
161 162
  Future<bool> closeCurrent(
      {Map<String, dynamic> result, Map<String, dynamic> exts}) {
Jidong Chen's avatar
Jidong Chen committed
163
    BoostContainerSettings settings = containerManager?.onstageSettings;
zjq's avatar
zjq committed
164 165
    if (exts == null) {
      exts = Map<String, dynamic>();
Jidong Chen's avatar
Jidong Chen committed
166 167
    }
    exts["params"] = settings.params;
zjq's avatar
zjq committed
168
    if (!exts.containsKey("animated")) {
Jidong Chen's avatar
Jidong Chen committed
169 170
      exts["animated"] = true;
    }
zjq's avatar
zjq committed
171
    return close(settings.uniqueId, result: result, exts: exts);
Jidong Chen's avatar
init  
Jidong Chen committed
172 173
  }

zjq's avatar
zjq committed
174 175
  Future<bool> closeByContext(BuildContext context,
      {Map<String, dynamic> result, Map<String, dynamic> exts}) {
Jidong Chen's avatar
Jidong Chen committed
176
    BoostContainerSettings settings = containerManager?.onstageSettings;
zjq's avatar
zjq committed
177 178
    if (exts == null) {
      exts = Map<String, dynamic>();
Jidong Chen's avatar
Jidong Chen committed
179 180
    }
    exts["params"] = settings.params;
zjq's avatar
zjq committed
181
    if (!exts.containsKey("animated")) {
Jidong Chen's avatar
Jidong Chen committed
182 183
      exts["animated"] = true;
    }
zjq's avatar
zjq committed
184
    return close(settings.uniqueId, result: result, exts: exts);
Jidong Chen's avatar
init  
Jidong Chen committed
185 186 187 188 189 190 191 192 193 194 195 196
  }

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

  ///register for Container lifecycle callbacks
  VoidCallback addBoostContainerLifeCycleObserver(
          BoostContainerLifeCycleObserver observer) =>
      _observersHolder.addObserver<BoostContainerLifeCycleObserver>(observer);

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