describeEnum 與 EnumProperty 的遷移指南

全域方法 describeEnum 已被棄用。先前使用 describeEnum(Enum.something) 的情境，應改為使用 Enum.something.name。

類別 EnumProperty 已修改為 繼承自 <T extends Enum?>，而非 <T>。 現有使用 EnumProperty<NotAnEnum> 的程式碼， 應改為使用 DiagnosticsProperty<NotAnEnum>。

Dart 2.17 引入了加強型 enum，這讓 Enum 成為一種型別。 因此，所有 enum 都有了一個 name getter，這使得 describeEnum 變得多餘。在此之前，enum 類別通常會透過 EnumProperty 進行分析。

describeEnum 方法過去用於將 enum 值轉換為字串， 因為 Enum.something.toString() 會產生 Enum.something， 而不是許多使用者想要的 something。現在，name getter 已可達成此需求。

describeEnum 函式即將被棄用， 因此 EnumProperty 類別已更新為僅接受 Enum 物件。

移除 describeEnum。

• 將 describeEnum(Enum.something) 替換為 Enum.something.name。

EnumProperty 現在只接受 null 或 Enum； 你不能再傳入非 Enum 類別。

如果你先前使用 describeEnum(Enum.field) 來取得 enum 的字串值， 現在可以直接呼叫 Enum.field.name。

如果你先前使用 EnumProperty<NotAnEnum>， 現在可以改用泛型的 DiagnosticsProperty<NotAnEnum>。

遷移前的程式碼：

enum MyEnum { paper, rock }
​
print(describeEnum(MyEnum.paper)); // output: paper
​
// TextInputType is not an Enum
properties.add(EnumProperty<TextInputType>( ... ));

遷移後的程式碼：

enum MyEnum { paper, rock }
​
print(MyEnum.paper.name); // output: paper
​
// TextInputType is not an Enum
properties.add(DiagnosticsProperty<TextInputType>( ... ));

合併於版本：3.14.0-2.0.pre
穩定版釋出：3.16

API 文件：

• describeEnum
• EnumProperty

相關議題：

• Cleanup SemanticsFlag and SemanticsAction issue

相關 PR：

• Deprecate describeEnum PR