What is the purpose of ` FutureOr `?

FutureOr<T> 是 Dart 语言中的一个类型，它用来表示一个变量可以是 Future<T> 类型或者是 T 类型。这种类型在 Dart 的异步编程中非常有用，尤其是当一个函数或者方法可能返回一个立即的值或者一个未来的值时。

这个类型主要用在函数的返回类型上，帮助开发者提供更灵活的 API。例如，假设我们需要实现一个函数，这个函数可能会从缓存中直接返回数据（一个立即的值），也可能会从网络获取数据（一个异步的 Future 值）。使用 FutureOr<T> 作为返回类型就可以很好地处理这种情况。

示例

考虑以下 Dart 函数示例：

dart
import 'dart:async';

// 模拟的数据库查询函数
Future<String> fetchDataFromDatabase() async {
  await Future.delayed(Duration(seconds: 2)); // 模拟网络延迟
  return "数据库数据";
}

// 模拟的从本地缓存获取数据的函数
String fetchDataFromCache() {
  return "缓存数据";
}

// 使用 FutureOr
FutureOr<String> getData(bool fromCache) {
  if (fromCache) {
    return fetchDataFromCache();
  } else {
    return fetchDataFromDatabase();
  }
}

Future<void> main() async {
  print(await getData(true));  // 输出: 缓存数据
  print(await getData(false)); // 输出: 数据库数据
}

在这个例子中，getData 函数根据传入的布尔值 fromCache 决定是直接返回缓存中的数据还是从数据库异步获取数据。返回类型 FutureOr<String> 允许这个函数返回一个 String 类型的值或一个 Future<String> 类型的值。这样的设计使得函数具有很高的灵活性，并且可以根据实际情况灵活处理同步或异步操作。