函数

优质
小牛编辑
128浏览
2023-12-01

Dart 是一个完全的面向对象语言,所以甚至连函数也是对象,而且拥有一个类型 Function。这意味着函数可以被赋值给一个变量,或者作为参数传递给其他函数。你可以把一个 Dart 类实例作为函数来调用,只要它是一个函数。详情请参阅 可被调用的类。

下面的例子展示了如何实现一个函数:

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

尽管 Effective Dart 推荐 为公共API添加类型注释,但是如果你忽略了类型,函数依然是可用的:

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

对那些只包含一个表达式的函数,你可以使用简写的语法:

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

这里的 => expre 语法是 { return expr; } 的简写。符号 => 有时被称为箭头语法。

说明:只有单个表达式——而不是语句——可以出现在箭头 (=>) 和 分号 (;) 的中间。比如,你不可以放 if 语句,但是可以使用 条件表达式。

函数有两种类型的参数:必须参数可选参数。必须参数在参数列表的前面,可选参数跟在后面。可选参数可以是命名参数位置参数

说明:一些 API——特别是 Flutter 控件——只使用命名参数,即使这些参数是强制的。阅读下节以了解详情。

可选参数

可选参数可以是位置参数或者命名参数,但不可以两者兼是。

命名参数

当调用一个函数时,你可以通过 参数名: 参数值 的格式指定命名参数。比如:

enableFlags(bold: true, hidden: false);

当定义一个函数时,使用 {参数1, 参数2, ...} 的格式来指定命名参数:

/// 设置可选的"加粗”和“隐藏”标志
void enableFlags({bool bold, bool hidden}) {
  // ...
}

尽管命名参数是一种可选参数,你可以使用 @required 注解来声明这个参数是强制的——即用户必须为这个参数提供一个值。比如:

const Scrollbar({Key key, @required Widget child})

当某人试图创建 Scrollbar 而不指定 child 参数时,分析器会报告一个问题。

要使用 @required 注解,依赖 meta 包并且引入 包:meta/meta.dart

Required 被定义在 meta 包中。可以直接导入 package:meta/meta.dart,也可以导入其他导出了 meta 的包,比如 Flutter 的 package:flutter/material.dart

位置参数

包裹函数的参数集到 [] 中来表明它们是可选参数:

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

下面的例子展示调用该函数时不带可选参数:

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

下面的例子展示调用该函数时带上第三个参数:

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

参数默认值

你可以使用 = 来为函数参数定义默认值,可适用于命名参数和位置参数。默认值必须是编译期常量。如果没有提供默认值,默认值便是 null

下面的例子展示为命名参数设置默认值:

/// 设置可选的 bold 和 hidden 标志
void enableFlags({bool bold = false, bool hidden = false}) {
  // ...
}

// bold 将会是true,hidden  将会是false
enableFlags(bold: true);

弃用说明:以前的代码可能会使用冒号 (:) 而不是 = 来设置命名参数的默认值。原因是之前只有 : 可以用来给命名参数设置默认值。而现在对 : 的支持可能会被废弃,所以我们推荐你 使用 = 来指定默认值

下一个例子展示如何为位置参数设置默认值:

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

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

你也可以使用列表或者映射作为默认值。下面的例子定义了一个函数 doStuff(),它为参数 list 指定了一个默认的列表,为参数 gifts 指定了一个默认的映射。

void doStuff(
    {List<int> list = const [1, 2, 3],
    Map<String, String> gifts = const {
      'first': 'paper',
      'second': 'cotton',
      'third': 'leather'
    }}) {
  print('list:  $list');
  print('gifts: $gifts');
}

main() 函数

每一个应用都有一个顶级的 main() 函数作为这个应用的入口。main() 函数返回 void 而且有一个可选的参数,类型为 List<String>

下面的例子是 web app 里面的 main() 函数:

void main() {
  querySelector('#sample_text_id')
    ..text = 'Click me!'
    ..onClick.listen(reverseText);
}

说明:上面代码中的 .. 语法被称作 级联。使用级联,你可以对单个对象的成员们进行多次操作。

下面的例子是命令行程序中的 main() 函数,它接受命令行参数:

// 像这样运行该程序:dart 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 库 来定义和解析命令行参数。

函数作为一等对象

你可以把函数作为参数传递给其他函数。比如:

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

var list = [1, 2, 3];

// 把 printElement 作为参数
list.forEach(printElement);

你也可以把函数赋值给一个变量,比如;

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

这个例子使用了匿名函数。下一节会详细讲解匿名函数。

匿名函数

大部分函数都有一个名字,比如 main() 或者 printElement()。你也可以创建无名函数,它们叫做“匿名函数”,有时也被称为 "lambda" 或者 "闭包"。你可能会将匿名函数赋值给一个变量,以便后续使用,比如,你可以将它添加到一个集合,或者从集合移除。

匿名函数看起来就像一个命名函数——括号中0个或多个参数、逗号隔开、可选的类型注释。

之后的代码块包含了函数的主体:

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

下面的例子定义了一个匿名函数,包含一个无类型的参数 item。这个函数会从列表中的每一个元素调用,打印一个包含了在指定索引处的值的字符串。

var list = ['apples', 'bananas', 'oranges'];
list.forEach((item) {
  print('${list.indexOf(item)}: $item');
});

如果这个函数只包含一个语句,你可以使用箭头符号简化它,它们的效果是等价的:

list.forEach(
    (item) => print('${list.indexOf(item)}: $item'));

词法作用域

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

/// 返回一个函数,该函数会添加 "addBy" 到
/// 这个函数的参数上并返回
Function makeAdder(num addBy) {
  return (num i) => addBy + i;
}

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

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

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

验证函数的相等性

下面的例子验证了顶级函数、静态函数和实例方法的相等性:

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

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

void main() {
  var x;

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

  // 比较静态函数
  x = A.bar;
  assert(A.bar == x);

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

  // 闭包指向同一个实例,
  // 因此它们是相等的
  assert(y.baz == x);

  // 闭包指向不同的实例,
  // 因此它们是不相等的
  assert(v.baz != w.baz);
}

返回值

所有函数都有返回值。如果没有指定返回值,那么语句 return null; 会被隐式地添加到函数体上:

foo() {}

assert(foo() == null);