扩展方法
扩展方法为现有库添加了功能。你可能在不知情的情况下使用了扩展方法。例如,当你在 IDE 中使用代码补全时,它会在常规方法旁边建议扩展方法。
如果你喜欢通过视频学习,可以看看这个扩展方法概述视频。
概览
#当你使用别人的 API 或者实现一个广泛使用的库时,通常修改 API 是不切实际或不可能的。但你可能仍然希望添加一些功能。
例如,考虑以下将字符串解析为整数的代码
int.parse('42')
如果这个功能直接放在 String
上,可能会更好——代码更短,也更容易与工具一起使用
'42'.parseInt()
要启用该代码,你可以导入一个包含对 String
类扩展的库
import 'string_apis.dart';
void main() {
print('42'.parseInt()); // Use an extension method.
}
扩展不仅可以定义方法,还可以定义其他成员,例如 getter、setter 和运算符。此外,扩展可以有名称,这有助于解决 API 冲突。以下是如何实现扩展方法 parseInt()
的示例,它使用一个操作字符串的扩展(命名为 NumberParsing
)
extension NumberParsing on String {
int parseInt() {
return int.parse(this);
}
}
下一节介绍如何使用扩展方法。之后是关于实现扩展方法的部分。
使用扩展方法
#与所有 Dart 代码一样,扩展方法位于库中。你已经了解了如何使用扩展方法——只需导入它所在的库,然后像普通方法一样使用它即可
// Import a library that contains an extension on String.
import 'string_apis.dart';
void main() {
print('42'.padLeft(5)); // Use a String method.
print('42'.parseInt()); // Use an extension method.
}
这通常就是你使用扩展方法所需了解的全部内容。在编写代码时,你可能还需要了解扩展方法如何依赖于静态类型(而非 dynamic
)以及如何解决 API 冲突。
静态类型与 dynamic
#你不能在类型为 dynamic
的变量上调用扩展方法。例如,以下代码会导致运行时异常
dynamic d = '2';
print(d.parseInt()); // Runtime exception: NoSuchMethodError
扩展方法确实与 Dart 的类型推断一起工作。以下代码是正确的,因为变量 v
被推断为 String
类型
var v = '2';
print(v.parseInt()); // Output: 2
dynamic
不起作用的原因是扩展方法是根据接收者的静态类型解析的。由于扩展方法是静态解析的,它们与调用静态函数一样快。
有关静态类型和 dynamic
的更多信息,请参阅 Dart 类型系统。
API 冲突
#如果扩展成员与接口或另一个扩展成员冲突,则你有以下几种选择。
一种选择是改变导入冲突扩展的方式,使用 show
或 hide
来限制暴露的 API
// 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;
void main() {
// Uses the parseInt() defined in 'string_apis.dart'.
print('42'.parseInt());
}
另一种选择是显式应用扩展,这会使代码看起来好像扩展是一个包装类
// 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.
void main() {
// print('42'.parseInt()); // Doesn't work.
print(NumberParsing('42').parseInt());
print(NumberParsing2('42').parseInt());
}
如果两个扩展具有相同的名称,则可能需要使用前缀导入
// 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;
void main() {
// 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
类上实现扩展的方法
extension NumberParsing on String {
int parseInt() {
return int.parse(this);
}
double parseDouble() {
return double.parse(this);
}
}
扩展的成员可以是方法、getter、setter 或运算符。扩展还可以有静态字段和静态辅助方法。要访问扩展声明之外的静态成员,可以通过声明名称调用它们,就像 类变量和方法一样。
匿名扩展
#声明扩展时,可以省略名称。匿名扩展仅在其声明所在的库中可见。由于它们没有名称,因此不能显式应用来解决 API 冲突。
extension on String {
bool get isBlank => trim().isEmpty;
}
实现泛型扩展
#扩展可以有泛型类型参数。例如,以下是一些代码,它使用 getter、运算符和方法扩展内置的 List<T>
类型
extension 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
是根据调用方法的列表的静态类型绑定的。
资源
#有关扩展方法的更多信息,请参阅以下内容