可迭代集合

本教程教你如何使用实现 Iterable 类的集合，例如 List 和 Set. 可迭代对象是各种 Dart 应用程序的基本构建块，你可能已经在使用它们，即使你没有注意到。本教程将帮助你充分利用它们。

使用嵌入式 DartPad 编辑器，你可以通过运行示例代码和完成练习来测试你的知识。

为了充分利用本教程，你应该具备 Dart 语法 的基本知识。

本教程涵盖以下内容

• 如何读取可迭代对象的元素。
• 如何检查可迭代对象的元素是否满足条件。
• 如何过滤可迭代对象的内容。
• 如何将可迭代对象的内容映射到不同的值。

完成本教程的估计时间：60 分钟。

本教程中的练习包含部分完成的代码片段。你可以使用 DartPad 通过完成代码并单击“运行”按钮来测试你的知识。**不要编辑main 函数或其下面的测试代码。**

如果你需要帮助，请在每个练习后展开“提示”或“解决方案”下拉菜单。

集合是一个对象，它表示一组对象，这些对象称为元素。可迭代对象是一种集合。

集合可以为空，也可以包含多个元素。根据用途，集合可以具有不同的结构和实现。以下是一些最常见的集合类型

• List: 用于通过索引读取元素。
• Set: 用于包含仅出现一次的元素。
• Map: 用于使用键读取元素。

Iterable 是可以顺序访问的元素集合。

在 Dart 中，Iterable 是一个抽象类，这意味着你无法直接实例化它。但是，你可以通过创建一个新的List 或Set 来创建一个新的Iterable。

List 和Set 都是Iterable，因此它们具有与Iterable 类相同的方法和属性。

Map 在内部使用不同的数据结构，具体取决于其实现。例如，HashMap 使用哈希表，其中元素（也称为值）是使用键获取的。Map 的元素也可以通过使用映射的entries 或values 属性作为Iterable 对象读取。

此示例显示一个int 的List，它也是一个int 的Iterable

Iterable<int> iterable = [1, 2, 3];

与List 的区别在于，使用Iterable，你无法保证按索引读取元素是有效的。与List 相反，Iterable 没有[] 运算符。

例如，考虑以下代码，它是**无效的**

Iterable<int> iterable = [1, 2, 3];
int value = iterable[1];

如果你使用[] 读取元素，编译器会告诉你运算符'[]' 没有为类Iterable 定义，这意味着你不能在此情况下使用[index]。

相反，你可以使用elementAt() 读取元素，它会遍历可迭代对象的元素，直到到达该位置。

Iterable<int> iterable = [1, 2, 3];
int value = iterable.elementAt(1);

继续下一节以了解有关如何访问Iterable 元素的更多信息。

你可以使用for-in 循环顺序读取可迭代对象的元素。

以下示例演示了如何使用for-in 循环读取元素。

void main() {
  const iterable = ['Salad', 'Popcorn', 'Toast'];
  for (final element in iterable) {
    print(element);
  }
}

在某些情况下，你只想访问Iterable 的第一个或最后一个元素。

使用Iterable 类，你无法直接访问元素，因此你不能调用iterable[0] 来访问第一个元素。相反，你可以使用first，它获取第一个元素。

此外，使用Iterable 类，你无法使用运算符[] 来访问最后一个元素，但可以使用last 属性。

void main() {
  Iterable<String> iterable = const ['Salad', 'Popcorn', 'Toast'];
  print('The first element is ${iterable.first}');
  print('The last element is ${iterable.last}');
}

在此示例中，你看到了如何使用first 和last 来获取Iterable 的第一个和最后一个元素。还可以找到满足特定条件的第一个元素。下一节将展示如何使用名为firstWhere() 的方法来实现这一点。

你已经知道如何顺序访问Iterable 的元素，并且可以轻松地获取第一个或最后一个元素。

现在，你将学习如何使用firstWhere() 来找到满足某些条件的第一个元素。此方法需要你传递一个谓词，它是一个函数，如果输入满足特定条件，则返回 true。

String element = iterable.firstWhere((element) => element.length > 5);

例如，如果你要查找具有超过 5 个字符的第一个String，则必须传递一个谓词，当元素大小大于 5 时返回 true。

运行以下示例以查看firstWhere() 的工作原理。你认为所有函数都会给出相同的结果吗？

bool predicate(String item) {
  return item.length > 5;
}

void main() {
  const items = ['Salad', 'Popcorn', 'Toast', 'Lasagne'];

  // You can find with a simple expression:
  var foundItem1 = items.firstWhere((item) => item.length > 5);
  print(foundItem1);

  // Or try using a function block:
  var foundItem2 = items.firstWhere((item) {
    return item.length > 5;
  });
  print(foundItem2);

  // Or even pass in a function reference:
  var foundItem3 = items.firstWhere(predicate);
  print(foundItem3);

  // You can also use an `orElse` function in case no value is found!
  var foundItem4 = items.firstWhere(
    (item) => item.length > 10,
    orElse: () => 'None!',
  );
  print(foundItem4);
}

在此示例中，你可以看到编写谓词的三种不同方法

• 作为表达式：测试代码有一行使用箭头语法 (=>)。
• 作为块：测试代码在括号之间有多行，并包含 return 语句。
• 作为函数： 测试代码位于一个外部函数中，该函数被传递给 firstWhere() 方法作为参数。

没有正确或错误的方法。使用最适合你的方法，并使你的代码更容易阅读和理解。

最后一个例子调用 firstWhere() 并使用可选的命名参数 orElse，当没有找到元素时提供备选方案。在本例中，返回文本 'None!'，因为没有元素满足提供的条件。

以下练习是一个失败的单元测试，其中包含部分完成的代码片段。你的任务是通过编写代码使测试通过来完成练习。你不需要实现 main()。

本练习介绍了 singleWhere()。此方法的工作方式类似于 firstWhere()，但在这种情况下，它期望 Iterable 中只有一个元素满足谓词。如果 Iterable 中有多个或没有元素满足谓词条件，则该方法将抛出一个 StateError 异常。

你的目标是为 singleWhere() 实现满足以下条件的谓词：

• 元素包含字符 'a'。
• 元素以字符 'M' 开头。

测试数据中的所有元素都是 字符串；你可以查看类文档以获取帮助。

// Implement the predicate of singleWhere
// with the following conditions
// * The element contains the character `'a'`
// * The element starts with the character `'M'`
String singleWhere(Iterable<String> items) {
  return items.singleWhere(TODO('Implement the outlined predicate.'));
}

// The following code is used to provide feedback on your solution.
// There is no need to read or modify it.
void main() {
  const items = [
    'Salad',
    'Popcorn',
    'Milk',
    'Toast',
    'Sugar',
    'Mozzarella',
    'Tomato',
    'Egg',
    'Water',
  ];

  try {
    final str = singleWhere(items);
    if (str == 'Mozzarella') {
      print('Success. All tests passed!');
    } else {
      print(
        'Tried calling singleWhere, but received $str instead of '
        'the expected value \'Mozzarella\'',
      );
    }
  } on StateError catch (stateError) {
    print(
      'Tried calling singleWhere, but received a StateError: ${stateError.message}. '
      'singleWhere will fail if 0 or many elements match the predicate.',
    );
  } on UnimplementedError {
    print(
      'Tried running `singleWhere`, but received an error. '
      'Did you implement the function?',
    );
  } catch (e) {
    print('Tried calling singleWhere, but received an exception: $e');
  }
}

String singleWhere(Iterable<String> items) {
  return items.singleWhere(
          (element) => element.startsWith('M') && element.contains('a'));
}

在使用 Iterable 时，有时需要验证集合中的所有元素是否都满足某个条件。

你可能很想使用类似于下面这样的 for-in 循环来编写解决方案：

for (final item in items) {
  if (item.length < 5) {
    return false;
  }
}
return true;

但是，你可以使用 every() 方法来完成相同的事情。

return items.every((item) => item.length >= 5);

使用 every() 方法使代码更易读、更紧凑、更不容易出错。

Iterable 类提供了两种方法，可以用来验证条件。

• any()：如果至少有一个元素满足条件，则返回 true。
• every()：如果所有元素都满足条件，则返回 true。

运行此练习以查看它们在实际中的作用。

void main() {
  const items = ['Salad', 'Popcorn', 'Toast'];

  if (items.any((item) => item.contains('a'))) {
    print('At least one item contains "a"');
  }

  if (items.every((item) => item.length >= 5)) {
    print('All items have length >= 5');
  }
}

在本例中，any() 验证至少有一个元素包含字符 a，而 every() 验证所有元素的长度都等于或大于 5。

运行代码后，尝试更改 any() 的谓词，使其返回 false。

if (items.any((item) => item.contains('Z'))) {
  print('At least one item contains "Z"');
} else {
  print('No item contains "Z"');
}

还可以使用 any() 来验证 Iterable 中没有元素满足特定条件。

以下练习提供使用 any() 和 every() 方法的练习，这些方法在前面的示例中进行了介绍。在本例中，你将使用一组用户，这些用户由 User 对象表示，这些对象具有成员字段 age。

使用 any() 和 every() 实现两个函数。

• 第 1 部分：实现 anyUserUnder18()。
  • 如果至少有一个用户为 17 岁或更小，则返回 true。
• 第 2 部分：实现 everyUserOver13()。
  • 如果所有用户都为 14 岁或更大，则返回 true。

bool anyUserUnder18(Iterable<User> users) {
  // TODO: Implement the anyUserUnder18 function.
}

bool everyUserOver13(Iterable<User> users) {
  // TODO: Implement the everyUserOver13 function.
}

class User {
  final String name;
  final int age;

  User(
    this.name,
    this.age,
  );
}

// The following code is used to provide feedback on your solution.
// There is no need to read or modify it.
void main() {
  final users = [
    User('Alice', 21),
    User('Bob', 17),
    User('Claire', 52),
    User('David', 14),
  ];

  try {
    final out = anyUserUnder18(users);
    if (!out) {
      print('Looks like `anyUserUnder18` is wrong. Keep trying!');
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `anyUserUnder18`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print('Tried running `anyUserUnder18`, but received an exception: $e');
    return;
  }

  try {
    // with only one user older than 18, should be false
    final out = anyUserUnder18([User('Alice', 21)]);
    if (out) {
      print(
          'Looks like `anyUserUnder18` is wrong. What if all users are over 18?');
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `anyUserUnder18`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print(
      'Tried running `anyUserUnder18([User("Alice", 21)])`, '
      'but received an exception: $e',
    );
    return;
  }

  try {
    final out = everyUserOver13(users);
    if (!out) {
      print(
        'Looks like `everyUserOver13` is wrong. '
        'There are no users under 13!',
      );
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `everyUserOver13`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print(
      'Tried running `everyUserOver13`, '
      'but received an exception: $e',
    );
    return;
  }

  try {
    final out = everyUserOver13([User('Dan', 12)]);
    if (out) {
      print(
        'Looks like `everyUserOver13` is wrong. '
        'There is at least one user under 13!',
      );
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `everyUserOver13`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print(
      'Tried running `everyUserOver13([User(\'Dan\', 12)])`, '
      'but received an exception: $e',
    );
    return;
  }

  print('Success. All tests passed!');
}

bool anyUserUnder18(Iterable<User> users) {
  return users.any((user) => user.age < 18);
}

bool everyUserOver13(Iterable<User> users) {
  return users.every((user) => user.age > 13);
}

前面的部分介绍了 firstWhere() 或 singleWhere() 等方法，这些方法可以帮助你找到满足特定谓词的元素。

但如果你想找到所有满足特定条件的元素呢？可以使用 where() 方法来实现。

var evenNumbers = numbers.where((number) => number.isEven);

在本例中，numbers 包含一个具有多个 int 值的 Iterable，而 where() 找到所有偶数。

where() 的输出是另一个 Iterable，你可以像这样使用它来迭代它或应用其他 Iterable 方法。在下一个示例中，where() 的输出直接在 for-in 循环中使用。

var evenNumbers = numbers.where((number) => number.isEven);
for (final number in evenNumbers) {
  print('$number is even');
}

运行此示例以查看如何将 where() 与其他方法（如 any()）结合使用。

void main() {
  var evenNumbers = const [1, -2, 3, 42].where((number) => number.isEven);

  for (final number in evenNumbers) {
    print('$number is even.');
  }

  if (evenNumbers.any((number) => number.isNegative)) {
    print('evenNumbers contains negative numbers.');
  }

  // If no element satisfies the predicate, the output is empty.
  var largeNumbers = evenNumbers.where((number) => number > 1000);
  if (largeNumbers.isEmpty) {
    print('largeNumbers is empty!');
  }
}

在本例中，where() 用于查找所有偶数，然后 any() 用于检查结果中是否包含负数。

在本例的后面，再次使用 where() 来查找所有大于 1000 的数字。由于没有，因此结果为空 Iterable。

takeWhile() 和 skipWhile() 方法也可以帮助你从 Iterable 中过滤元素。

运行此示例以查看如何使用 takeWhile() 和 skipWhile() 拆分包含数字的 Iterable。

void main() {
  const numbers = [1, 3, -2, 0, 4, 5];

  var numbersUntilZero = numbers.takeWhile((number) => number != 0);
  print('Numbers until 0: $numbersUntilZero');

  var numbersStartingAtZero = numbers.skipWhile((number) => number != 0);
  print('Numbers starting at 0: $numbersStartingAtZero');
}

在本例中，takeWhile() 返回一个 Iterable，其中包含满足谓词之前的所有元素。另一方面，skipWhile() 返回一个 Iterable，其中包含第一个不满足谓词的元素之后（包括该元素）的所有元素。

运行完示例后，更改 takeWhile() 以获取元素，直到它到达第一个负数。

var numbersUntilNegative =
    numbers.takeWhile((number) => !number.isNegative);

请注意，条件 number.isNegative 使用 ! 被取反了。

以下练习提供使用 where() 方法与前面练习中的 User 类进行练习。

使用 where() 实现两个函数。

• 第 1 部分：实现 filterOutUnder21()。
  • 返回一个 Iterable，其中包含所有年龄为 21 岁或更大的用户。
• 第 2 部分：实现 findShortNamed()。
  • 返回一个 Iterable，其中包含所有名称长度为 3 或更小的用户。

Iterable<User> filterOutUnder21(Iterable<User> users) {
  // TODO: Implement the filterOutUnder21 function.
}

Iterable<User> findShortNamed(Iterable<User> users) {
  // TODO: Implement the findShortNamed function.
}

class User {
  final String name;
  final int age;

  User(
    this.name,
    this.age,
  );
}

// The following code is used to provide feedback on your solution.
// There is no need to read or modify it.
void main() {
  final users = [
    User('Alice', 21),
    User('Bob', 17),
    User('Claire', 52),
    User('Dan', 12),
  ];

  try {
    final out = filterOutUnder21(users);
    if (out.any((user) => user.age < 21) || out.length != 2) {
      print(
        'Looks like `filterOutUnder21` is wrong, there are '
        'exactly two users with age under 21. Keep trying!',
      );
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `filterOutUnder21`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print(
      'Tried running `filterOutUnder21`, '
      'but received an exception: ${e.runtimeType}',
    );
    return;
  }

  try {
    final out = findShortNamed(users);
    if (out.any((user) => user.name.length > 3) || out.length != 2) {
      print(
        'Looks like `findShortNamed` is wrong, there are '
        'exactly two users with a three letter name. Keep trying!',
      );
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `findShortNamed`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print(
      'Tried running `findShortNamed`, '
      'but received an exception: ${e.runtimeType}',
    );
    return;
  }

  print('Success. All tests passed!');
}

Iterable<User> filterOutUnder21(Iterable<User> users) {
  return users.where((user) => user.age >= 21);
}

Iterable<User> findShortNamed(Iterable<User> users) {
  return users.where((user) => user.name.length <= 3);
}

使用 map() 方法对 Iterables 进行映射，使你能够对每个元素应用一个函数，用新的元素替换每个元素。

Iterable<int> output = numbers.map((number) => number * 10);

在本例中，Iterable numbers 的每个元素都乘以 10。

还可以使用 map() 将元素转换为不同的对象，例如将所有 int 转换为 String，如以下示例所示：

Iterable<String> output = numbers.map((number) => number.toString());

运行此示例以查看如何使用 map() 将 Iterable 的所有元素乘以 2。你认为输出会是什么？

void main() {
  var numbersByTwo = const [1, -2, 3, 42].map((number) => number * 2);
  print('Numbers: $numbersByTwo');
}

在前面的示例中，你将 Iterable 的元素乘以 2。该操作的输入和输出都是 int 的 Iterable。

在本练习中，你的代码接受 User 的 Iterable，你需要返回一个包含每个用户的姓名和年龄的字符串的 Iterable。

Iterable 中的每个字符串必须遵循以下格式：'{name} is {age}'，例如 'Alice is 21'。

Iterable<String> getNameAndAges(Iterable<User> users) {
  // TODO: Implement the getNameAndAges function.
}

class User {
  final String name;
  final int age;

  User(
    this.name,
    this.age,
  );
}

// The following code is used to provide feedback on your solution.
// There is no need to read or modify it.
void main() {
  final users = [
    User('Alice', 21),
    User('Bob', 17),
    User('Claire', 52),
  ];

  try {
    final out = getNameAndAges(users).toList();
    if (!_listEquals(out, ['Alice is 21', 'Bob is 17', 'Claire is 52'])) {
      print(
        'Looks like `getNameAndAges` is wrong. Keep trying! '
        'The output was: $out',
      );
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `getNameAndAges`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print('Tried running the function, but received an exception: $e');
    return;
  }

  print('Success. All tests passed!');
}

bool _listEquals<T>(List<T>? a, List<T>? b) {
  if (a == null) return b == null;
  if (b == null || a.length != b.length) return false;
  for (var index = 0; index < a.length; index += 1) {
    if (a[index] != b[index]) return false;
  }
  return true;
}

Iterable<String> getNameAndAges(Iterable<User> users) {
  return users.map((user) => '${user.name} is ${user.age}');
}

现在是时候练习你学到的东西了，在一个最后的练习中。

本练习提供 EmailAddress 类，该类具有一个接受字符串的构造函数。另一个提供的函数是 isValidEmailAddress()，该函数测试电子邮件地址是否有效。

编写以下代码

第 1 部分：实现 parseEmailAddresses()。

• 编写函数 parseEmailAddresses()，该函数接受包含电子邮件地址的 Iterable<String>，并返回 Iterable<EmailAddress>。
• 使用 map() 方法从 String 映射到 EmailAddress。
• 使用构造函数 EmailAddress(String) 创建 EmailAddress 对象。

第 2 部分：实现 anyInvalidEmailAddress()。

• 编写函数 anyInvalidEmailAddress()，该函数接受 Iterable<EmailAddress>，如果 Iterable 中的任何 EmailAddress 无效，则返回 true。
• 将 any() 方法与提供的函数 isValidEmailAddress() 结合使用。

第 3 部分：实现 validEmailAddresses()。

• 编写函数 validEmailAddresses()，该函数接受 Iterable<EmailAddress>，并返回另一个 Iterable<EmailAddress>，其中只包含有效的地址。
• 使用 where() 方法过滤 Iterable<EmailAddress>。
• 使用提供的函数 isValidEmailAddress() 来评估 EmailAddress 是否有效。

Iterable<EmailAddress> parseEmailAddresses(Iterable<String> strings) {
  // TODO: Implement the parseEmailAddresses function.
}

bool anyInvalidEmailAddress(Iterable<EmailAddress> emails) {
  // TODO: Implement the anyInvalidEmailAddress function.
}

Iterable<EmailAddress> validEmailAddresses(Iterable<EmailAddress> emails) {
  // TODO: Implement the validEmailAddresses function.
}

class EmailAddress {
  final String address;

  EmailAddress(this.address);

  @override
  bool operator ==(Object other) =>
      identical(this, other) ||
      other is EmailAddress && address == other.address;

  @override
  int get hashCode => address.hashCode;

  @override
  String toString() => 'EmailAddress{address: $address}';
}

// The following code is used to provide feedback on your solution.
// There is no need to read or modify it.
void main() {
  const input = [
    '[email protected]',
    'bobgmail.com',
    '[email protected]',
  ];

  const correctInput = ['[email protected]', '[email protected]'];

  bool _listEquals<T>(List<T>? a, List<T>? b) {
    if (a == null) return b == null;
    if (b == null || a.length != b.length) return false;
    for (var index = 0; index < a.length; index += 1) {
      if (a[index] != b[index]) return false;
    }
    return true;
  }

  final Iterable<EmailAddress> emails;
  final Iterable<EmailAddress> correctEmails;
  try {
    emails = parseEmailAddresses(input);
    correctEmails = parseEmailAddresses(correctInput);
    if (emails.isEmpty) {
      print(
        'Tried running `parseEmailAddresses`, but received an empty list.',
      );
      return;
    }
    if (!_listEquals(emails.toList(), [
      EmailAddress('[email protected]'),
      EmailAddress('bobgmail.com'),
      EmailAddress('[email protected]'),
    ])) {
      print('Looks like `parseEmailAddresses` is wrong. Keep trying!');
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `parseEmailAddresses`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print(
      'Tried running `parseEmailAddresses`, '
      'but received an exception: $e',
    );
    return;
  }

  try {
    final out = anyInvalidEmailAddress(emails);
    if (!out) {
      print(
        'Looks like `anyInvalidEmailAddress` is wrong. Keep trying! '
        'The result should be false with at least one invalid address.',
      );
      return;
    }
    final falseOut = anyInvalidEmailAddress(correctEmails);
    if (falseOut) {
      print(
        'Looks like `anyInvalidEmailAddress` is wrong. Keep trying! '
        'The result should be false with all valid addresses.',
      );
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `anyInvalidEmailAddress`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print(
        'Tried running `anyInvalidEmailAddress`, but received an exception: $e');
    return;
  }

  try {
    final valid = validEmailAddresses(emails);
    if (emails.isEmpty) {
      print('Tried running `validEmailAddresses`, but received an empty list.');
      return;
    }
    if (!_listEquals(valid.toList(), [
      EmailAddress('[email protected]'),
      EmailAddress('[email protected]'),
    ])) {
      print('Looks like `validEmailAddresses` is wrong. Keep trying!');
      return;
    }
  } on UnimplementedError {
    print(
      'Tried running `validEmailAddresses`, but received an error. '
      'Did you implement the function?',
    );
    return;
  } catch (e) {
    print(
      'Tried running the `validEmailAddresses`, '
      'but received an exception: $e',
    );
    return;
  }

  print('Success. All tests passed!');
}

bool isValidEmailAddress(EmailAddress email) {
  return email.address.contains('@');
}

Iterable<EmailAddress> parseEmailAddresses(Iterable<String> strings) {
  return strings.map((s) => EmailAddress(s));
}

bool anyInvalidEmailAddress(Iterable<EmailAddress> emails) {
  return emails.any((email) => !isValidEmailAddress(email));
}

Iterable<EmailAddress> validEmailAddresses(Iterable<EmailAddress> emails) {
  return emails.where((email) => isValidEmailAddress(email));
}

恭喜你完成了本教程！如果你想了解更多，以下是一些下一步去哪里学习的建议

• 使用 DartPad 进行练习。
• 尝试另一个 教程。
• 阅读Iterable API 参考，了解本教程未涵盖的方法。

除非另有说明，本网站上的文档反映了 Dart 3.5.3。页面最后更新时间：2024-08-04。 查看源代码 或 报告问题.