經過解決一個flutter的路由錯誤來深刻理解BuildContext

前言

在使用flutter路由跳轉是出現以下錯誤：

代碼：

import 'package:flutter/material.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context){
    return new MaterialApp(
      title: 'Test Flutter',
      home: Scaffold(
        body: Center(
          child: FlatButton(
              onPressed: () {
                Navigator.of(context).push(
                    MaterialPageRoute(builder: (context) => NewRouter()));
              },
              child: Text('跳轉')),
        ),
      ),
    );
  }
}
class NewRouter extends StatelessWidget {
  @override
  Widget build (BuildContext context){
    return Scaffold(
      appBar: AppBar(
        title: Text("hahahha"),
      ),
      body: Center(
        child: Text("new router hahah"),
      ),
    );
  }
}

解決方案

把home部分做爲一個新的Widget拆出來就能夠了。

import 'package:flutter/material.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context){
    return new MaterialApp(
      title: 'Test Flutter',
      home: new MyHomeWidget(),
    );
  }
}

class MyHomeWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context){
    return new Scaffold(
      appBar: AppBar(title: Text('new Flutter'),),
      body: new Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.start,
            children: <Widget>[
              Text('my first flutter app'),
              FlatButton(
                color: Colors.green,
                child: Text('路由跳轉'),
                textColor: Colors.white,
                onPressed: () {
                  Navigator.push(context, 
                    MaterialPageRoute(builder: (context){
                      return NewRouter();
                    })
                  );
                },
              )
            ]
          ),
          
        ),
    );
  }
}
class NewRouter extends StatelessWidget {
  @override
  Widget build (BuildContext context){
    return Scaffold(
      appBar: AppBar(
        title: Text("hahahha"),
      ),
      body: Center(
        child: Text("new router hahah"),
      ),
    );
  }
}

爲何個人Navigator操做會出現當前的context找不到Navigator的狀況，爲何拆成新的widget就行了？

那下面就來具體分析一下

Navigator

咱們常常會在應用中打開許多頁面，當咱們返回的時候，它會前後退到上一個打開的頁面，而後一層一層後退，沒錯這就是一個堆棧。而在Flutter中，則是由Navigator來負責管理維護這些頁面堆棧。

//壓一個新的頁面到屏幕上
Navigator.of(context).push
//把路由頂層的頁面移除
Navigator.of(context).pop

一般咱們咱們在構建應用的時候並無手動去建立一個Navigator，也能進行頁面導航，這又是爲何呢。

沒錯，這個Navigator正是MaterialApp爲咱們提供的。可是若是home，routes，onGenerateRoute和onUnknownRoute都爲null，而且builder不爲null，MaterialApp則不會建立任何Navigator。

BuildContext

每次咱們在編寫界面部分代碼的時候，都是在build函數中進行操做。而build函數則須要默認傳入一個BuildContext。咱們來看看這究竟是啥

abstract class BuildContext {
  /// The current configuration of the [Element] that is this [BuildContext].
  Widget get widget;

  /// The [BuildOwner] for this context. The [BuildOwner] is in charge of
  /// managing the rendering pipeline for this context.
  BuildOwner get owner;
  ...

咱們能夠看到BuildContext實際上是一個抽象類，可是每次build函數傳進來的是什麼呢。咱們來看看構建視圖的時候到底發生了什麼。

BuildContext

每次咱們在編寫界面部分代碼的時候，都是在build函數中進行操做。而build函數則須要默認傳入一個BuildContext。咱們來看看這究竟是啥。

abstract class BuildContext {
  /// The current configuration of the [Element] that is this [BuildContext].
  Widget get widget;

  /// The [BuildOwner] for this context. The [BuildOwner] is in charge of
  /// managing the rendering pipeline for this context.
  BuildOwner get owner;
  ...

咱們能夠看到BuildContext實際上是一個抽象類，可是每次build函數傳進來的是什麼呢。咱們來看看構建視圖的時候到底發生了什麼。

Flutter如何構建視圖

在Flutter中，Everything is Widget，咱們經過構造函數嵌套Widget來編寫UI界面。實際上，Widget並非真正要顯示在屏幕上的東西,只是一個配置信息，它永遠是immutable的，而且能夠在多處重複使用。那真正顯示在屏幕上的視圖樹是什麼呢？Element Tree！

那咱們來看一下，在構建視圖的時候究竟發生了什麼。這裏以Stateless Widget爲例。

abstract class StatelessWidget extends Widget {
  const StatelessWidget({ Key key }) : super(key: key);
  @override
  StatelessElement createElement() => StatelessElement(this);
  ...

當要把這個widget裝進視圖樹的時候，首先會去createElement，並將當前widget傳給Element。

咱們再來看一看這個StatelessElement是什麼

class StatelessElement extends ComponentElement {
  /// Creates an element that uses the given widget as its configuration.
  StatelessElement(StatelessWidget widget) : super(widget);

  @override
  StatelessWidget get widget => super.widget;

  @override
  Widget build() => widget.build(this);

  @override
  void update(StatelessWidget newWidget) {
    super.update(newWidget);
    assert(widget == newWidget);
    _dirty = true;
    rebuild();
  }
}

咱們能夠看到，經過將widget傳入StatelessElement的構造函數，StatelessElement保留了widget的引用，而且將會調用build方法。

而這個build方法真正調用的則是widget的build方法，並將this，也就是該StatelessElement對象傳入。咱們知道，build方法須要傳入的是一個BuildContext，爲何傳進去了StatelessElement？因而咱們繼續看。

class StatelessElement extends ComponentElement
...
abstract class ComponentElement extends Element
...
abstract class Element extends DiagnosticableTree implements BuildContext

其實是Element類實現了BuildContext，並由ComponentElement -> StatelessElement 繼承。

因此咱們如今再來看官方對於BuildContext的解釋:

BuildContextobjects are actually Elementobjects. The BuildContextinterface is used to discourage direct manipulation of Elementobjects.

BuildContext對象實際上就是Element對象，BuildContext 接口用於阻止對 Element 對象的直接操做。

Cool！咱們如今終於知道這個BuildContext是哪裏來的了。讓咱們再來梳理一下，flutter構建視圖究竟作了什麼。

視圖樹裝載過程

StatelessWidget

• 首先它會調用StatelessWidget的 createElement 方法，並根據這個widget生成StatelesseElement對象。
• 將這個StatelesseElement對象掛載到element樹上。
• StatelesseElement對象調用widget的build方法，並將element自身做爲BuildContext傳入。

StatefulWidget

• 首先一樣也是調用StatefulWidget的 createElement方法，並根據這個widget生成StatefulElement對象，並保留widget引用。
• 將這個StatefulElement掛載到Element樹上。
• 根據widget的 createState 方法建立State。
• StatefulElement對象調用state的build方法，並將element自身做爲BuildContext傳入。

因此咱們在build函數中所使用的context，正是當前widget所建立的Element對象。

of(context)方法

在flutter中咱們常常會使用到這樣的代碼

//打開一個新的頁面
Navigator.of(context).push
//打開Scaffold的Drawer
Scaffold.of(context).openDrawer
//獲取display1樣式文字主題
Theme.of(context).textTheme.display1

那麼這個of(context)究竟是個什麼呢。咱們這裏以Navigator打開新頁面爲例。

static NavigatorState of(
    BuildContext context, {
      bool rootNavigator = false,
      bool nullOk = false,
    }) {
//關鍵代碼-----------------------------------------v
    
    final NavigatorState navigator = rootNavigator
        ? context.rootAncestorStateOfType(const TypeMatcher<NavigatorState>())
        : context.ancestorStateOfType(const TypeMatcher<NavigatorState>());
        
//關鍵代碼----------------------------------------^
    assert(() {
      if (navigator == null && !nullOk) {
        throw FlutterError(
          'Navigator operation requested with a context that does not include a Navigator.\n'
          'The context used to push or pop routes from the Navigator must be that of a '
          'widget that is a descendant of a Navigator widget.'
        );
      }
      return true;
    }());
    return navigator;
  }

能夠看到，關鍵代碼部分經過context.rootAncestorStateOfType向上遍歷 Element tree，並找到最近匹配的 NavigatorState。也就是說of其實是對context跨組件獲取數據的一個封裝。

而咱們的Navigator的 push操做就是經過找到的 NavigatorState 來完成的。

不只如此，BuildContext還有許多方法能夠跨組件獲取對象

ancestorInheritedElementForWidgetOfExactType(Type targetType) → InheritedElement

ancestorRenderObjectOfType(TypeMatcher matcher) → RenderObject

ancestorStateOfType(TypeMatcher matcher) → State

ancestorWidgetOfExactType(Type targetType) → Widget

findRenderObject() → RenderObject

inheritFromElement(InheritedElement ancestor, { Object aspect }) → InheritedWidget

inheritFromWidgetOfExactType(Type targetType, { Object aspect }) → InheritedWidget

rootAncestorStateOfType(TypeMatcher matcher) → State

visitAncestorElements(bool visitor(Element element)) → void

visitChildElements(ElementVisitor visitor) → void

須要注意的是，在 State 中 initState階段是沒法跨組件拿數據的，只有在didChangeDependencies以後纔可使用這些方法。