扩展方法

概述
使用扩展方法
- 静态类型和动态类型
- API 冲突
实现扩展方法
- 未命名的扩展
实现泛型扩展
资源

扩展方法为现有库添加功能。您可能在不知不觉中就使用了扩展方法。例如，当您在 IDE 中使用代码补全时，它会建议扩展方法以及常规方法。

如果您通过观看视频来学习，请查看此扩展方法概述。

当您使用别人的 API 或实现一个被广泛使用的库时，更改 API 通常是不切实际的或不可能的。但是您可能仍然想添加一些功能。

例如，考虑以下将字符串解析为整数的代码

dart

int.parse('42')

如果该功能在 String 上，那么它会更好——更短且更易于使用工具

dart

'42'.parseInt()

要启用该代码，您可以导入一个包含 String 类扩展的库

dartimport 'string_apis.dart';
// ···
print('42'.parseInt()); // Use an extension method.

扩展不仅可以定义方法，还可以定义其他成员，如 getter、setter 和运算符。此外，扩展可以有名称，这在出现 API 冲突时很有帮助。以下是如何使用对字符串进行操作的扩展（名为 NumberParsing）来实现扩展方法 parseInt() 的方法

lib/string_apis.dart
dartextension NumberParsing on String {
  int parseInt() {
    return int.parse(this);
  }
  // ···
}

下一节介绍如何使用扩展方法。之后是关于实现扩展方法的部分。

像所有 Dart 代码一样，扩展方法都在库中。您已经了解如何使用扩展方法了——只需导入它所在的库，并像普通方法一样使用它

dart// Import a library that contains an extension on String.
import 'string_apis.dart';
// ···
print('42'.padLeft(5)); // Use a String method.
print('42'.parseInt()); // Use an extension method.

这通常是您使用扩展方法需要了解的全部内容。在您编写代码时，您可能还需要了解扩展方法如何依赖于静态类型（而不是 dynamic）以及如何解决 API 冲突。

您不能在 dynamic 类型的变量上调用扩展方法。例如，以下代码会导致运行时异常

dartdynamic d = '2';
print(d.parseInt()); // Runtime exception: NoSuchMethodError

扩展方法可以与 Dart 的类型推断一起使用。以下代码很好，因为推断变量 v 的类型为 String

dartvar v = '2';
print(v.parseInt()); // Output: 2

dynamic 不起作用的原因是扩展方法是根据接收者的静态类型解析的。因为扩展方法是静态解析的，所以它们与调用静态函数一样快。

有关静态类型和 dynamic 的更多信息，请参阅 Dart 类型系统。

如果扩展成员与接口或其他扩展成员冲突，则您有几个选项。

一种选择是更改导入冲突扩展的方式，使用 show 或 hide 来限制公开的 API

dart// Defines the String extension method parseInt().
import 'string_apis.dart';

// Also defines parseInt(), but hiding NumberParsing2
// hides that extension method.
import 'string_apis_2.dart' hide NumberParsing2;

// ···
// Uses the parseInt() defined in 'string_apis.dart'.
print('42'.parseInt());

另一种选择是显式应用扩展，这将导致代码看起来好像该扩展是一个包装器类

dart// Both libraries define extensions on String that contain parseInt(),
// and the extensions have different names.
import 'string_apis.dart'; // Contains NumberParsing extension.
import 'string_apis_2.dart'; // Contains NumberParsing2 extension.

// ···
// print('42'.parseInt()); // Doesn't work.
print(NumberParsing('42').parseInt());
print(NumberParsing2('42').parseInt());

如果两个扩展具有相同的名称，则您可能需要使用前缀导入

dart// Both libraries define extensions named NumberParsing
// that contain the extension method parseInt(). One NumberParsing
// extension (in 'string_apis_3.dart') also defines parseNum().
import 'string_apis.dart';
import 'string_apis_3.dart' as rad;

// ···
// print('42'.parseInt()); // Doesn't work.

// Use the ParseNumbers extension from string_apis.dart.
print(NumberParsing('42').parseInt());

// Use the ParseNumbers extension from string_apis_3.dart.
print(rad.NumberParsing('42').parseInt());

// Only string_apis_3.dart has parseNum().
print('42'.parseNum());

如示例所示，即使您使用前缀导入，也可以隐式调用扩展方法。唯一需要使用前缀的时间是在显式调用扩展时避免名称冲突。

使用以下语法创建扩展

extension <extension name>? on <type> { // <extension-name> is optional
  (<member definition>)* // Can provide one or more <member definition>.
}

例如，以下是如何在 String 类上实现扩展的方法

lib/string_apis.dart
dartextension NumberParsing on String {
  int parseInt() {
    return int.parse(this);
  }

  double parseDouble() {
    return double.parse(this);
  }
}

扩展的成员可以是方法、getter、setter 或运算符。扩展也可以具有静态字段和静态辅助方法。要访问扩展声明之外的静态成员，请像类变量和方法一样通过声明名称调用它们。

声明扩展时，可以省略名称。未命名的扩展仅在其声明的库中可见。由于它们没有名称，因此无法显式应用它们来解决 API 冲突。

dartextension on String {
  bool get isBlank => trim().isEmpty;
}

扩展可以具有泛型类型参数。例如，以下是一些使用 getter、运算符和方法扩展内置 List<T> 类型的代码

dartextension MyFancyList<T> on List<T> {
  int get doubleLength => length * 2;
  List<T> operator -() => reversed.toList();
  List<List<T>> split(int at) => [sublist(0, at), sublist(at)];
}

类型 T 是根据调用方法的列表的静态类型绑定的。

有关扩展方法的更多信息，请参阅以下内容

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

扩展方法

概述

使用扩展方法

静态类型和动态类型

API 冲突

实现扩展方法

未命名的扩展

实现泛型扩展

资源