函数

内容 keyboard_arrow_down keyboard_arrow_up

参数
- 命名参数
- 可选位置参数
main() 函数
函数作为一等对象
匿名函数
词法作用域
词法闭包
测试函数相等性
返回值
生成器
外部函数

more_horiz

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

以下是如何实现函数的示例

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

尽管 Effective Dart 建议为公共 API 使用类型注释，但如果省略类型，函数仍然有效

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

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

dart

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

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

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

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

命名参数是可选的，除非它们被明确标记为 required。

定义函数时，使用 {param1, param2, …} 指定命名参数。如果不提供默认值或将命名参数标记为 required，则它们的类型必须为可空，因为它们的默认值为 null

dart/// Sets the [bold] and [hidden] flags ...
void enableFlags({bool? bold, bool? hidden}) {...}

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

dart

enableFlags(bold: true, hidden: false);

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

dart/// Sets the [bold] and [hidden] flags ...
void enableFlags({bool bold = false, bool hidden = false}) {...}

// bold will be true; hidden will be false.
enableFlags(bold: true);

如果你希望命名参数是必需的，要求调用者为参数提供值，请使用 required 对它们进行注释

dart

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

如果有人尝试在不指定 child 参数的情况下创建 Scrollbar，则分析器会报告问题。

你可能希望首先放置位置参数，但 Dart 并不需要这样做。当它适合你的 API 时，Dart 允许将命名参数放置在参数列表中的任何位置

dartrepeat(times: 2, () {
  ...
});

用 [] 包装一组函数参数会将它们标记为可选位置参数。如果您不提供默认值，它们的类型必须可为空，因为它们的默认值将为 null

dartString 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');

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

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

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

dartString 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() 函数返回 void，并有一个可选的 List<String> 参数用于参数。

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

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

以下是为命令行应用（它接受参数）编写的 main() 函数示例

args.dart
dart// Run the app like this: 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 库来定义和解析命令行参数。

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

dartvoid printElement(int element) {
  print(element);
}

var list = [1, 2, 3];

// Pass printElement as a parameter.
list.forEach(printElement);

您还可以将函数分配给变量，例如

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

此示例使用匿名函数。有关它们的更多信息，请参见下一部分。

大多数函数都有名称，例如 main() 或 printElement()。您还可以创建一个名为匿名函数（有时称为lambda 或闭包）的无名函数。您可以将匿名函数分配给变量，以便例如可以将其添加到集合中或从中删除它。

匿名函数看起来类似于命名函数——零个或多个参数，用逗号分隔，并用括号括起来，可选类型注释。

函数主体包含在以下代码块中

([[Type] param1[, …]]) {
  codeBlock;
};

以下示例定义了一个匿名函数，它有一个未类型化的参数 item，并将其传递给 map 函数。该函数针对列表中的每个项目调用，将每个字符串转换为大写。然后在传递给 forEach 的匿名函数中，每个转换后的字符串都会与其长度一起打印出来。

dartconst list = ['apples', 'bananas', 'oranges'];
list.map((item) {
  return item.toUpperCase();
}).forEach((item) {
  print('$item: ${item.length}');
});

点击运行以执行代码。

void main() {
  const list = ['apples', 'bananas', 'oranges'];
  list.map((item) {
    return item.toUpperCase();
  }).forEach((item) {
    print('$item: ${item.length}');
  });
}

如果函数只包含一个表达式或返回语句，您可以使用箭头表示法缩短它。将以下行粘贴到 DartPad 中，然后点击运行以验证它在功能上是等效的。

dartlist
    .map((item) => item.toUpperCase())
    .forEach((item) => print('$item: ${item.length}'));

Dart 是一种词法作用域语言，这意味着变量的作用域是静态确定的，只需通过代码布局即可。您可以“向外跟踪大括号”以查看变量是否在作用域中。

以下是在每个作用域级别都有变量的嵌套函数示例

dartbool 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/// Returns a function that adds [addBy] to the
/// function's argument.
Function makeAdder(int addBy) {
  return (int i) => addBy + i;
}

void main() {
  // Create a function that adds 2.
  var add2 = makeAdder(2);

  // Create a function that adds 4.
  var add4 = makeAdder(4);

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

以下是如何测试顶级函数、静态方法和实例方法是否相等的示例

dartvoid foo() {} // A top-level function

class A {
  static void bar() {} // A static method
  void baz() {} // An instance method
}

void main() {
  Function x;

  // Comparing top-level functions.
  x = foo;
  assert(foo == x);

  // Comparing static methods.
  x = A.bar;
  assert(A.bar == x);

  // Comparing instance methods.
  var v = A(); // Instance #1 of A
  var w = A(); // Instance #2 of A
  var y = w;
  x = w.baz;

  // These closures refer to the same instance (#2),
  // so they're equal.
  assert(y.baz == x);

  // These closures refer to different instances,
  // so they're unequal.
  assert(v.baz != w.baz);
}

所有函数都返回一个值。如果未指定返回值，则语句 return null; 会隐式追加到函数体。

dartfoo() {}

assert(foo() == null);

要在函数中返回多个值，请将值聚合在记录中。

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

当您需要延迟生成一系列值时，请考虑使用生成器函数。Dart 内置支持两种生成器函数

同步生成器：返回 Iterable 对象。
异步生成器：返回 Stream 对象。

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

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

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

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

如果您的生成器是递归的，则可以使用 yield* 提高其性能

dartIterable<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，或非重定向构造函数。一个实例变量也可以是 external，它等效于一个外部 getter 和（如果变量不是 final）一个外部 setter。

函数

参数

命名参数

可选位置参数

main() 函数

函数作为一等对象

匿名函数

词法作用域

词法闭包

测试函数相等性

返回值

生成器

外部函数