說說Flutter中的無名英雄 —— Focus

Focus Deer

Focus系列的Widget及功能類在Flutter中可以說是無名英雄的存在,默默的付出但卻不太為人所知。在日常開發(fā)使用中也不太會用到它,這是為什么呢?帶著這個問題我們開始今天的內(nèi)容。

1.Focus相關(guān)介紹

這里大致介紹一些Focus相關(guān)Widget及功能類,便于后面理解Focus Tree部分。本篇源碼基于1.20.0-2.0.pre。

1.1 FocusNode

FocusNode是用于Widget獲取鍵盤焦點(diǎn)和處理鍵盤事件的對象。它是繼承自ChangeNotifier,所以我們可以在任意位置獲取對應(yīng)的FocusNode信息。

下面說幾個FocusNode常用方法:

  • requestFocus用作請求焦點(diǎn),注意這個請求焦點(diǎn)的執(zhí)行放在了scheduleMicrotask中,因此結(jié)果可能會延遲最多一幀。

  • unfocus用作取消焦點(diǎn),默認(rèn)行為為UnfocusDisposition.scope

void unfocus({UnfocusDisposition disposition = UnfocusDisposition.scope,}) {
  ....
}

UnfocusDisposition枚舉類是焦點(diǎn)取消后的行為,分為scopepreviouslyFocusedChild兩種。

  1. scope表示向上尋找最近的FocusScopeNode

  2. previouslyFocusedChild是尋找上一個焦點(diǎn)位置,如果沒有則給當(dāng)前FocusScopeNode。

具體實(shí)現(xiàn)可見unfocus源碼,這里就不多說了。

  • dispose這個沒啥說的,注意使用FocusNode完后及時銷毀。

1.2 FocusScopeNode

FocusScopeNodeFocusNode的子類。它將FocusNode組織到一個作用域中,形成一組可以遍歷的節(jié)點(diǎn)。它會提供最后一個獲取焦點(diǎn)的FocusNode(focusedChild),如果其中一個節(jié)點(diǎn)的焦點(diǎn)被移除,那么此FocusScopeNode將再次獲得焦點(diǎn),同時_focusedChildren清空。

  /// Returns the child of this node that should receive focus if this scope
  /// node receives focus.
  ///
  /// If [hasFocus] is true, then this points to the child of this node that is
  /// currently focused.
  ///
  /// Returns null if there is no currently focused child.
  FocusNode get focusedChild {
    return _focusedChildren.isNotEmpty ? _focusedChildren.last : null;
  }

  // A stack of the children that have been set as the focusedChild, most recent
  // last (which is the top of the stack).
  final List<FocusNode> _focusedChildren = <FocusNode>[];

注意這里的_focusedChildren并不是FocusScopeNode下出現(xiàn)的所有FocusNode,而是獲取過焦點(diǎn)的FocusNode才會在里面。源碼實(shí)現(xiàn)如下:

  void _setAsFocusedChildForScope() {
    FocusNode scopeFocus = this;
    for (final FocusScopeNode ancestor in ancestors.whereType<FocusScopeNode>()) {
      // 從聚焦的歷史中移除
      ancestor._focusedChildren.remove(scopeFocus);
      // 再將它添加至最后,這樣上面的focusedChild可以獲取到最后獲取過焦點(diǎn)的節(jié)點(diǎn)
      ancestor._focusedChildren.add(scopeFocus);
      scopeFocus = ancestor;
    }
  }

FocusScopeNode比較重要的方法是setFirstFocus,用來設(shè)置子作用域節(jié)點(diǎn)。

  void setFirstFocus(FocusScopeNode scope) {
    if (scope._parent == null) {
      // scope沒有父節(jié)點(diǎn),將scope添加至當(dāng)前節(jié)點(diǎn)下
      _reparent(scope);
    }
    if (hasFocus) {
      // 當(dāng)前作用域存在焦點(diǎn),_doRequestFocus將焦點(diǎn)移到scope上,同時記錄節(jié)點(diǎn)。
      scope._doRequestFocus(findFirstFocus: true);
    } else {
      // 當(dāng)前作用域不存在焦點(diǎn),記錄節(jié)點(diǎn)。
      scope._setAsFocusedChildForScope();
    }
  }

1.3 Focus

Focus是一個Widget,可以用來分配焦點(diǎn)給它本身及其子Widget。內(nèi)部管理著一個FocusNode,監(jiān)聽焦點(diǎn)的變化,來保持焦點(diǎn)層次結(jié)構(gòu)與Widget層次結(jié)構(gòu)同步。

我們常用的InkWell就使用了它,而Button、 Chip等大量的Widget又使用了InkWell,所以Focus可以說是無處不在。

我們來看一下InkResponse源碼:

InkResponse源碼

這里發(fā)現(xiàn)了Focus,我們看看它的onFocusChange實(shí)現(xiàn):

  void _handleFocusUpdate(bool hasFocus) {
    _hasFocus = hasFocus;
    _updateFocusHighlights();
    if (widget.onFocusChange != null) {
      widget.onFocusChange(hasFocus);
    }
  }

有焦點(diǎn)變化時修改_hasFocus值調(diào)用_updateFocusHighlights方法。

  void _updateFocusHighlights() {
    bool showFocus;
    switch (FocusManager.instance.highlightMode) {
      case FocusHighlightMode.touch:
        showFocus = false;
        break;
      case FocusHighlightMode.traditional:
        showFocus = _shouldShowFocus;
        break;
    }
    updateHighlight(_HighlightType.focus, value: showFocus);
  }

最終調(diào)用updateHighlight方法讓W(xué)Idget有一個獲取焦點(diǎn)時的高亮顯示。

這里有個枚舉類FocusHighlightMode,它是表示使用何種交互模式獲取的焦點(diǎn)。分為touchtraditional

默認(rèn)的區(qū)分實(shí)現(xiàn)如下:

  static FocusHighlightMode get _defaultModeForPlatform {
    switch (defaultTargetPlatform) {
      case TargetPlatform.android:
      case TargetPlatform.fuchsia:
      case TargetPlatform.iOS:
        if (WidgetsBinding.instance.mouseTracker.mouseIsConnected) {
          return FocusHighlightMode.traditional;
        }
        return FocusHighlightMode.touch;
      case TargetPlatform.linux:
      case TargetPlatform.macOS:
      case TargetPlatform.windows:
        return FocusHighlightMode.traditional;
    }
    return null;
  }

移動端在沒有鼠標(biāo)連接的情況下都是touch,桌面端都為傳統(tǒng)的方式(鍵盤和鼠標(biāo))。

所以這也回答我一開始的問題,我們一般只考慮了移動設(shè)備,也就是touch的部分,這部分其實(shí)我們不太需要給按鈕處理焦點(diǎn)效果,可能類似給Android TV盒子用的這類App才需要。而Flutter提供的Widget需要考慮各個平臺效果,所以才使用了這些。類似在上面的InkResponse源碼中,還出現(xiàn)了MouseRegion這個Widget,它是跟蹤鼠標(biāo)移動的,比如在Web端鼠標(biāo)移動到按鈕上,按鈕會有一個變化效果。

1.4 FocusScope

FocusScopeFocus類似,不過它的內(nèi)部管理的是FocusScopeNode。它不改變主焦點(diǎn),它只是改變了接收焦點(diǎn)的作用域節(jié)點(diǎn)。這個在源碼中使用的不多,但卻都很重要的位置。

比如NavigatorRoute,首先Navigator有一個FocusScope,自動獲取焦點(diǎn)。在它承載的一個個路由上也會添加FocusScope,這樣當(dāng)頁面跳轉(zhuǎn)/Dialog彈框時可以將焦點(diǎn)的作用域移動到上面(通過setFirstFocus方法)。

類似Drawer也是一樣。當(dāng)抽屜打開時,我們的焦點(diǎn)作用域就要移動到Drawer,所以也要使用FocusScope

如果我們要管理焦點(diǎn),在頁面中有一個Stack,上層覆蓋了下層Widget導(dǎo)致下面不可操作。這時我們就可以使用FocusScope將焦點(diǎn)作用域移動至上面。

2.Focus Tree

Flutter里面有按照分類不同存在各種各樣的“樹”,比如常說的三棵樹Widget Tree、Element Tree 和 RenderObject Tree,其他的比如我之前博客說過的Semantics Tree,和這里要介紹的Focus Tree。

Focus Tree是與Widget Tree獨(dú)立開的、結(jié)構(gòu)相對簡單的樹,它是維護(hù)Widget Tree中可聚焦Widget之間的層次關(guān)系。Focus Tree因?yàn)闊o法通過工具來可視化觀察,我們可以使用Focus Tree的管理類FocusManager中的debugDumpFocusTree方法打印出來。

所以這里我新建一個項(xiàng)目,寫一個小例子來看一下。代碼很簡單,Column里一個TextFieldFlatButton 。

class _MyHomePageState extends State<MyHomePage> {

  @override
  Widget build(BuildContext context) {
    return Material(
      child: Column(
        children: [
          TextField(),
          FlatButton(
            child: Text('打印FocusTree'),
            onPressed: () {
              WidgetsBinding.instance.addPostFrameCallback((_) {
                debugDumpFocusTree();
              });
            },
          ),
        ],
      ),
    );
  }
}

點(diǎn)擊按鈕,打印結(jié)果如下:

 FocusManager#4148c
  │ UPDATE SCHEDULED
  │ primaryFocus: FocusScopeNode#af55c(_ModalScopeState<dynamic>
  │   Focus Scope [PRIMARY FOCUS])
  │ nextFocus: FocusScopeNode#4f0d5(Navigator Scope [IN FOCUS PATH])
  │ primaryFocusCreator: FocusScope ← _ActionsMarker ← Actions ←
  │   PageStorage ← Offstage ← _ModalScopeStatus ←
  │   _ModalScope<dynamic>-[LabeledGlobalKey<_ModalScopeState<dynamic>>#bfb70]
  │   ← _EffectiveTickerMode ← TickerMode ←
  │   _OverlayEntryWidget-[LabeledGlobalKey<_OverlayEntryWidgetState>#3fa85]
  │   ← _Theatre ← Overlay-[LabeledGlobalKey<OverlayState>#2d724] ←
  │   _FocusMarker ← Semantics ← FocusScope ← AbsorbPointer ←
  │   _PointerListener ← Listener ← HeroControllerScope ←
  │   Navigator-[GlobalObjectKey<NavigatorState>
  │   _WidgetsAppState#9404f] ← ?
  │
  └─rootScope: FocusScopeNode#185ad(Root Focus Scope [IN FOCUS PATH])
    │ IN FOCUS PATH
    │ focusedChildren: FocusScopeNode#4f0d5(Navigator Scope [IN FOCUS
    │   PATH])
    │
    └─Child 1: FocusNode#5bacc(Shortcuts [IN FOCUS PATH])
      │ context: Focus
      │ NOT FOCUSABLE
      │ IN FOCUS PATH
      │
      └─Child 1: FocusNode#1cd76(FocusTraversalGroup [IN FOCUS PATH])
        │ context: Focus
        │ NOT FOCUSABLE
        │ IN FOCUS PATH
        │
        └─Child 1: FocusScopeNode#4f0d5(Navigator Scope [IN FOCUS PATH])
          │ context: FocusScope
          │ IN FOCUS PATH
          │
          └─Child 1: FocusScopeNode#af55c(_ModalScopeState<dynamic> Focus Scope [PRIMARY FOCUS])
            │ context: FocusScope
            │ PRIMARY FOCUS
            │
            ├─Child 1: FocusNode#e72e2
            │   context: EditableText-[LabeledGlobalKey<EditableTextState>#c2f8a]
            │
            └─Child 2: FocusNode#0b7c0
                context: Focus

我從下往上說一下代表的含義:

  1. Child 1: FocusNode#e72e2Child 2: FocusNode#0b7c0一看就是同級,代表的就是TextFieldFlatButton

  2. 上一層FocusScopeNode#af55c是當(dāng)前的頁面,可以看到焦點(diǎn)目前在它上面(PRIMARY FOCUS)。它是在
    MaterialPageRoute -> PageRoute -> ModalRoute ->createOverlayEntries -> _buildModalScope方法,調(diào)用_ModalScope創(chuàng)建的。

  3. 再上一層FocusScopeNode#4f0d5Navigator,代碼如下:

final FocusScopeNode focusScopeNode = FocusScopeNode(debugLabel: 'Navigator Scope');

@override
  Widget build(BuildContext context) {
    return HeroControllerScope(
      child: Listener(
        onPointerDown: _handlePointerDown,
        onPointerUp: _handlePointerUpOrCancel,
        onPointerCancel: _handlePointerUpOrCancel,
        child: AbsorbPointer(
          absorbing: false,
          child: FocusScope(
            node: focusScopeNode, // <---
            autofocus: true,
            child: Overlay(
              key: _overlayKey,
              initialEntries: overlay == null ?  _allRouteOverlayEntries.toList(growable: false) : const <OverlayEntry>[],
            ),
          ),
        ),
      ),
    );
  }
  1. 再往上兩層是WidgetsAppShortcutsFocusTraversalGroup創(chuàng)建的。
WidgetsApp源碼
  1. 最頂層就是rootScope它是在WidgetsBinding初始化時調(diào)用BuildOwner創(chuàng)建FocusManager而來的。
mixin WidgetsBinding on BindingBase, ServicesBinding, SchedulerBinding, GestureBinding, RendererBinding, SemanticsBinding {
  @override
  void initInstances() {
    super.initInstances();
    _buildOwner = BuildOwner();
    ...
  }
  ...
}
class BuildOwner {
  /// Creates an object that manages widgets.
  BuildOwner({ this.onBuildScheduled });

  /// The object in charge of the focus tree.
  FocusManager focusManager = FocusManager();
  
  ...
}
class FocusManager with DiagnosticableTreeMixin, ChangeNotifier {
  final FocusScopeNode rootScope = FocusScopeNode(debugLabel: 'Root Focus Scope');
  
  FocusManager() {
    rootScope._manager = this;
    ...
  }
  ...
}
  1. 最后是FocusManager類的相關(guān)信息。
  • primaryFocus:當(dāng)前的主焦點(diǎn)。
  • rootScope:當(dāng)前Focus Tree的根節(jié)點(diǎn)。
  • highlightMode:當(dāng)前獲取焦點(diǎn)的交互模式,上面有提到。
  • highlightStrategy:交互模式的策略,默認(rèn)automatic根據(jù)接收到的最后一種輸入方式,自動切換。也可以指定使用某一種方式。
  • FocusManager也繼承自ChangeNotifier,所以我們可以通過addListener監(jiān)聽primaryFocus的變化。

3.Focus Tree變化

現(xiàn)在我先點(diǎn)擊一下輸入框,在點(diǎn)擊按鈕,打印結(jié)果如下(只取最后幾層):

primaryFocus: FocusNode#e72e2([PRIMARY FOCUS])
...
└─Child 1: FocusScopeNode#af55c(_ModalScopeState<dynamic> Focus Scope [IN FOCUS PATH])
  │ context: FocusScope
  │ IN FOCUS PATH
  │ focusedChildren: FocusNode#e72e2([PRIMARY FOCUS])
  │
  ├─Child 1: FocusNode#e72e2([PRIMARY FOCUS])
  │   context: EditableText-[LabeledGlobalKey<EditableTextState>#c2f8a]
  │   PRIMARY FOCUS
  │
  └─Child 2: FocusNode#0b7c0
      context: Focus

可以看到當(dāng)前焦點(diǎn)primaryFocusFocusNode#e72e2也就是到了TextField上。注意這里的focusedChildren此時只有FocusNode#e72e2。

因?yàn)槲尹c(diǎn)擊了TextField,此時軟鍵盤彈出?,F(xiàn)在我需要關(guān)閉軟鍵盤,我這里有四種方法:

  1. 使用SystemChannels.textInput.invokeMethod('TextInput.hide')方法,這種方法關(guān)閉軟鍵盤后焦點(diǎn)不變,還在TextField上,所以有一個問題。比如這時你push到一個新的頁面再pop返回,此時軟鍵盤會再次彈出。這里不推薦使用。

  2. 使用FocusScope.of(context).requestFocus(FocusNode())方法,并打印一下Focus Tree。

primaryFocus: FocusNode#7da34([PRIMARY FOCUS])
└─Child 1: FocusScopeNode#af55c(_ModalScopeState<dynamic> Focus Scope [IN FOCUS PATH])
  │ context: FocusScope
  │ IN FOCUS PATH
  │ focusedChildren: FocusNode#7da34([PRIMARY FOCUS]),
  │   FocusNode#e72e2
  │
  ├─Child 1: FocusNode#e72e2
  │   context: EditableText-[LabeledGlobalKey<EditableTextState>#c2f8a]
  │
  ├─Child 2: FocusNode#0b7c0
  │   context: Focus
  └─Child 3: FocusNode#7da34([PRIMARY FOCUS])
      PRIMARY FOCUS

可以看到其實(shí)就在當(dāng)前節(jié)點(diǎn)下創(chuàng)建了一個FocusNode#7da34并把焦點(diǎn)轉(zhuǎn)移給它。注意這里的focusedChildren此時有FocusNode#7da34FocusNode#e72e2。

  1. 使用FocusScope.of(context).unfocus()方法重復(fù)上面的步驟,并打印一下Focus Tree。
primaryFocus: FocusScopeNode#4f0d5(Navigator Scope [PRIMARY FOCUS])
└─Child 1: FocusScopeNode#4f0d5(Navigator Scope [PRIMARY FOCUS])
  │ context: FocusScope
  │ PRIMARY FOCUS
  │
  └─Child 1: FocusScopeNode#af55c(_ModalScopeState<dynamic> Focus Scope)
    │ context: FocusScope
    │ focusedChildren: FocusNode#e72e2, FocusNode#7da34
    │
    ├─Child 1: FocusNode#e72e2
    │   context: EditableText-[LabeledGlobalKey<EditableTextState>#c2f8a]
    │
    ├─Child 2: FocusNode#0b7c0
    │   context: Focus   
    └─Child 3: FocusNode#7da34

可以看到焦點(diǎn)直接到了Navigator上,為什么不是當(dāng)前頁面FocusScopeNode#af55c呢?

因?yàn)檫@里FocusScope.of(context)方法所返回的FocusScopeNode就是當(dāng)前頁面FocusScopeNode#af55c,這時候你再取消了焦點(diǎn),那么焦點(diǎn)此時就向上尋找,到了Navigator上。

注意這里的focusedChildren此時有FocusNode#e72e2FocusNode#7da34。不過看到這里你有沒有發(fā)現(xiàn)一個問題。焦點(diǎn)已經(jīng)不在FocusScopeNode#af55c的作用域里面了,但是focusedChildren里卻還存在數(shù)據(jù),如果我們這時使用如FocusScope.of(context).focusedChild方法,那么得到的結(jié)果就是不正確的。

穩(wěn)妥的做法是使用下面的第四種方法。

  1. 最后一個方法就是給TextField添加屬性focusNode,直接調(diào)用_focusNode.unfocus()
final FocusNode _focusNode = FocusNode();
TextField(
  focusNode: _focusNode,
),
_focusNode.unfocus();

這里我就不貼結(jié)果了,大體和一開始的一樣,此時focusedChildren為空不打印。這樣就可以將焦點(diǎn)成功歸還上級作用域(當(dāng)前頁面),不過這樣如果頁面復(fù)雜,可能會比較繁瑣,你需要每個添加FocusNode來管理。所以更推薦使用:

FocusManager.instance.primaryFocus?.unfocus();

它可以直接獲取到當(dāng)前的焦點(diǎn),便于我們直接取消焦點(diǎn)。所以對比這四個方法,肯定后者比較好了,也避免了因數(shù)據(jù)錯誤導(dǎo)致的其他隱患。

4.結(jié)語

通過觀察Focus Tree的變化,我們大致可以理解Focus Tree的組成及變化規(guī)律,如果你有控制焦點(diǎn)的需求,本篇或許可以為你帶來幫助。

關(guān)于Focus其實(shí)還有許多細(xì)節(jié),比如FocusAttachment如何管理FocusNode 、FocusNode的遍歷順序?qū)崿F(xiàn) FocusTraversalGroup等。由于篇幅有限,這里就不介紹了,有興趣的可以看看源碼。

本篇是“說說”系列第四篇,前三篇鏈接奉上:

如果本文對你有所幫助或啟發(fā)的話,還請不吝點(diǎn)贊收藏支持一波。同時也多多支持我的Flutter開源項(xiàng)目flutter_deer

我們下個月見~~

5.參考

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容