目录

模式类型

此页面是不同模式类型的参考。有关模式工作原理、在 Dart 中使用模式的位置以及常见用例的概述,请访问主 模式 页面。

模式优先级

#

类似于 运算符优先级,模式评估遵循优先级规则。您可以使用 带括号的模式 来优先评估优先级较低的模式。

本文档按优先级升序列出了模式类型。

逻辑或

#

subpattern1 || subpattern2

逻辑或模式使用 || 分隔子模式,如果任何一个分支匹配则匹配。分支从左到右评估。一旦一个分支匹配,其余分支将不会被评估。

dart
var isPrimary = switch (color) {
  Color.red || Color.yellow || Color.blue => true,
  _ => false
};

逻辑或模式中的子模式可以绑定变量,但分支必须定义相同的变量集,因为当模式匹配时,只有一个分支会被评估。

逻辑与

#

subpattern1 && subpattern2

&& 分隔的两个模式对只有当两个子模式都匹配时才会匹配。如果左侧分支不匹配,则不会评估右侧分支。

逻辑与模式中的子模式可以绑定变量,但每个子模式中的变量不得重叠,因为如果模式匹配,它们将被同时绑定。

dart
switch ((1, 2)) {
  // Error, both subpatterns attempt to bind 'b'.
  case (var a, var b) && (var b, var c): // ...
}

关系

#

== expression

< expression

关系模式使用任何相等或关系运算符将匹配的值与给定常量进行比较:==!=<><=>=

当对匹配的值调用适当的运算符并使用常量作为参数时,如果返回 true,则模式匹配。

关系模式对于匹配数字范围非常有用,尤其是在与 逻辑与模式 结合使用时。

dart
String asciiCharType(int char) {
  const space = 32;
  const zero = 48;
  const nine = 57;

  return switch (char) {
    < space => 'control',
    == space => 'space',
    > space && < zero => 'punctuation',
    >= zero && <= nine => 'digit',
    _ => ''
  };
}

强制转换

#

foo as String

强制转换模式允许您在解构中间插入 类型强制转换,然后将值传递给另一个子模式。

dart
(num, Object) record = (1, 's');
var (i as int, s as String) = record;

强制转换模式将 抛出 异常,如果该值不具有声明的类型。与 空断言模式 一样,这允许您强制断言某些解构值的预期类型。

空检查

#

subpattern?

空检查模式首先匹配非空值,然后将内部模式与该值进行匹配。它们允许您绑定一个变量,该变量的类型是正在匹配的可空值的非空基本类型。

要将 null 值视为匹配失败而不抛出异常,请使用空检查模式。

dart
String? maybeString = 'nullable with base type String';
switch (maybeString) {
  case var s?:
  // 's' has type non-nullable String here.
}

要匹配值 null 的情况,请使用 常量模式 null

空断言

#

subpattern!

空断言模式首先匹配非空对象,然后匹配该值。它们允许非空值通过,但如果匹配的值为 null,则会 抛出 异常。

要确保 null 值不会被静默地视为匹配失败,请在匹配时使用空断言模式。

dart
List<String?> row = ['user', null];
switch (row) {
  case ['user', var name!]: // ...
  // 'name' is a non-nullable string here.
}

要从变量声明模式中消除 null 值,请使用空断言模式。

dart
(int?, int?) position = (2, 3);

var (x!, y!) = position;

要匹配值 null 的情况,请使用 常量模式 null

常量

#

123, null, 'string', math.pi, SomeClass.constant, const Thing(1, 2), const (1 + 2)

常量模式在值等于常量时匹配。

dart
switch (number) {
  // Matches if 1 == number.
  case 1: // ...
}

您可以直接使用简单的文字和对命名常量的引用作为常量模式。

  • 数字文字(12345.56
  • 布尔文字(true
  • 字符串文字('string'
  • 命名常量(someConstantmath.pidouble.infinity
  • 常量构造函数(const Point(0, 0)
  • 常量集合文字(const []const {1, 2}

更复杂的常量表达式必须用括号括起来并以 const 为前缀(const (1 + 2))。

dart
// List or map pattern:
case [a, b]: // ...

// List or map literal:
case const [a, b]: // ...

变量

#

var bar, String str, final int _

变量模式将新变量绑定到已匹配或解构的值。它们通常作为 解构模式 的一部分出现,以捕获解构的值。

这些变量在仅在模式匹配时才可访问的代码区域内有效。

dart
switch ((1, 2)) {
  // 'var a' and 'var b' are variable patterns that bind to 1 and 2, respectively.
  case (var a, var b): // ...
  // 'a' and 'b' are in scope in the case body.
}

类型 变量模式仅在匹配的值具有声明的类型时匹配,否则失败。

dart
switch ((1, 2)) {
  // Does not match.
  case (int a, String b): // ...
}

您可以使用 通配符模式 作为变量模式。

标识符

#

foo, _

标识符模式可能表现得像 常量模式变量模式,具体取决于它们出现的上下文。

  • 声明 上下文:声明一个具有标识符名称的新变量:var (a, b) = (1, 2);
  • 赋值 上下文:将标识符名称分配给现有变量:(a, b) = (3, 4);
  • 匹配 上下文:被视为命名常量模式(除非其名称为 _)。
    dart
    const c = 1;
    switch (2) {
      case c:
        print('match $c');
      default:
        print('no match'); // Prints "no match".
    }
  • 任何上下文中的 通配符 标识符:匹配任何值并丢弃它:case [_, var y, _]: print('The middle element is $y');

带括号的

#

(subpattern)

与带括号的表达式类似,模式中的括号使您可以控制 模式优先级,并在期望更高优先级模式的地方插入更低优先级模式。

例如,假设布尔常量xyz分别等于truetruefalse。虽然下面的例子类似于布尔表达式求值,但这个例子匹配模式。

dart
// ...
x || y => 'matches true',
x || y && z => 'matches true',
x || (y && z) => 'matches true',
// `x || y && z` is the same thing as `x || (y && z)`.
(x || y) && z => 'matches nothing',
// ...

Dart从左到右开始匹配模式。

  1. 第一个模式匹配true,因为x匹配true

  2. 第二个模式匹配true,因为x匹配true

  3. 第三个模式匹配true,因为x匹配true

  4. 第四个模式(x || y) && z没有匹配项。

    • x匹配true,所以Dart不会尝试匹配y
    • 虽然(x || y)匹配true,但z不匹配true
    • 因此,模式(x || y) && z不匹配true
    • 子模式(x || y)不匹配false,所以Dart不会尝试匹配z
    • 因此,模式(x || y) && z不匹配false
    • 总之,(x || y) && z没有匹配项。

列表

#

[子模式1,子模式2]

列表模式匹配实现List的值,然后递归地将其子模式与列表的元素进行匹配,以按位置对它们进行解构。

dart
const a = 'a';
const b = 'b';
switch (obj) {
  // List pattern [a, b] matches obj first if obj is a list with two fields,
  // then if its fields match the constant subpatterns 'a' and 'b'.
  case [a, b]:
    print('$a, $b');
}

列表模式要求模式中的元素数量与整个列表匹配。但是,可以使用剩余元素作为占位符来考虑列表中的任意数量的元素。

剩余元素

#

列表模式可以包含一个剩余元素...),它允许匹配任意长度的列表。

dart
var [a, b, ..., c, d] = [1, 2, 3, 4, 5, 6, 7];
// Prints "1 2 6 7".
print('$a $b $c $d');

剩余元素也可以有一个子模式,该子模式将不匹配列表中其他子模式的元素收集到一个新列表中。

dart
var [a, b, ...rest, c, d] = [1, 2, 3, 4, 5, 6, 7];
// Prints "1 2 [3, 4, 5] 6 7".
print('$a $b $rest $c $d');

映射

#

{"key": 子模式1,someConst: 子模式2}

映射模式匹配实现Map的值,然后递归地将其子模式与映射的键进行匹配,以对它们进行解构。

映射模式不要求模式与整个映射匹配。映射模式会忽略映射中包含的任何未由模式匹配的键。

记录

#

(子模式1,子模式2)

(x: 子模式1,y: 子模式2)

记录模式匹配记录对象并解构其字段。如果该值不是与模式具有相同形状的记录,则匹配失败。否则,字段子模式将与记录中相应的字段进行匹配。

记录模式要求模式与整个记录匹配。要使用模式解构具有命名字段的记录,请在模式中包含字段名。

dart
var (myString: foo, myNumber: bar) = (myString: 'string', myNumber: 1);

getter名称可以省略,并从字段子模式中的变量模式标识符模式推断。这些模式对是等效的

dart
// Record pattern with variable subpatterns:
var (untyped: untyped, typed: int typed) = record;
var (:untyped, :int typed) = record;

switch (record) {
  case (untyped: var untyped, typed: int typed): // ...
  case (:var untyped, :int typed): // ...
}

// Record pattern with null-check and null-assert subpatterns:
switch (record) {
  case (checked: var checked?, asserted: var asserted!): // ...
  case (:var checked?, :var asserted!): // ...
}

// Record pattern with cast subpattern:
var (untyped: untyped as int, typed: typed as String) = record;
var (:untyped as int, :typed as String) = record;

对象

#

SomeClass(x: 子模式1,y: 子模式2)

对象模式将匹配的值与给定的命名类型进行检查,以使用对象属性上的getter解构数据。如果该值没有相同的类型,它们将被否定

dart
switch (shape) {
  // Matches if shape is of type Rect, and then against the properties of Rect.
  case Rect(width: var w, height: var h): // ...
}

getter名称可以省略,并从字段子模式中的变量模式标识符模式推断。

dart
// Binds new variables x and y to the values of Point's x and y properties.
var Point(:x, :y) = Point(1, 2);

对象模式不要求模式与整个对象匹配。如果对象具有模式未解构的额外字段,它仍然可以匹配。

通配符

#

_

名为_的模式是通配符,它可以是变量模式标识符模式,它不绑定或分配给任何变量。

它在需要子模式以解构后面的位置值的地方很有用。

dart
var list = [1, 2, 3];
var [_, two, _] = list;

带有类型注释的通配符名称在需要测试值的类型但不将其绑定到名称的情况下很有用。

dart
switch (record) {
  case (int _, String _):
    print('First field is int and second is String.');
}