类型别名

typedefs

理论

1. 什么是类型别名？

在Dart中，类型别名(Type Alias)允许您为现有的类型(无论是函数类型还是非函数类型)创建另一个名称。它就像给一个变量起了个“昵称”一样，这个昵称与原始类型可以互换使用，但它本身不创建新类型，只是提供了一个新的引用方式。

它的主要作用是提高代码的可读性、简洁性，并方便类型声明。

2. 为什么需要类型别名？

简化复杂类型声明: 当您有一个非常长的、难以阅读的函数类型或泛型类型时，类型别名可以为其提供一个简短、富有意义的名称。
提高代码可读性: 使用一个描述性强的别名可以使代码意图更清晰。
方便重构: 如果某个复杂类型在代码中多处使用，未来需要修改该类型的定义时，只需要修改类型别名定义处即可，而无需修改所有使用它的地方。
在早期Dart版本中对函数类型声明的必要性: 在Dart 2.13版本之前，typedef主要用于为函数类型创建别名。从Dart 2.13开始，typedef的功能得到了增强，现在可以为任何类型创建别名。

3. `typedef`关键字

在Dart中，使用typedef关键字来定义类型别名。

注意: 从Dart 2.13版本开始，typedef的使用范围扩展到了所有类型。在之前的版本中，它主要用于函数类型。

示例

函数类型别名

这是typedef最经典的用法。

场景: 假设你有一个回调函数，它接受两个int类型的参数，并返回一个String类型。

// main.dart 中
// Dart SDK 版本: >= 2.13.0

// 方式一：不使用类型别名，直接声明。函数签名很长时代码会变得冗余。
String processNumbers(int a, int b, String Function(int, int) operation) {
  return operation(a, b);
}

// 定义一个函数类型别名，名为 'TwoIntOperation'
// 它代表一个接受两个 int 参数并返回 String 的函数。
typedef TwoIntOperation = String Function(int a, int b);

// 方式二：使用类型别名声明回调参数
String processNumbersWithAlias(int a, int b, TwoIntOperation operation) {
  return operation(a, b);
}

// 实际的回调函数
String addAndFormat(int x, int y) {
  return 'The sum is: ${x + y}';
}

String multiplyAndDescribe(int x, int y) {
  return 'Multiplying $x by $y gives: ${x * y}';
}

// 旧版Dart (<= 2.12.x) 的函数类型别名写法 (已不推荐使用，但了解其历史有帮助)
// typedef String TwoIntOperationLegacy(int a, int b);

void main() {
  print('--- 不使用类型别名 ---');
  String result1 = processNumbers(5, 3, addAndFormat);
  print(result1); // 输出: The sum is: 8

  String result2 = processNumbers(10, 2, multiplyAndDescribe);
  print(result2); // 输出: Multiplying 10 by 2 gives: 20

  print('\n--- 使用类型别名 ---');
  String resultAlias1 = processNumbersWithAlias(7, 4, addAndFormat);
  print(resultAlias1); // 输出: The sum is: 11

  String resultAlias2 = processNumbersWithAlias(6, 5, multiplyAndDescribe);
  print(resultAlias2); // 输出: Multiplying 6 by 5 gives: 30

  // 类型别名可以直接作为变量类型使用
  TwoIntOperation mySumFunc = addAndFormat;
  print('Using alias directly: ${mySumFunc(100, 20)}'); // 输出: Using alias directly: The sum is: 120
}

非函数类型别名

从Dart 2.13开始，typedef不再局限于函数，可以为任何类型创建别名，尤其是复杂的泛型类型。

场景: 假设您在应用中大量使用了一个嵌套的Map类型来表示配置数据或复杂的JSON结构。

// main.dart 中
// Dart SDK 版本: >= 2.13.0

// 定义一个复杂的泛型类型
typedef NestedConfig = Map<String, Map<String, List<String>>>;

// 定义一个更简单的列表类型别名
typedef IdList = List<String>;


// 使用类型别名作为参数类型
void processConfigurations(NestedConfig config) {
  print('Processing configurations:');
  for (var entry in config.entries) {
    print('  ${entry.key}:');
    for (var subEntry in entry.value.entries) {
      print('    ${subEntry.key}: ${subEntry.value.join(', ')}');
    }
  }
}

// 可以在类中使用别名
class MyDataManager {
  NestedConfig _data;
  IdList _recentlyAccessedIds;

  MyDataManager(this._data, this._recentlyAccessedIds);

  void addId(String id) {
    _recentlyAccessedIds.add(id);
  }

  void printIds() {
    print('Recently accessed IDs: ${_recentlyAccessedIds.join(', ')}');
  }
}


void main() {
  // 不使用类型别名时，需要写出完整的泛型类型
  Map<String, Map<String, List<String>>> appSettings = {
    'general': {
      'themes': ['dark', 'light'],
      'languages': ['en', 'zh_CN']
    },
    'security': {
      'auth_methods': ['password', 'fingerprint']
    }
  };

  print('--- 不使用类型别名声明 ---');
  print(appSettings);

  // 使用类型别名声明
  NestedConfig userSettings = {
    'profile': {
      'display_name': ['John Doe'],
      'email': ['john.doe@example.com']
    }
  };

  print('\n--- 使用类型别名声明 ---');
  print(userSettings);

  print('\n--- 将别名作为参数传入函数 ---');
  processConfigurations(userSettings);

  print('\n--- 在类中使用类型别名 ---');
  MyDataManager manager = MyDataManager(
      appSettings,
      ['user_123', 'user_abc']
  );
  manager.addId('user_xyz');
  manager.printIds();
}

解析:

typedef NestedConfig = Map<String, Map<String, List<String>>>; 这一行定义了一个别名NestedConfig来代表一个复杂的嵌套Map类型。
typedef IdList = List<String>; 为 List<String>定义了别名IdList，使其意图更明确。
现在，您可以像使用普通类型一样使用NestedConfig和IdList来声明变量、函数参数、甚至类的成员。

注意事项

不创建新类型: 类型别名只是现有类型的另一个名字，它不会创建一个全新的类型。因此，原始类型和其别名可以互换使用。例如，上面的TwoIntOperation类型的变量可以赋值给String Function(int, int)类型的期望，反之亦然。
兼容性: typedef关键字用于非函数类型别名是从Dart SDK 2.13.0开始引入的。如果您使用的是较旧的Dart版本，非函数类型别名可能会报错。函数类型别名在更早的版本中也支持，但语法略有不同(例如typedef String MyFunc(int a, int b);而不是typedef MyFunc = String Function(int a, int b);）。强烈建议使用新版语法。
命名约定: 类型别名通常遵循与类相似的命名约定，即使用PascalCase(大驼峰命名法）。
泛型支持: 类型别名自身也可以是泛型的，这在定义复杂泛型结构时非常有用。

// 范例：泛型类型别名
typedef ItemProcessor<T> = void Function(T item);

void processStringItem(String item) {
  print('Processing string: $item');
}

void processIntItem(int item) {
  print('Processing int: ${item * 2}');
}

void main() {
  ItemProcessor<String> stringCallback = processStringItem;
  stringCallback('hello'); // Output: Processing string: hello

  ItemProcessor<int> intCallback = processIntItem;
  intCallback(5); // Output: Processing int: 10
}

作用域: 类型别名的作用域与普通顶级声明一样，可以在文件内或通过export跨文件使用。
与class或enum的区别:
- typedef为现有类型创建别名，不引入新的“种类”或行为。
- class创建一种全新的类型，包含其自己的属性和方法。
- enum创建一组命名的常量。类型别名更像是编程语言中的语法糖，用于提升可读性和代码的整洁性。

Isolates

元数据