目录

记录

记录是匿名、不可变的聚合类型。与其他 集合类型 一样,它们允许您将多个对象捆绑到单个对象中。与其他集合类型不同,记录是固定大小、异构且带类型的。

记录是真实值;您可以将它们存储在变量中,嵌套它们,将它们传递给函数并从函数中获取它们,并将它们存储在数据结构中,例如列表、映射和集合。

记录语法

#

记录表达式 是用括号括起来的、以逗号分隔的命名或位置字段列表

dart
var record = ('first', a: 2, b: true, 'last');

记录类型注释 是用括号括起来的、以逗号分隔的类型列表。您可以使用记录类型注释来定义返回值类型和参数类型。例如,以下 (int, int) 语句是记录类型注释

dart
(int, int) swap((int, int) record) {
  var (a, b) = record;
  return (b, a);
}

记录表达式和类型注释中的字段反映了函数中 参数和参数 的工作方式。位置字段直接放在括号内

dart
// Record type annotation in a variable declaration:
(String, int) record;

// Initialize it with a record expression:
record = ('A string', 123);

在记录类型注释中,命名字段位于所有位置字段之后,位于用大括号括起来的部分类型和名称对中。在记录表达式中,名称在每个字段值之前,后面带有一个冒号

dart
// Record type annotation in a variable declaration:
({int a, bool b}) record;

// Initialize it with a record expression:
record = (a: 123, b: true);

记录类型中命名字段的名称是 记录类型定义 的一部分,或其形状。具有不同名称的命名字段的两个记录具有不同的类型

dart
({int a, int b}) recordAB = (a: 1, b: 2);
({int x, int y}) recordXY = (x: 3, y: 4);

// Compile error! These records don't have the same type.
// recordAB = recordXY;

在记录类型注释中,您还可以命名位置字段,但这些名称纯粹用于文档目的,不会影响记录的类型

dart
(int a, int b) recordAB = (1, 2);
(int x, int y) recordXY = (3, 4);

recordAB = recordXY; // OK.

这类似于函数声明或函数类型定义中的位置参数如何可以具有名称,但这些名称不会影响函数的签名。

有关更多信息和示例,请查看 记录类型记录相等性

记录字段

#

记录字段可通过内置 getter 访问。记录是不可变的,因此字段没有 setter。

命名字段公开相同名称的 getter。位置字段公开名称为 $<position> 的 getter,跳过命名字段

dart
var record = ('first', a: 2, b: true, 'last');

print(record.$1); // Prints 'first'
print(record.a); // Prints 2
print(record.b); // Prints true
print(record.$2); // Prints 'last'

为了进一步简化记录字段访问,请查看关于 模式 的页面。

记录类型

#

没有用于单个记录类型的类型声明。记录是根据其字段的类型进行结构化类型的。记录的形状(其字段集、字段类型及其名称(如果有))唯一地确定记录的类型。

记录中的每个字段都有自己的类型。字段类型可以在同一记录内不同。类型系统了解从记录访问的每个字段的类型

dart
(num, Object) pair = (42, 'a');

var first = pair.$1; // Static type `num`, runtime type `int`.
var second = pair.$2; // Static type `Object`, runtime type `String`.

考虑两个创建具有相同字段集的记录的无关库。类型系统理解这些记录是相同类型,即使这些库没有相互耦合。

记录相等性

#

如果两个记录具有相同的形状(字段集),并且其对应字段的值相同,则这两个记录相等。由于命名字段的顺序不是记录形状的一部分,因此命名字段的顺序不会影响相等性。

例如

dart
(int x, int y, int z) point = (1, 2, 3);
(int r, int g, int b) color = (1, 2, 3);

print(point == color); // Prints 'true'.
dart
({int x, int y, int z}) point = (x: 1, y: 2, z: 3);
({int r, int g, int b}) color = (r: 1, g: 2, b: 3);

print(point == color); // Prints 'false'. Lint: Equals on unrelated types.

记录会根据其字段的结构自动定义 hashCode== 方法。

多个返回值

#

记录允许函数返回捆绑在一起的多个值。要从返回值中检索记录值,请使用 模式匹配 将值 解构 为局部变量。

dart
// Returns multiple values in a record:
(String name, int age) userInfo(Map<String, dynamic> json) {
  return (json['name'] as String, json['age'] as int);
}

final json = <String, dynamic>{
  'name': 'Dash',
  'age': 10,
  'color': 'blue',
};

// Destructures using a record pattern with positional fields:
var (name, age) = userInfo(json);

/* Equivalent to:
  var info = userInfo(json);
  var name = info.$1;
  var age  = info.$2;
*/

您也可以使用记录的 命名字段 解构记录,使用冒号 : 语法,您可以在 模式类型 页面上了解有关此语法的更多信息

dart
({String name, int age}) userInfo(Map<String, dynamic> json)
// ···
// Destructures using a record pattern with named fields:
final (:name, :age) = userInfo(json);

您可以在没有记录的情况下从函数返回多个值,但其他方法有一些缺点。例如,创建类要冗长得多,并且使用其他集合类型(如 ListMap)会失去类型安全性。