Flutter源碼分析系列(二):Widget數據共享之InheritedWidget

簡介

業務開發中經常會碰到這樣的情況,多個Widget需要同步同一份全局數據,比如點贊數、評論數、夜間模式等等。在安卓中,一般的實現方式是觀察者模式,需要開發者自行實現并維護觀察者的列表。在flutter中,原生提供了用于Widget間共享數據的InheritedWidget,當InheritedWidget發生變化時,它的子樹中所有依賴了它的數據的Widget都會進行rebuild,這使得開發者省去了維護數據同步邏輯的麻煩。

使用范例

先來看下官方注釋中的范例:

class FrogColor extends InheritedWidget {
  const FrogColor({
    Key key,
    @required this.color,
    @required Widget child,
  }) : assert(color != null),
       assert(child != null),
       super(key: key, child: child);
       
  final Color color;
  
  static FrogColor of(BuildContext context) {
    return context.inheritFromWidgetOfExactType(FrogColor);
  }
  
  @override
  bool updateShouldNotify(FrogColor old) => color != old.color;
}

實現比較簡單,直接繼承InheritedWidget即可,類中的color即為需要共享的數據。
此外需要實現updateShouldNotify方法,當InheritedWidget被更新時,該方法會被調用,并傳入更新之前的Widget對象,該方法內需要實現新舊數據的比較,若數據不同需要通知依賴的Widget更新,則返回true。
使用時,可以通過FrogColor.of(context).color獲取到它的值。
下面舉一個具體的例子,簡單的使用場景如下圖所示:

InheritedWidget范例示意圖

將最上層的Widget用InheritedWidget包裝起來,并設置顏色為綠色,子Widget中需要使用該顏色時調用FrogColor.of(context).color來獲取,如圖中的Icon和Image,此時調用該方法獲取到的顏色即為綠色。當InheritedWidget的數據有變化,即通過setState將綠色改為紅色后,依賴了該數據的Icon和Image會自動rebuild,構造新的Widget時,此時從FrogColor.of(context).color獲取到的顏色也會變為紅色,由此便實現了數據的同步。

源碼分析

InheritedWidget

先來看下InheritedWidget的源碼:

abstract class InheritedWidget extends ProxyWidget {
  const InheritedWidget({ Key key, Widget child })
    : super(key: key, child: child);

  @override
  InheritedElement createElement() => new InheritedElement(this);

  @protected
  bool updateShouldNotify(covariant InheritedWidget oldWidget);
}

它繼承自ProxyWidget:

abstract class ProxyWidget extends Widget {
  const ProxyWidget({ Key key, @required this.child }) : super(key: key);

  final Widget child;
}

可以看出Widget內除了實現了createElement方法外沒有其他操作了,它的實現關鍵一定就是InheritedElement了。

InheritedElement

class InheritedElement extends ProxyElement {
  InheritedElement(InheritedWidget widget) : super(widget);

  @override
  InheritedWidget get widget => super.widget;

  // 這個Set記錄了所有依賴的Element
  final Set<Element> _dependents = new HashSet<Element>();

  // 該方法會在Element mount和activate方法中調用,_inheritedWidgets為基類Element中的成員,用于提高Widget查找父節點中的InheritedWidget的效率,它使用HashMap緩存了該節點的父節點中所有相關的InheritedElement,因此查找的時間復雜度為o(1)
  @override
  void _updateInheritance() {
    final Map<Type, InheritedElement> incomingWidgets = _parent?._inheritedWidgets;
    if (incomingWidgets != null)
      _inheritedWidgets = new HashMap<Type, InheritedElement>.from(incomingWidgets);
    else
      _inheritedWidgets = new HashMap<Type, InheritedElement>();
    _inheritedWidgets[widget.runtimeType] = this;
  }

  // 該方法在父類ProxyElement中調用,看名字就知道是通知依賴方該進行更新了,這里首先會調用重寫的updateShouldNotify方法是否需要進行更新,然后遍歷_dependents列表并調用didChangeDependencies方法,該方法內會調用mardNeedsBuild,于是在下一幀繪制流程中,對應的Widget就會進行rebuild,界面也就進行了更新
  @override
  void notifyClients(InheritedWidget oldWidget) {
    if (!widget.updateShouldNotify(oldWidget))
      return;
    for (Element dependent in _dependents) {
      dependent.didChangeDependencies();
    }
  }
}

其中_updateInheritance方法在基類Element中的實現如下:

void _updateInheritance() {
  _inheritedWidgets = _parent?._inheritedWidgets;
}

總結來說就是Element在mount的過程中,如果不是InheritedElement,就簡單的將緩存指向父節點的緩存,如果是InheritedElement,就創建一個緩存的副本,然后將自身添加到該副本中,這樣做會有兩個值得注意的點:

  1. InheritedElement的父節點們是無法查找到自己的,即InheritedWidget的數據只能由父節點向子節點傳遞,反之不能。
  2. 如果某節點的父節點有不止一個同一類型的InheritedWidget,調用inheritFromWidgetOfExactType獲取到的是離自身最近的該類型的InheritedWidget。

看到這里似乎還有一個問題沒有解決,依賴它的Widget是在何時被添加到_dependents這個列表中的呢?
回憶一下從InheritedWidget中取數據的過程,對于InheritedWidget有一個通用的約定就是添加static的of方法,該方法中通過inheritFromWidgetOfExactType找到parent中對應類型的的InheritedWidget的實例并返回,與此同時,也將自己注冊到了依賴列表中,該方法的實現位于Element類,實現如下:

@override
InheritedWidget inheritFromWidgetOfExactType(Type targetType) {
  // 這里通過上述mount過程中建立的HashMap緩存找到對應類型的InheritedElement
  final InheritedElement ancestor = _inheritedWidgets == null ? null : _inheritedWidgets[targetType];
  if (ancestor != null) {
    // 這個列表記錄了當前Element依賴的所有InheritedElement,用于在當前Element deactivate時,將自己從InheritedElement的_dependents列表中移除,避免不必要的更新操作
    _dependencies ??= new HashSet<InheritedElement>();
    _dependencies.add(ancestor);
    // 這里將自己添加到了_dependents列表中,相當于注冊了監聽
    ancestor._dependents.add(this);
    return ancestor.widget;
  }
  _hadUnsatisfiedDependencies = true;
  return null;
}

到此InheritedWidget就分析完了,相比觀察者模式,使用它是不是方便了很多呢?

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,106評論 6 542
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,441評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,211評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,736評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,475評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,834評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,829評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,009評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,559評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,306評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,516評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,038評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,728評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,132評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,443評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,249評論 3 399
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,484評論 2 379

推薦閱讀更多精彩內容

  • 本文介紹了Flutter應用程序中Widget,State,BuildContext和InheritedWidge...
    __white閱讀 2,925評論 1 6
  • 哪有什么完美主義者,完美主義者就是失敗者的另一種飾詞。
    Chrisjiang閱讀 356評論 0 0
  • 讀假期安全提示后,我知道了很多的安全常識,如:父母外出不在家時的居家安全常識、假期出去時游玩的活動安全常識、旅游外...
    _何欣_閱讀 450評論 0 3
  • 令水成冰 凍住包裹的過往 過往如水 匆忙奔去他鄉 他鄉何方? 何方? 人云亦云,匆匆過往 冰封凝結時 回首 消散如...
    糊涂兔adlen閱讀 188評論 0 0