Flutter类切换插件class_switch的使用

Flutter类切换插件class_switch的使用

class_switch 可以让你在类实例的所有子类上进行切换，或者在多个基类实例的所有可能组合上进行切换。通过使用 class_switch_generator 库和来自 class_switch 的注解，你可以生成函数和混合（mixins）来执行可定制的类型安全切换。它与 bloc 搭配使用非常棒，可以帮助你摆脱事件和状态处理的样板代码。请参阅下面的“示例与 bloc 结合使用”部分以了解更多信息。

class_switch 库具体包含用于 class_switch_generator 库的注解，以便生成可以对类进行切换的代码。

如何使用

1. 将 class_switch 添加为普通依赖项。
2. 将 class_switch_generator 添加为开发依赖项。
3. 使用 [@ClassSwitch](/user/ClassSwitch) 注解类。
4. 确保注解参数中提供的类的子类与注解所在的文件在同一文件中或通过 part 语句包含。
5. 在包含注解类的文件中包含 part 'YOUR_FILE_NAME.g.dart';。
6. 运行 pub run build_runner watch。
7. 现在你可以通过使用生成的 $switchXXYY 函数来切换注解类。

class_switch的优点

使用 class_switch 的一些优点包括：

• 接近于能够对注解类的所有子类进行 switch() 的 API。
• 编译时保证（当运行 pub run build_runner watch 时），所有可能的子类都被 class_switch 覆盖。
• 可自动补全的类切换语句，所有情况都已准备好填充。
• 提供了很好的自动补全体验的切换器混合类：添加一个新的子类型后，可以在任何实现该混合的类中自动完成新子类型的缺失函数。
• 可以切换多个不同的基类，生成的切换器具有针对每种可能的子类型组合的 case 语句。与 bloc 库结合使用时非常有用！
• 通过注解选项提供了高度可定制的代码生成，有多种不同的可配置的领域特定语言（DSL），以匹配你的用法并使生成的代码尽可能易读。

重要注意事项

• 当注解一个基类时，其所有子类必须在同一文件中或通过 part 语句包含在注解文件中，否则 class_switcher 将找不到这些子类，并且如果提供未知的子类，则生成的代码将在运行时抛出错误。

示例用法

ClassSwitch 将为名为 BaseClass 并用 [@ClassSwitch](/user/ClassSwitch)() 注解的类生成以下内容（当使用默认模式 [DSL_MODE.CLASS_WRAPPER] 时）：

全局 $switch 函数

一个全局的 $switchBaseClass 函数，该函数接受 BaseClass 的一个实例并返回一个可调用的类，可以为其每个直接子类提供 case 函数以执行切换：

[@ClassSwitch](/user/ClassSwitch)()
abstract class BaseClass {}
class A extends BaseClass {}
class B extends BaseClass {}

// 生成的函数可以这样使用：
var x = $switchBaseClass(A())(
  (a) => 1, // 
  (b) => 2);
assert(x == 1);

// 通过先输入 `.call` 或 `.cases` 来帮助你自动补全：
x = $switchBaseClass(A()).cases(
  (a) => 1, // 
  (b) => 2);
assert(x == 1);

扩展方法

在注解类上生成一个扩展方法，名为 .$switch，当不提供其他类作为参数时，将使用该实例进行切换。当提供其他类时，则需要同时提供所有实例。

[@ClassSwitch](/user/ClassSwitch)()
abstract class BaseClass {}
class A extends BaseClass {}
class B extends BaseClass {}

// 生成的扩展方法可以这样使用：
BaseClass anUnknownSubType = A();
var x = anUnknownSubType.$switch(
  (a) => 1, // 
  (b) => 2);
assert(x == 1);

切换器混合类

生成一个抽象的切换器混合类，该类包含：

• 对于同一文件中找到的每个可能的子类的抽象子类方法。
• 一个 $switch 方法，该方法接受注解类的一个实例并根据实例的类型调用适当的子类方法。

[@ClassSwitch](/user/ClassSwitch)()
abstract class BaseClass {}
class A extends BaseClass {}
class B extends BaseClass {}

// 生成的混合类可以这样使用：
class MySwitcher extends _$BaseClassSwitcher<int>{
  [@override](/user/override)
  int a(A a) => 1;

  [@override](/user/override)
  int b(B b) => 2;
};

assert(MySwitcher().$switch(A()) == 1);

带有默认值的切换器混合类

生成一个抽象的带有默认值的切换器混合类，该类包含：

• 一个允许为所有未覆盖子类方法的类型设置默认值的抽象默认方法。
• 对于同一文件中找到的每个可能的子类的子类方法，除非被覆盖，否则将返回默认方法的结果。

[@ClassSwitch](/user/ClassSwitch)()
abstract class BaseClass {}
class A extends BaseClass {}
class B extends BaseClass {}

// 生成的混合类可以这样使用：
class MySwitcher extends _$BaseClassSwitcherWithDefault<int>{
  [@override](/user/override)
  int defaultValue() => 1;

  [@override](/user/override)
  int b(B b) => 2;
};

assert(MySwitcher().$switch(A()) == 1);

切换多个基类

上述所有功能都可以指定要切换的多个不同的基类。这对于与 bloc 一起工作非常有用！

示例与 bloc 结合使用

下面的示例展示了如何将 class_switch 与 bloc 库结合使用。然而，多基类切换在任何类似的情况下也可以不使用 bloc 直接使用。

abstract class BlocState {}
class StateA extends BlocState {}
class StateB extends BlocState {}

abstract class BlocEvent {}
class EventA extends BlocEvent {}
class EventB extends BlocEvent {}

// 生成的混合类可以这样使用：
[@ClassSwitch](/user/ClassSwitch)(classes:[BlocState, BlocEvent])
class MyBloc extends Bloc<BlocEvent, BlocState> with _$MyBlocSwitcher<BlocState> {

  [@override](/user/override)
  Stream<BlocState> mapEventToState(
    BlocEvent event,
  ) async* {
    yield this.$switch(this.state, event);
  }

  [@override](/user/override)
  BlocState stateAEventA(StateA stateA, EventA eventA) => stateA;

  [@override](/user/override)
  BlocState stateAEventB(StateA stateA, EventB eventB) => stateA;

  [@override](/user/override)
  BlocState stateBEventA(StateB stateB, EventA eventA) => stateB;

  [@override](/user/override)
  BlocState stateBEventB(StateB stateB, EventB eventB) => stateB;
}

// 或者直接用作函数：
var r = $switchMyBloc(StateA(), EventA()).cases(
  (StateA stateA, EventA eventA) => 'a a',
  (StateA stateA, EventB eventB) => 'a b',
  (StateB stateB, EventA eventA) => 'b a',
  (StateB stateB, EventB eventB) => 'b b',
);
assert(r == 'a a');