內容

記錄是匿名、不可變、聚合的類型。與其他集合類型一樣,它們允許您將多個物件組合成單一物件。與其他集合類型不同的是,記錄是固定大小、異質且有類型的。

記錄是真實值;您可以將它們儲存在變數中、巢狀它們、傳遞它們到函式並從函式傳遞它們,以及將它們儲存在資料結構中,例如清單、對應和集合。

記錄語法

#

記錄表達式是逗號分隔的命名或位置欄位清單,用括號括起來

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)會失去類型安全性。