Dart基础之定义函数

4,163 阅读5分钟

Dart是一个真-面向对象语言,所以甚至连 functions 都是objects,并且有一个类型叫 Function。 这表示functons可以被变量指定或者以参数的方式传递给其他functions。如果Dart类型实例是一个function的话你也可以直接调用。

Demo:

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

虽然Effective Dart建议为公共API注释类型,但如果省略类型,该函数仍然有效:

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

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

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

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

注意:箭头(=>)和分号(;)之间只能出现表达式而非语句。 例如,您不能在其中放置if语句,但可以使用条件表达式。

函数可以有两种类型的参数:必需和可选。 首先列出所需参数,然后列出任何可选参数。 可选参数可以是命名的或位置的。

注意:某些API(特别是Flutter widget构造函数)仅命名参数,即使对于必需参数也是如此。

(可选参数)Optional parameters

可选参数可以是命名参数,也可以是位置参数,但不能同时满足

(命名参数)Named parameters

调用函数时,你可以使用 paramName:value 这样的形式指定命名参数。 例如:

enableFlags(bold: true, hidden: false);

定义函数时,使用{param1,param2,...}去指定命名参数:

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

尽管命名参数是一种可选参数,但您可以使用@required对它们进行注释,以指示该参数是必需的 - 用户必须为参数提供值。 例如:

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

如果有人尝试创建Scrollbar而未指定child的参数,解析器就会报错。 要使用@required注释,请依赖于meta包和导入 package:meta/meta.dart

(位置参数)Positional parameters

[]中包装一组函数参数将它们标记为可选的位置参数:

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

参数默认数值

在function 中用 = 来定义参数默认值,命名参数和位置参数同时适用。 默认值必须是编译时常量,如果没有提供默认值,默认是 null

以下是一个命名参数的默认值例子:

/// 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);

注意废弃:老代码可能使用了一个(:)来代替=设置参数默认值。原因是一开始只有:支持命名参数,现在这个支持可能会被废弃,所以推荐使用 =

接下来是设置位置参数的默认值例子:

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

你也可以传递 lists 或者 maps 作为默认值,demo如下:

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()函数

每个app都必须有一个顶级的 main()函数作为一个app的入口服务。 main()函数返回void并且有一个可选参数List<String>

一个 web app 的main()函数例子:

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

注意:前面代码中的..语法称为级联。 使用级联,可以对单个对象的成员们执行多个操作。

一个 command-line app main()函数例子:

// Run the app like this: 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 lib 依赖去定义和解析 command-line 参数。

Functions 作为优秀的对象

你可以把function作为一个参数传递给另外一个function, 例如:

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

var list = [1, 2, 3];

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

你也可以把一个function 指定给一个变量,例如:

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

这个例子用了一个匿名函数。更多关于匿名函数的知识,随后分解。

匿名函数(Anonymous functions)

大对数的函数都是有名字的,例如main()或者printElement()。当然你也可以创建没有名字的函数(匿名函数),或者有时候一个 lambda 或者 closure(闭包)。你可能把一个匿名函数赋值给一个变量,例如,你可以从一个集合中添加或者删除。 一个匿名函数跟命名函数看上去很相似 - 0个或更多的参数,由逗号分开,还有可选的类型注释, 位于括号之间。

以下的代码块包含了函数体:

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

以下示例定义一个匿名函数,使用无类型参数 item。 这个函数打印list中每个字符串,并且输出字符串在list中的索引

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

//输出
//0: apples
//1: bananas
//2: oranges

如果函数只含有一个语句。则可以使用箭头表示法缩短它

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

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

测试函数是否相等

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

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

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

void main() {
  var 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);
}

返回值

所有函数都返回一个值。 如果未指定返回值,则该语句返回null隐式附加到函数体。

foo() {}

assert(foo() == null);