將 of 遷移為非 nullable 回傳值，並新增 maybeOf

本遷移指南說明如何將原本使用各種靜態 of 函式，從 context 取得資訊且回傳 nullable 值的程式碼，轉換為現在回傳非 nullable 值的寫法。

Flutter 常見的設計模式是允許透過靜態成員函式來查找某些型別的元件 (Widget)（通常是 InheritedWidget，但也包含其他類型），這些函式通常命名為 of。

當 non-nullability（非空性）成為預設時，我們希望最常用的 API 能回傳非 nullable 的值。原因在於，呼叫 Scrollable.of(context) 後仍需加上 ! 運算子或 ? 並指定預設值，這樣的寫法顯得彆扭，且不符合 Dart 非 nullable 程式碼的慣例。

大部分相關遷移已在先前的遷移中，移除了 nullOk 參數，但當時有些 of 方法遺漏未處理，之後又有部分方法新增時仍採用 nullable 回傳型態，這與我們一貫的設計模式不符。

在這次遷移中，受影響的 of 存取器被拆分為兩種呼叫方式：一種回傳非 nullable 值，若找不到目標值則會丟出例外（仍命名為 of）；另一種則回傳 nullable 值，若找不到則回傳 null，不會丟出例外（新方法命名為 maybeOf）。

這次變更將這些靜態 of API 修改為回傳非 nullable 值。 若找不到對應值，現在會在 debug 模式下 assert，release 模式下則會丟出例外。

• AutofillGroup.of
• DefaultTabController.of
• DefaultTextHeightBehavior.of
• Form.of
• HeroControllerScope.of
• Material.of
• Overlay.of
• PageStorage.of
• PrimaryScrollController.of
• RenderAbstractViewport.of
• RestorationScope.of
• Scrollable.of
• ScrollNotificationObserver.of

同時也針對上述函式新增了新的靜態 maybeOf API，這些 API 會回傳 nullable 版本的值，若找不到則直接回傳 null，不會丟出任何例外。

• AutofillGroup.maybeOf
• DefaultTabController.maybeOf
• DefaultTextHeightBehavior.maybeOf
• Form.maybeOf
• HeroControllerScope.maybeOf
• Material.maybeOf
• Overlay.maybeOf
• PageStorage.maybeOf
• PrimaryScrollController.maybeOf
• RenderAbstractViewport.maybeOf
• RestorationScope.maybeOf
• Scrollable.maybeOf
• ScrollNotificationObserver.maybeOf

若要讓你的程式碼使用新版 API，請先將所有原本靜態 of 函式（當其 nullability 很重要時）改為使用 maybeOf 形式。

遷移前的程式碼：

ScrollController? controller = Scrollable.of(context);

遷移後的程式碼：

ScrollController? controller = Scrollable.maybeOf(context);

接著，針對程式碼中呼叫 of API 並接續使用驚嘆號的情境，只需移除驚嘆號：該方法現在已不會回傳可為 null 的值。

遷移前的程式碼：

ScrollController controller = Scrollable.of(context)!;

遷移後的程式碼：

ScrollController controller = Scrollable.of(context);

以下內容也可能對您有所幫助：

• unnecessary_non_null_assertion (linter message) 可協助找出應移除 ! 運算子的地方
• unnecessary_null_checks (analysis option) 可協助找出不需要 ? 運算子的地方
• unnecessary_null_in_if_null_operators 可協助找出不需要 ?? 運算子的地方
• unnecessary_nullable_for_final_variable_declarations (analysis option) 可協助尋找在 final 和 const 變數上多餘的問號運算子

穩定版發佈於：3.7

API 文件：

• Material.of

相關 PR：

• 針對所有 of 會回傳 nullable 的情境新增 maybeOf
• 新增 Overlay.maybeOf，讓 Overlay.of 回傳非 nullable 實例