內容

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; } 的簡寫。=> 符號有時稱為箭號語法。

參數

#

函式可以有任意數量的必要位置參數。這些參數後面可以接續命名參數或選用位置參數(但不能同時接續這兩種參數)。

當您將引數傳遞給函式或定義函式參數時,可以使用 尾端逗號

命名參數

#

命名參數是選用的,除非它們明確標記為 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});

如果有人嘗試建立 Scrollbar 而未指定 child 參數,則分析器會報告問題。

您可能想先放置位置參數,但 Dart 並不要求這樣做。當符合您的 API 時,Dart 允許將命名參數放置在參數清單中的任何位置

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() 函數範例

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 函式庫 定義和剖析命令列參數。

函式作為一等物件

#

您可以將函數傳遞為參數給另一個函數。例如

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

var list = [1, 2, 3];

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

您也可以將函數指定給變數,例如

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

此範例使用匿名函數。有關這些函數的更多資訊,請參閱下一部分。

匿名函式

#

大多數函式都有名稱,例如 main()printElement()。您也可以建立一個沒有名稱的函式,稱為匿名函式,有時也稱為lambda封閉。您可以將匿名函式指定給變數,例如,您可以將它新增或移除至集合中。

匿名函式看起來類似於有名稱的函式,在括號中,零個或多個參數,以逗號分隔,並可選擇類型註解。

函式主體包含在後面的程式碼區塊中

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

以下範例定義一個匿名函式,其中包含一個未指定類型的參數 item,並將它傳遞給 map 函式。函式會針對清單中的每個項目呼叫,將每個字串轉換成大寫。然後在傳遞給 forEach 的匿名函式中,會列印出每個已轉換的字串及其長度。

dart
const 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 中,並按一下執行以驗證它在功能上是等效的。

dart
list
    .map((item) => item.toUpperCase())
    .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
/// 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);
}

測試函式的相等性

#

以下是測試頂層函式、靜態方法和實例方法是否相等的範例

dart
void 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; 會隱含附加到函式主體。

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 中使用。實作和使用在很大程度上取決於平台,因此請查看互通語境文件,例如 CJavaScript,以瞭解更多資訊。

外部函式可以是頂層函式、執行個體方法取得器或設定器,或非重新導向建構函式執行個體變數也可以是 external,這等同於一個外部取得器,而且(如果變數不是 final)一個外部設定器。