模式类型

目录 keyboard_arrow_down keyboard_arrow_up

逻辑或
逻辑与
关系型
类型转换
空值检查
空值断言
常量
变量
标识符
圆括号
列表
- 剩余元素
映射
记录
对象
通配符

more_horiz

本页是不同模式类型的参考。要了解模式如何工作、在 Dart 中可以在何处使用以及常见用例的概述，请访问主要的“模式”页面。

类似于运算符优先级，模式求值也遵循优先级规则。您可以使用圆括号模式来首先评估较低优先级的模式。

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

逻辑或模式的优先级低于逻辑与模式，逻辑与模式的优先级低于关系型模式，依此类推。
后缀一元模式（类型转换、空值检查和空值断言）具有相同的优先级。
剩余的主要模式具有最高的优先级。集合类型（记录、列表和映射）和对象模式包含其他数据，因此首先作为外部模式进行评估。

subpattern1 || subpattern2

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

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

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

subpattern1 && subpattern2

由 && 分隔的一对模式仅当两个子模式都匹配时才匹配。如果左分支不匹配，则右分支不评估。

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

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

== 表达式

< 表达式

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

当使用常量作为参数在匹配的值上调用适当的运算符并返回 true 时，模式匹配。

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

dartString 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 值视为匹配失败而不抛出错误，请使用空值检查模式。

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

要在值为 null 时匹配，请使用常量模式 null。

subpattern!

空值断言模式首先检查对象是否为非空，然后检查值。它们允许非空值通过，但如果匹配的值为空，则抛出错误。

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

dartList<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)

当值等于常量时，常量模式匹配

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

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

数字字面量 (123, 45.56)
布尔字面量 (true)
字符串字面量 ('string')
命名常量 (someConstant, math.pi, double.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 _

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

变量的作用域仅限于模式匹配时可访问的代码区域。

dartswitch ((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.
}

仅当匹配的值具有声明的类型时，类型化变量模式才匹配，否则会失败

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

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

foo, _

标识符模式的行为可能类似于常量模式或变量模式，具体取决于它们出现的上下文

声明上下文：声明一个具有标识符名称的新变量：var (a, b) = (1, 2);
赋值上下文：赋值给具有标识符名称的现有变量：(a, b) = (3, 4);

匹配上下文：被视为命名常量模式（除非其名称为 _）

dartconst c = 1;
switch (2) {
  case c:
    print('match $c');
  default:
    print('no match'); // Prints "no match".
}

任何上下文中的通配符标识符：匹配任何值并丢弃它：case [_, var y, _]: print('中间元素是 $y');

(subpattern)

就像带括号的表达式一样，模式中的括号使您可以控制模式优先级，并在需要更高优先级的地方插入较低优先级的模式。

例如，假设布尔常量 x、y 和 z 分别等于 true、true 和 false。虽然以下示例类似于布尔表达式求值，但该示例匹配模式。

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 从左到右开始匹配模式。

第一个模式匹配 true，因为 x 匹配 true。
第二个模式匹配 true，因为 x 匹配 true。
第三个模式匹配 true，因为 x 匹配 true。
第四个模式 (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 没有匹配项。

[subpattern1, subpattern2]

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

dartconst 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');
}

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

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

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

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

dartvar [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": subpattern1, someConst: subpattern2}

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

映射模式不要求模式匹配整个映射。映射模式会忽略映射中包含的任何与模式不匹配的键。尝试匹配映射中不存在的键将抛出 StateError

dart

final {'foo': int? foo} = {};

(subpattern1, subpattern2)

(x: subpattern1, y: subpattern2)

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

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

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: subpattern1, y: subpattern2)

对象模式根据给定的命名类型检查匹配的值，以使用对象属性的 getter 解构数据。如果值不具有相同的类型，则它们会被拒绝。

dartswitch (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);

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

_

名为 _ 的模式是一个通配符，可以是变量模式或标识符模式，它不绑定或赋值给任何变量。

在需要子模式以便解构后续位置值的地方，它可用作占位符

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

当您想要测试值的类型但不将值绑定到名称时，带有类型注释的通配符名称很有用

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

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