Flutter 路由源码解析
前言
这是博客《Flutter路由 - Navigator 》的番外篇，若是你没有看过主篇真的不建议你直接看这篇文章，由于它真的炒鸡炒鸡枯燥乏味……node
不讲客套话啦，咱们分别从Navigator的push和pop两个方法去探索源码以及一些重要的细节。bash
push
当咱们想要push一个Page在界面上时，咱们能够调用以下代码：ide
Navigator.push(
context,
PageRouteBuilder(pageBuilder: (context, animation, secondaryAnimation) {
return MyPage(args);
}));
复制代码
咱们以Navigator.push(BuildContext context, Route<T> route)方法为起始进行追述：post
static Future<T> push<T extends Object>(BuildContext context, Route<T> route) {
return Navigator.of(context).push(route);
}
复制代码
1.NavigatorState对象检索
就像上篇文章有提到过的，Navigator.push是一个静态方法，使得你能够在任何地方进行调用，其内部经过of方法在Element树（BuildContext是 Element的抽象类）中进行向上搜索。咱们看下Navigator.of方法：动画
static NavigatorState of(
BuildContext context, {
bool rootNavigator = false,
bool nullOk = false,
}) {
final NavigatorState navigator = rootNavigator
? context.rootAncestorStateOfType(const TypeMatcher<NavigatorState>())
: context.ancestorStateOfType(const TypeMatcher<NavigatorState>());
return navigator;
}
复制代码
主要经过rootNavigator变量判断是否要检索根部Navigator，rootAncestorStateOfType向上查找最根部匹配类型对象，ancestorStateOfType向上查找最近的匹配类型对象。从这个方法咱们也能够知道Navigator.of方法查找的不是Navigator而是NavigatorState,这个也比较容易理解，Navigator是一个StatefulWidget,具体的逻辑都在它的State对象当中。ui
2.push实现
接下来看NavigatorState.push实现：this
//0
final List<Route<dynamic>> _history = <Route<dynamic>>[];
Future<T> push<T extends Object>(Route<T> route) {
...
//1
final Route<dynamic> oldRoute = _history.isNotEmpty ? _history.last : null;
//2
route._navigator = this;
//3
route.install(_currentOverlayEntry);
//4
_history.add(route);
//5
route.didPush();
route.didChangeNext(null);
if (oldRoute != null) {
oldRoute.didChangeNext(route);
route.didChangePrevious(oldRoute);
}
//6
for (NavigatorObserver observer in widget.observers)
observer.didPush(route, oldRoute);
_afterNavigation();
return route.popped;
}
复制代码
-
0.
_history就是Navigator所维护的界面栈，但它只是一个普通的List。spa -
- 获取本来在栈顶的route，由于
_history是一个普通的List，因此栈顶就是最后一个元素。
- 获取本来在栈顶的route，由于
-
2.让新加入的
route和Navigator引用绑定。debug -
3.
install是route转换为OverlayEntry，并插入到List<OverlayEntry>中的重要过程，_currentOverlayEntry是oldRoute对应的OverlayEntry,传入_currentOverlayEntry的意思是插入到它的上面。具体细节咱们稍后细讲。code -
4.
route入栈。 -
5.完成新老界面的转换，内部有一些事件和动画处理。
-
6.通知全部的
Navigator观察者。
3. route.install
咱们最关心的是第3步，route.install(_currentOverlayEntry); Route类里这个方法是一个空实现，具体细节在它的子类中，咱们重点看OverlayRoute的实现：
abstract class OverlayRoute<T> extends Route<T> {
...
@override
List<OverlayEntry> get overlayEntries => _overlayEntries;
final List<OverlayEntry> _overlayEntries = <OverlayEntry>[];
@override
void install(OverlayEntry insertionPoint) {
_overlayEntries.addAll(createOverlayEntries());
navigator.overlay?.insertAll(_overlayEntries, above: insertionPoint);
super.install(insertionPoint);
}
...
复制代码
一个Route的_overlayEntries 一般包含两个OverlayEntry，一个是遮罩，一个是界面自己，都在createOverlayEntries中建立。
先对_overlayEntries完成两个OverlayEntry的add,而后调用navigator所持有的overlay对象，将遮罩和界面插入到overlay所持有的List<OverlayEntry>中，以备绘制到界面之上。
4. createOverlayEntries
这是Route到OverlayEntry的关键,具体的实如今ModalRoute中：
abstract class ModalRoute<T> extends TransitionRoute<T> with LocalHistoryRoute<T> {
...
@override
Iterable<OverlayEntry> createOverlayEntries() sync* {
yield _modalBarrier = OverlayEntry(builder: _buildModalBarrier);
yield OverlayEntry(builder: _buildModalScope, maintainState: maintainState);
}
...
复制代码
对yield语法不熟悉不要紧，你只要知道这个方法最终会返回两个OverlayEntry对象就行了。_modalBarrier就是遮罩层，就是Dialog那个背景遮罩。
咱们重点关心第二个page的建立。OverlayEntry中传入两个参数：
-
builder：这是一个function, 咱们自定义的Page建立就在这个方法之中。
-
maintainState: 这个属性咱们在上篇博客有讲，表示当这个 Widget 不可见时，是否须要继续保持它的状态，是否须要让它继续活着。一般一个 Page
maintainState为true， Dialog 为 false。
5. _buildModalScope
看下_buildModalScope实现:
Widget _buildModalScope(BuildContext context) {
return _modalScopeCache ??= _ModalScope<T>(
key: _scopeKey,
route: this,
// _ModalScope calls buildTransitions() and buildChild(), defined above
);
}
复制代码
_buildModalScope建立了一个 Widget _ModalScope，并将Route本身传了进去。_ModalScope是个啥呢？
_ModalScope 是一个StatefulWidget,咱们直接看它的 State的build方法：
@override
Widget build(BuildContext context) {
return _ModalScopeStatus(
route: widget.route,
isCurrent: widget.route.isCurrent, // _routeSetState is called if this updates
canPop: widget.route.canPop, // _routeSetState is called if this updates
child: Offstage(
offstage: widget.route.offstage, // _routeSetState is called if this updates
child: PageStorage(
bucket: widget.route._storageBucket, // immutable
child: FocusScope(
node: widget.route.focusScopeNode, // immutable
child: RepaintBoundary(
child: AnimatedBuilder(
animation: _listenable, // immutable
builder: (BuildContext context, Widget child) {
return widget.route.buildTransitions(
context,
widget.route.animation,
widget.route.secondaryAnimation,
IgnorePointer(
ignoring: widget.route.animation?.status == AnimationStatus.reverse,
child: child,
),
);
},
child: _page ??= RepaintBoundary(
key: widget.route._subtreeKey, // immutable
child: Builder( // ======！！！重点关注这个代码！！！！！！
builder: (BuildContext context) {
return widget.route.buildPage(
context,
widget.route.animation,
widget.route.secondaryAnimation,
);
...
复制代码
能够看到_ModalScope内部又嵌套了不少Widget，而且建立所用的数据都来自Route，咱们重点关注最后一个Builder,能够看到它最后return 调用的是 route的buildPage方法，眼熟吗？就是咱们最开始调用push方法传入的自定义PageRouteBuilder对象：
Navigator.push(
context,
PageRouteBuilder(pageBuilder: (context, animation, secondaryAnimation) {
return MyPage(args);
}));
复制代码
到这里你知道你的传入的 Route 是如何被使用的了。
咱们回头看一下Route转化为OverlayEntry以后，Overlay是如何处理的：
6. 插入到Overlay中
以前咱们是这样插入到overlay中的:navigator.overlay?.insertAll(_overlayEntries, above: insertionPoint); navigator.overlay实际是OverlayState
class OverlayState extends State<Overlay> with TickerProviderStateMixin {
...
void insertAll(Iterable<OverlayEntry> entries, { OverlayEntry above }) {
...
//1
for (OverlayEntry entry in entries) {
entry._overlay = this;
}
//2
setState(() {
final int index = above == null ? _entries.length : _entries.indexOf(above) + 1;
_entries.insertAll(index, entries);
});
}
...
复制代码
-
- 将每个要插入到集合中的
OverlayEntry绑定自身，绑定自身的缘由是咱们上篇文章所讲的：元素自治。 插入是由Overlay中进行的，但删除倒是每一个元素本身调用的。
- 将每个要插入到集合中的
-
- 看到了熟悉的
setState((){}方法，集合插入完成后，将触发Overlay的 rebuild。
- 看到了熟悉的
因此接下来咱们看一下 OverlayState 的 build方法：
@override
Widget build(BuildContext context) {
//1
final List<Widget> onstageChildren = <Widget>[];
final List<Widget> offstageChildren = <Widget>[];
bool onstage = true;
//2
for (int i = _entries.length - 1; i >= 0; i -= 1) {
final OverlayEntry entry = _entries[i];
//3
if (onstage) {
//4
onstageChildren.add(_OverlayEntry(entry));
if (entry.opaque)
onstage = false;
//5
} else if (entry.maintainState) {
offstageChildren.add(TickerMode(enabled: false, child: _OverlayEntry(entry)));
}
}
//6
return _Theatre(
//7
onstage: Stack(
fit: StackFit.expand,
children: onstageChildren.reversed.toList(growable: false),
),
//8
offstage: offstageChildren,
);
}
复制代码
-
1.建立两个空列表，分别存储“台上”将要被绘制的，和“台下”不须要绘制的 Widget。
-
2.开始遍历全部的OverlayEntry，准备将他们分配到两个集合当中。值得注意的是，这里是倒序遍历，后加入的元素绘制到最上层。
-
3.最开始每一个
OverlayEntry都是有机会被绘制的，直到某个OverlayEntry的opaque=true，其余OverlayEntry没有机会“上台“了 -
4.能够看到
OverlayEntry被当作参数传给了_OverlayEntry,完成了一个纯 Dart 类到 Widget 的转换。_OverlayEntry代码很简单，它将根据OverlayEntry中的属性进行 build。 -
5.没有机会上台的
OverlayEntry开始判断maintainState值，须要保存的状态的进入offstageChildren,不须要的保存状态的，没有机会参与这一次的 build ，他们将被销毁。 -
6.分配结束以后，进入剧场：
_Theatre。 -
7.台上须要被绘制的进入
Stack组件，准备绘制。 -
8.不须要被绘制的，只会进行build。
至此，新push的Page完成了建立和绘制。
pop
看完了 push , 咱们在看一下 pop：
1.pop
bool pop<T extends Object>([ T result ]) {
...
//1
final Route<dynamic> route = _history.last;
bool debugPredictedWouldPop;
//2
if (route.didPop(result ?? route.currentResult)) {
if (_history.length > 1) {
//3
_history.removeLast();
if (route._navigator != null)
_poppedRoutes.add(route);
//4
_history.last.didPopNext(route);
//5
for (NavigatorObserver observer in widget.observers)
observer.didPop(route, _history.last);
} else {
return false;
}
} else {
...
}
_afterNavigation();
return true;
}
复制代码
-
1.获取集合末尾，也就是栈顶的
route，它将被pop。 -
2.能够看到
didPop是有返回值的，也就说若是返回了 false，是能够不弹出的。若是返回了 true，didPop内部有一些销毁处理，咱们稍后看。 -
3.若是
didPop返回了 true, 会作出栈处理。 -
4.通知下一个route 你回到前台了。
-
5.通知全部的观察者。
2.didPop
咱们重点关注 Page 回收的处理，因此看一下OverlayRoute中的 didPop：
abstract class OverlayRoute<T> extends Route<T> {
...
@override
bool didPop(T result) {
final bool returnValue = super.didPop(result);
if (finishedWhenPopped)
navigator.finalizeRoute(this);
return returnValue;
}
复制代码
看一下navigator.finalizeRoute
void finalizeRoute(Route<dynamic> route) {
...
route.dispose();
}
复制代码
↓
abstract class OverlayRoute<T> extends Route<T> {
...
@override
void dispose() {
for (OverlayEntry entry in _overlayEntries)
entry.remove();
_overlayEntries.clear();
super.dispose();
}
复制代码
能够看到遍历执行了全部OverlayEntry的remove方法：
void remove() {
//1
final OverlayState overlay = _overlay;
_overlay = null;
//2
if (SchedulerBinding.instance.schedulerPhase == SchedulerPhase.persistentCallbacks) {
SchedulerBinding.instance.addPostFrameCallback((Duration duration) {
//3
overlay._remove(this);
});
} else {
overlay._remove(this);
}
}
复制代码
-
1.清楚引用，避免内存泄露
-
2.判断一下当前调度机状态，稍后或马上执行
OverlayState的_remove方法.
void _remove(OverlayEntry entry) {
if (mounted) {
_entries.remove(entry);
setState(() { /* entry was removed */ });
}
}
复制代码
从集合中清楚当前的OverlayEntry,并触发一次 Overlay 的rebuild，由于_entries已经没有当前界面了，rebuild以后也就天然不会存在了。
结语
好啦，push和pop的代码流程都过完啦~
- 1. Flutter 路由源码解析
- 2. flask 源码解析：路由
- 3. Flutter 路由原理解析
- 4. jFinal路由解析源码分析
- 5. express源码分析-路由
- 6. zuul路由转发源码解析
- 7. 源码解析flask的路由系统
- 8. Flutter之Navigator源码解析
- 9. Flutter 界面路由浅析
- 10. Flutter进阶：路由、路由栈详解及案例分析
- 更多相关文章...
- • XML DOM 解析器 - XML DOM 教程
- • TCP报文格式解析 - TCP/IP教程
- • Scala 中文乱码解决
- • 互联网组织的未来：剖析GitHub员工的任性之源
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. Flutter 路由源码解析
- 2. flask 源码解析：路由
- 3. Flutter 路由原理解析
- 4. jFinal路由解析源码分析
- 5. express源码分析-路由
- 6. zuul路由转发源码解析
- 7. 源码解析flask的路由系统
- 8. Flutter之Navigator源码解析
- 9. Flutter 界面路由浅析
- 10. Flutter进阶：路由、路由栈详解及案例分析