Skip to content

函数
Dart 是一门真正的面向对象语言,因此即使是函数也是对象,并且具有类型 Function。这意味着函数可以被赋值给变量或作为参数传递给其他函数。你还可以像调用函数一样调用 Dart 类的实例。详细信息请参阅可调用对象。

以下是实现函数的示例:

dart
bool isNoble(int atomicNumber) {
  return _nobleGases[atomicNumber] != null;
}

尽管《Effective Dart》建议为公共 API 添加类型注解,但即使省略类型,该函数仍然可以正常工作:

dart
isNoble(atomicNumber) {
  return _nobleGases[atomicNumber] != null;
}

对于仅包含一个表达式的函数,可以使用简写语法:

dart
bool isNoble(int atomicNumber) => _nobleGases[atomicNumber] != null;

=> expr 语法是 { return expr; } 的简写形式。=> 表示法有时被称为箭头语法。

注意
箭头(=>)和分号(;)之间只能出现表达式。表达式会计算出一个值。这意味着你不能在 Dart 期望值的地方编写语句。例如,你可以使用条件表达式,但不能使用 if 语句。在前面的示例中,_nobleGases[atomicNumber] != null 返回一个布尔值。该函数随后返回一个布尔值,用于指示 atomicNumber 是否属于惰性气体范围。

参数

位置参数

函数可以有任意数量的必需位置参数。这些参数后面可以跟命名参数或可选位置参数(但不能同时跟两者)。

注意
某些 API(尤其是 Flutter 小部件构造函数)即使对于必需参数也仅使用命名参数。详情请参阅下一节。

在传递函数参数或定义函数参数时,可以使用尾随逗号。

命名参数

命名参数是可选的,除非它们被显式标记为必需。

在定义函数时,使用 {param1, param2, …} 来指定命名参数。如果你没有为命名参数提供默认值或将其标记为必需,则它们的类型必须为可空类型,因为它们的默认值将是 null

dart
/// 设置 [bold][hidden] 标志 ...
void enableFlags({bool? bold, bool? hidden}) {
  ...
}

在调用函数时,可以使用 paramName: value 指定命名参数。例如:

dart
enableFlags(bold: true, hidden: false);

要为命名参数定义除 null 之外的默认值,请使用 = 指定默认值。指定的值必须是编译时常量。例如:

dart
/// 设置 [bold][hidden] 标志 ...
void enableFlags({bool bold = false, bool hidden = false}) {
  ...
}

// bold 将为 true;hidden 将为 false。
enableFlags(bold: true);

如果你希望命名参数是必需的,要求调用者为该参数提供值,请使用 required 注解:

dart
const Scrollbar({super.key, required Widget child});

如果有人尝试创建 Scrollbar 而不指定 child 参数,则分析器会报告问题。

注意
标记为必需的参数仍然可以是可空的:

dart
const Scrollbar({super.key, required Widget? child});

你可能希望将位置参数放在前面,但 Dart 并不强制要求。Dart 允许命名参数在参数列表中的任何位置,只要适合你的 API:

dart
repeat(times: 2, () {
  ...
});

可选位置参数

将一组函数参数包装在 [] 中,可以将其标记为可选位置参数。如果你没有为它们提供默认值,则它们的类型必须为可空类型,因为它们的默认值将是 null

dart
String say(String from, String msg, [String? device]) {
  var result = '$from says $msg';
  if (device != null) {
    result = '$result with a $device';
  }
  return result;
}

以下是一个不使用可选参数调用此函数的示例:

dart
assert(say('Bob', 'Howdy') == 'Bob says Howdy');

以下是一个使用第三个参数调用此函数的示例:

dart
assert(
  say('Bob', 'Howdy', 'smoke signal') ==
      'Bob says Howdy with a smoke signal',
);

要为可选位置参数定义除 null 之外的默认值,请使用 = 指定默认值。指定的值必须是编译时常量。例如:

dart
String say(String from, String msg, [String device = 'carrier pigeon']) {
  var result = '$from says $msg with a $device';
  return result;
}

assert(say('Bob', 'Howdy') == 'Bob says Howdy with a carrier pigeon');

main() 函数

每个应用程序都必须有一个顶级 main() 函数,它作为应用程序的入口点。main() 函数返回 void,并且具有一个可选的 List<String> 参数用于接收命令行参数。

以下是一个简单的 main() 函数:

dart
void main() {
  print('Hello, World!');
}

以下是一个命令行应用程序的 main() 函数示例,该程序接受参数:

dart
// args.dart
// 运行应用程序的方式:dart run args.dart 1 test
void main(List<String> arguments) {
  print(arguments);

  assert(arguments.length == 2);
  assert(int.parse(arguments[0]) == 1);
  assert(arguments[1] == 'test');
}

你可以使用 args 库来定义和解析命令行参数。

函数作为一等对象

你可以将函数作为参数传递给另一个函数。例如:

dart
void printElement(int element) {
  print(element);
}

var list = [1, 2, 3];

// 将 printElement 作为参数传递。
list.forEach(printElement);

你还可以将函数赋值给变量,例如:

dart
var loudify = (msg) => '!!! ${msg.toUpperCase()} !!!';
assert(loudify('hello') == '!!! HELLO !!!');

此示例使用了一个匿名函数。更多内容将在下一节中介绍。

函数类型

你可以指定函数的类型,这被称为函数类型。函数类型是通过将函数声明头中的函数名称替换为关键字 Function 而获得的。此外,你可以省略位置参数的名称,但不能省略命名参数的名称。例如:

dart
void greet(String name, {String greeting = 'Hello'}) =>
    print('$greeting $name!');

// 将 `greet` 存储在变量中并调用它。
void Function(String, {String greeting}) g = greet;
g('Dash', greeting: 'Howdy');

注意
在 Dart 中,函数是一等对象,这意味着它们可以被赋值给变量、作为参数传递,并且可以从其他函数返回。

你可以使用 typedef 声明显式命名函数类型,这对于清晰性和可重用性非常有用。

匿名函数

尽管你为大多数函数命名,例如 main()printElement(),但你也可以创建没有名称的函数。这些函数被称为匿名函数、lambda 或闭包。

匿名函数类似于命名函数,因为它具有:

  • 零个或多个参数,用逗号分隔
  • 括号之间的可选类型注解
  • 包含函数主体的代码块:
dart
([[Type] param1[, ...]]) {
  codeBlock;
}

以下示例定义了一个带有未类型化参数 item 的匿名函数。该匿名函数将其传递给 map 函数。map 函数针对列表中的每个项调用,将每个字符串转换为大写。然后,传递给 forEach 的匿名函数打印每个转换后的字符串及其长度。

dart
const list = ['apples', 'bananas', 'oranges'];

var uppercaseList = list.map((item) {
  return item.toUpperCase();
}).toList();
// 在映射后转换为列表

for (var item in uppercaseList) {
  print('$item: ${item.length}');
}

点击“运行”以执行代码。

如果函数仅包含单个表达式或返回语句,可以使用箭头表示法将其缩短。将以下行粘贴到 DartPad 中并点击“运行”以验证其功能是否等效:

dart
var uppercaseList = list.map((item) => item.toUpperCase()).toList();
uppercaseList.forEach((item) => print('$item: ${item.length}'));

词法作用域

Dart 根据代码的布局确定变量的作用域。具有此特性的编程语言被称为词法作用域语言。你可以通过“向外跟随大括号”来判断变量是否在作用域内。

示例:一系列嵌套函数,每个作用域级别都有变量:

dart
bool topLevel = true;

void main() {
  var insideMain = true;

  void myFunction() {
    var insideFunction = true;

    void nestedFunction() {
      var insideNestedFunction = true;

      assert(topLevel);
      assert(insideMain);
      assert(insideFunction);
      assert(insideNestedFunction);
    }
  }
}

nestedFunction() 方法可以使用从每个级别一直到顶级的作用域中的变量。

词法闭包

一个函数对象如果可以在其词法作用域之外访问该作用域中的变量,则称为闭包。

函数可以关闭围绕其定义的周围作用域中的变量。在以下示例中,makeAdder() 捕获了变量 addBy。无论返回的函数去到哪里,它都会记住 addBy

dart
/// 返回一个将 [addBy] 加到
/// 函数参数的函数。
Function makeAdder(int addBy) {
  return (int i) => addBy + i;
}

void main() {
  // 创建一个加 2 的函数。
  var add2 = makeAdder(2);

  // 创建一个加 4 的函数。
  var add4 = makeAdder(4);

  assert(add2(3) == 5);
  assert(add4(3) == 7);
}

撕下(Tear-offs)

当你引用一个函数、方法或命名构造函数而不带括号时,Dart 会创建一个撕下(tear-off)。这是一个闭包,它接受与函数相同的参数,并在你调用它时调用底层函数。如果你的代码需要一个调用具有与撕下相同参数的命名函数的闭包,请不要将调用包装在 lambda 中。使用撕下。

dart
var charCodes = [68, 97, 114, 116];
var buffer = StringBuffer();

好的
// 函数撕下
charCodes.forEach(print);

// 方法撕下
charCodes.forEach(buffer.write);

不好的
// 函数 lambda
charCodes.forEach((code) { print(code); });

// 方法 lambda
charCodes.forEach((code) { buffer.write(code); });

测试函数相等性

以下是一个测试顶级函数、静态方法和实例方法相等性的示例:

dart
void foo() {} // 一个顶级函数

class A {
  static void bar() {} // 一个静态方法
  void baz() {} // 一个实例方法
}

void main() {
  Function x;

  // 比较顶级函数。
  x = foo;
  assert(foo == x);

  // 比较静态方法。
  x = A.bar;
  assert(A.bar == x);

  // 比较实例方法。
  var v = A(); // A 的实例 #1
  var w = A(); // A 的实例 #2
  var y = w;
  x = w.baz;

  // 这些闭包引用同一个实例 (#2),
  // 因此它们相等。
  assert(y.baz == x);

  // 这些闭包引用不同的实例,
  // 因此它们不相等。
  assert(v.baz != w.baz);
}

返回值

所有函数都返回一个值。如果没有指定返回值,则语句 return null; 会被隐式附加到函数体。

dart
foo() {}

assert(foo() == null);

要在函数中返回多个值,可以将这些值聚合到一个记录中。

dart
(String, int) foo() {
  return ('something', 42);
}

生成器

当你需要懒惰地生成一系列值时,可以考虑使用生成器函数。Dart 内置支持两种类型的生成器函数:

  • 同步生成器:返回一个 Iterable 对象。
  • 异步生成器:返回一个 Stream 对象。

要实现一个同步生成器函数,将函数体标记为 sync*,并使用 yield 语句传递值:

dart
Iterable<int> naturalsTo(int n) sync* {
  int k = 0;
  while (k < n) yield k++;
}

要实现一个异步生成器函数,将函数体标记为 async*,并使用 yield 语句传递值:

dart
Stream<int> asynchronousNaturalsTo(int n) async* {
  int k = 0;
  while (k < n) yield k++;
}

如果你的生成器是递归的,可以通过使用 yield* 来提高其性能:

dart
Iterable<int> naturalsDownFrom(int n) sync* {
  if (n > 0) {
    yield n;
    yield* naturalsDownFrom(n - 1);
  }
}

外部函数

外部函数是其主体与其声明分开实现的函数。在函数声明前包含 external 关键字,如下所示:

dart
external void someFunc(int i);

外部函数的实现可以来自另一个 Dart 库,或者更常见的是来自另一种语言。在互操作上下文中,external 引入了对外部函数或值的类型信息,使其可以在 Dart 中使用。实现和使用高度依赖于平台,因此请查看例如 C 或 JavaScript 的互操作文档以了解更多信息。

外部函数可以是顶级函数、实例方法、getter 或 setter,或者非重定向构造函数。实例变量也可以是外部的,这相当于一个外部 getter 和(如果变量不是 final)一个外部 setter。