内容

Mixin

内容

Mixin 是一种定义可以在多个类层次结构中重用的代码的方式。它们旨在批量提供成员实现。

要使用 Mixin，请使用 with 关键字后跟一个或多个 Mixin 名称。以下示例显示了两个使用（或作为…的子类）Mixin 的类

dart
class Musician extends Performer with Musical {
  // ···
}

class Maestro extends Person with Musical, Aggressive, Demented {
  Maestro(String maestroName) {
    name = maestroName;
    canConduct = true;
  }
}

要定义 Mixin，请使用 mixin 声明。在极少数情况下，您需要同时定义 Mixin 和类，您可以使用 mixin class 声明。

Mixin 和 Mixin 类不能具有 extends 子句，并且不得声明任何生成式构造函数。

例如

dart
mixin Musical {
  bool canPlayPiano = false;
  bool canCompose = false;
  bool canConduct = false;

  void entertainMe() {
    if (canPlayPiano) {
      print('Playing piano');
    } else if (canConduct) {
      print('Waving hands');
    } else {
      print('Humming to self');
    }
  }
}

指定 Mixin 可以调用的自身成员

#

有时 Mixin 依赖于能够调用方法或访问字段，但无法自行定义这些成员（因为 Mixin 无法使用构造函数参数来实例化自己的字段）。

以下部分介绍了确保 Mixin 的任何子类定义 Mixin 的行为所依赖的任何成员的不同策略。

在 Mixin 中定义抽象成员

#

在 Mixin 中声明抽象方法会强制使用该 Mixin 的任何类型在其中定义其行为所依赖的抽象方法。

dart
mixin Musician {
  void playInstrument(String instrumentName); // Abstract method.

  void playPiano() {
    playInstrument('Piano');
  }
  void playFlute() {
    playInstrument('Flute');
  }
}

class Virtuoso with Musician { 
  void playInstrument(String instrumentName) { // Subclass must define.
    print('Plays the $instrumentName beautifully');
  }  
}

访问 Mixin 子类中的状态

#

声明抽象成员还允许您访问 Mixin 子类上的状态，方法是调用在 Mixin 上定义为抽象的 getter

dart
/// Can be applied to any type with a [name] property and provides an
/// implementation of [hashCode] and operator `==` in terms of it.
mixin NameIdentity {
  String get name;

  int get hashCode => name.hashCode;
  bool operator ==(other) => other is NameIdentity && name == other.name;
}

class Person with NameIdentity {
  final String name;

  Person(this.name);
}

实现接口

#

类似于声明 Mixin 为抽象，在 Mixin 上放置 implements 子句而不实际实现接口也将确保为 Mixin 定义所有成员依赖项。

dart
abstract interface class Tuner {
  void tuneInstrument();
}

mixin Guitarist implements Tuner {
  void playSong() {
    tuneInstrument();

    print('Strums guitar majestically.');
  }
}

class PunkRocker with Guitarist {
  void tuneInstrument() {
    print("Don't bother, being out of tune is punk rock.");
  }
}

使用 on 子句声明超类

#

on 子句用于定义 super 调用解析的目标类型。因此，只有在 Mixin 内部需要 super 调用时才应使用它。

on 子句强制使用 Mixin 的任何类也必须是 on 子句中类型的子类。如果 Mixin 依赖于超类中的成员，则这将确保在使用 Mixin 的地方这些成员可用

dart
class Musician {
  musicianMethod() {
    print('Playing music!');
  }
}

mixin MusicalPerformer on Musician {
  performerMethod() {
    print('Performing music!');
    super.musicianMethod();
  }
}

class SingerDancer extends Musician with MusicalPerformer { }

main() {
  SingerDancer().performerMethod();
}

在此示例中，只有扩展或实现 Musician 类的类才能使用 Mixin MusicalPerformer。因为 SingerDancer 扩展了 Musician，所以 SingerDancer 可以混合 MusicalPerformer。

class、mixin 或 mixin class？

#

mixin 声明定义了一个 Mixin。class 声明定义了一个 类。mixin class 声明定义了一个既可以用作常规类又可以用作 Mixin 的类，具有相同的名称和相同的类型。

dart
mixin class Musician {
  // ...
}

class Novice with Musician { // Use Musician as a mixin
  // ...
}

class Novice extends Musician { // Use Musician as a class
  // ...
}

适用于类或 Mixin 的任何限制也适用于 Mixin 类

  • Mixin 不能有 extends 或 with 子句，因此 Mixin 类也不能有。
  • 类不能有 on 子句，因此 Mixin 类也不能有。

除非另有说明，否则本网站上的文档反映了 Dart 3.5.3。页面上次更新于 2024-10-22。 查看源代码 或 报告问题。