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

唯鹿發表於2020-07-06
Flutter

Focus Deer

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

1.Focus相關介紹

這裡大致介紹一些Focus相關Widget及功能類，便於後面理解Focus Tree部分。本篇原始碼基於1.20.0-2.0.pre。

1.1 FocusNode

FocusNode是用於Widget獲取鍵盤焦點和處理鍵盤事件的物件。它是繼承自ChangeNotifier，所以我們可以在任意位置獲取對應的FocusNode資訊。

下面說幾個FocusNode常用方法：

  • requestFocus用作請求焦點，注意這個請求焦點的執行放在了scheduleMicrotask中，因此結果可能會延遲最多一幀。

  • unfocus用作取消焦點，預設行為為UnfocusDisposition.scope：

void unfocus({UnfocusDisposition disposition = UnfocusDisposition.scope,}) {
  ....
}
複製程式碼

UnfocusDisposition列舉類是焦點取消後的行為，分為scope和previouslyFocusedChild兩種。

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

  2. previouslyFocusedChild是尋找上一個焦點位置，如果沒有則給當前FocusScopeNode。

具體實現可見unfocus原始碼，這裡就不多說了。

  • dispose這個沒啥說的，注意使用FocusNode完後及時銷燬。

1.2 FocusScopeNode

FocusScopeNode是FocusNode的子類。它將FocusNode組織到一個作用域中，形成一組可以遍歷的節點。它會提供最後一個獲取焦點的FocusNode(focusedChild)，如果其中一個節點的焦點被移除，那麼此FocusScopeNode將再次獲得焦點，同時_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下出現的所有FocusNode，而是獲取過焦點的FocusNode才會在裡面。原始碼實現如下：

  void _setAsFocusedChildForScope() {
    FocusNode scopeFocus = this;
    for (final FocusScopeNode ancestor in ancestors.whereType<FocusScopeNode>()) {
      // 從聚焦的歷史中移除
      ancestor._focusedChildren.remove(scopeFocus);
      // 再將它新增至最後，這樣上面的focusedChild可以獲取到最後獲取過焦點的節點
      ancestor._focusedChildren.add(scopeFocus);
      scopeFocus = ancestor;
    }
  }
複製程式碼

FocusScopeNode比較重要的方法是setFirstFocus，用來設定子作用域節點。

  void setFirstFocus(FocusScopeNode scope) {
    if (scope._parent == null) {
      // scope沒有父節點，將scope新增至當前節點下
      _reparent(scope);
    }
    if (hasFocus) {
      // 當前作用域存在焦點，_doRequestFocus將焦點移到scope上，同時記錄節點。
      scope._doRequestFocus(findFirstFocus: true);
    } else {
      // 當前作用域不存在焦點，記錄節點。
      scope._setAsFocusedChildForScope();
    }
  }
複製程式碼

1.3 Focus

Focus是一個Widget，可以用來分配焦點給它本身及其子Widget。內部管理著一個FocusNode，監聽焦點的變化，來保持焦點層次結構與Widget層次結構同步。

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

我們來看一下InkResponse原始碼：

InkResponse原始碼
這裡發現了Focus，我們看看它的onFocusChange實現：

  void _handleFocusUpdate(bool hasFocus) {
    _hasFocus = hasFocus;
    _updateFocusHighlights();
    if (widget.onFocusChange != null) {
      widget.onFocusChange(hasFocus);
    }
  }
複製程式碼

有焦點變化時修改_hasFocus值呼叫_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);
  }
複製程式碼

最終呼叫updateHighlight方法讓WIdget有一個獲取焦點時的高亮顯示。

這裡有個列舉類FocusHighlightMode，它是表示使用何種互動模式獲取的焦點。分為touch和traditional。

預設的區分實現如下：

  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;
  }
複製程式碼

移動端在沒有滑鼠連線的情況下都是touch，桌面端都為傳統的方式（鍵盤和滑鼠）。

所以這也回答我一開始的問題，我們一般只考慮了移動裝置，也就是touch的部分，這部分其實我們不太需要給按鈕處理焦點效果，可能類似給Android TV盒子用的這類App才需要。而Flutter提供的Widget需要考慮各個平臺效果，所以才使用了這些。類似在上面的InkResponse原始碼中，還出現了MouseRegion這個Widget，它是跟蹤滑鼠移動的，比如在Web端滑鼠移動到按鈕上，按鈕會有一個變化效果。

1.4 FocusScope

FocusScope與Focus類似，不過它的內部管理的是FocusScopeNode。它不改變主焦點，它只是改變了接收焦點的作用域節點。這個在原始碼中使用的不多，但卻都很重要的位置。

比如Navigator和Route，首先Navigator有一個FocusScope，自動獲取焦點。在它承載的一個個路由上也會新增FocusScope，這樣當頁面跳轉/Dialog彈框時可以將焦點的作用域移動到上面（通過setFirstFocus方法）。

類似Drawer也是一樣。當抽屜開啟時，我們的焦點作用域就要移動到Drawer，所以也要使用FocusScope。

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

2.Focus Tree

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

Focus Tree是與Widget Tree獨立開的、結構相對簡單的樹，它是維護Widget Tree中可聚焦Widget之間的層次關係。Focus Tree因為無法通過工具來視覺化觀察，我們可以使用Focus Tree的管理類FocusManager中的debugDumpFocusTree方法列印出來。

所以這裡我新建一個專案，寫一個小例子來看一下。程式碼很簡單，Column裡一個TextField和FlatButton 。

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();
              });
            },
          ),
        ],
      ),
    );
  }
}
複製程式碼

點選按鈕，列印結果如下：

 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#e72e2和Child 2: FocusNode#0b7c0一看就是同級，代表的就是TextField和FlatButton 。

  2. 上一層FocusScopeNode#af55c是當前的頁面，可以看到焦點目前在它上面（PRIMARY FOCUS）。它是在 MaterialPageRoute -> PageRoute -> ModalRoute ->createOverlayEntries -> _buildModalScope方法，呼叫_ModalScope建立的。

  3. 再上一層FocusScopeNode#4f0d5是Navigator，程式碼如下：

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. 再往上兩層是WidgetsApp的Shortcuts和FocusTraversalGroup建立的。

WidgetsApp原始碼

  1. 最頂層就是rootScope它是在WidgetsBinding初始化時呼叫BuildOwner建立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類的相關資訊。
  • primaryFocus：當前的主焦點。
  • rootScope：當前Focus Tree的根節點。
  • highlightMode：當前獲取焦點的互動模式，上面有提到。
  • highlightStrategy：互動模式的策略，預設automatic根據接收到的最後一種輸入方式，自動切換。也可以指定使用某一種方式。
  • FocusManager也繼承自ChangeNotifier，所以我們可以通過addListener監聽primaryFocus的變化。

3.Focus Tree變化

現在我先點選一下輸入框，在點選按鈕，列印結果如下（只取最後幾層）：

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
複製程式碼

可以看到當前焦點primaryFocus為FocusNode#e72e2也就是到了TextField上。注意這裡的focusedChildren此時只有FocusNode#e72e2。

因為我點選了TextField，此時軟鍵盤彈出。現在我需要關閉軟鍵盤，我這裡有四種方法：

  1. 使用SystemChannels.textInput.invokeMethod('TextInput.hide')方法，這種方法關閉軟鍵盤後焦點不變，還在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

複製程式碼

可以看到其實就在當前節點下建立了一個FocusNode#7da34並把焦點轉移給它。注意這裡的focusedChildren此時有FocusNode#7da34和FocusNode#e72e2。

  1. 使用FocusScope.of(context).unfocus()方法重複上面的步驟，並列印一下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
複製程式碼

可以看到焦點直接到了Navigator上，為什麼不是當前頁面FocusScopeNode#af55c呢？

因為這裡FocusScope.of(context)方法所返回的FocusScopeNode就是當前頁面FocusScopeNode#af55c，這時候你再取消了焦點，那麼焦點此時就向上尋找，到了Navigator上。

注意這裡的focusedChildren此時有FocusNode#e72e2和FocusNode#7da34。不過看到這裡你有沒有發現一個問題。焦點已經不在FocusScopeNode#af55c的作用域裡面了，但是focusedChildren裡卻還存在資料，如果我們這時使用如FocusScope.of(context).focusedChild方法，那麼得到的結果就是不正確的。

穩妥的做法是使用下面的第四種方法。

  1. 最後一個方法就是給TextField新增屬性focusNode，直接呼叫_focusNode.unfocus()：
final FocusNode _focusNode = FocusNode();
TextField(
  focusNode: _focusNode,
),
_focusNode.unfocus();
複製程式碼

這裡我就不貼結果了，大體和一開始的一樣，此時focusedChildren為空不列印。這樣就可以將焦點成功歸還上級作用域（當前頁面），不過這樣如果頁面複雜，可能會比較繁瑣，你需要每個新增FocusNode來管理。所以更推薦使用：

FocusManager.instance.primaryFocus?.unfocus();
複製程式碼

它可以直接獲取到當前的焦點，便於我們直接取消焦點。所以對比這四個方法，肯定後者比較好了，也避免了因資料錯誤導致的其他隱患。

4.結語

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

關於Focus其實還有許多細節，比如FocusAttachment如何管理FocusNode 、FocusNode的遍歷順序實現 FocusTraversalGroup等。由於篇幅有限，這裡就不介紹了，有興趣的可以看看原始碼。

本篇是“說說”系列第四篇，前三篇連結奉上：

如果本文對你有所幫助或啟發的話，還請不吝點贊收藏支援一波。同時也多多支援我的Flutter開源專案flutter_deer。

我們下個月見~~

5.參考

相關文章