Dart-Typedefs

1. typedef 概述

typedef(类型定义)用于为函数类型定义一个别名,使代码更易读和维护。通过 typedef,可以将复杂的函数类型简化为一个更具描述性的名称,增强代码的可读性。

2. 定义 typedef

typedef Name = ExistingType;

在函数类型中,通常使用以下语法:

typedef ReturnType Name(ParameterType1 param1, ParameterType2 param2);

3. 示例

typedef IntBinaryOperation = int Function(int a, int b);

int add(int a, int b) => a + b;
int subtract(int a, int b) => a - b;

void main() {
  IntBinaryOperation operation;

  operation = add;
  print(operation(3, 4)); // 输出: 7

  operation = subtract;
  print(operation(3, 4)); // 输出: -1
}

解释一下这段函数代码

typedef定义

1、这行代码使用 typedef 定义了一个名为 IntBinaryOperation 的函数类型别名。这个别名表示一个函数,它接受两个 int 类型的参数,并返回一个 int 类型的结果。
2、IntBinaryOperation:这是我们给这个函数类型起的名字。
int Function(int a, int b):这是函数类型签名,表示函数接受两个 int 类型的参数 a 和 b,并返回一个 int 类型的结果。

函数定义

int add(int a, int b) => a + b;
int subtract(int a, int b) => a - b;

int add(int a, int b) => a + b;:这是一个普通的函数,接受两个 int 类型的参数 a 和 b,返回它们的和。
int subtract(int a, int b) => a - b;:这是另一个普通的函数,接受两个 int 类型的参数 a 和 b,返回 a 减 b 的结果。

main 函数

void main() {
  IntBinaryOperation operation;
  
  operation = add;
  print(operation(3, 4)); // 输出: 7

  operation = subtract;
  print(operation(3, 4)); // 输出: -1
}

步骤解析:
IntBinaryOperation operation;

声明了一个名为 operation 的变量,其类型是我们之前定义的 IntBinaryOperation。也就是说,这个变量可以引用任何符合 IntBinaryOperation 类型签名的函数。
operation = add;

将 add 函数赋值给 operation 变量。现在,operation 变量引用的是 add 函数。
print(operation(3, 4)); // 输出: 7

调用 operation 函数,传入参数 3 和 4。由于此时 operation 引用了 add 函数,所以实际执行的是 add(3, 4),结果是 7,并打印输出。
operation = subtract;

将 subtract 函数赋值给 operation 变量。现在,operation 变量引用的是 subtract 函数。
print(operation(3, 4)); // 输出: -1

调用 operation 函数,传入参数 3 和 4。由于此时 operation 引用了 subtract 函数,所以实际执行的是 subtract(3, 4),结果是 -1,并打印输出。

4、泛型 typedef

typedef 也可以与泛型一起使用,定义更加通用的函数类型别名。

 typedef Compare<T> = int Function(T a, T b);

int compareInt(int a, int b) => a - b;
int compareStringLength(String a, String b) => a.length - b.length;

void main() {
  Compare<int> intComparer = compareInt;
  Compare<String> stringLengthComparer = compareStringLength;

  print(intComparer(3, 4)); // 输出: -1
  print(stringLengthComparer("hello", "world!")); // 输出: -1
}

Compare<T> 是一个泛型函数类型别名,表示接受两个类型为 T 的参数并返回一个 int。
intComparer 和 stringLengthComparer 分别是用于比较 int 和 String 长度的函数。

5、使用 typedef 提升代码可读性

typedef 可以在多个地方提升代码的可读性和可维护性,特别是在回调函数和事件处理程序中。

typedef EventCallback = void Function(String event);

class Button {
  EventCallback? onClick;

  void click(String event) {
    if (onClick != null) {
      onClick!(event);
    }
  }
}

void main() {
  var button = Button();

  button.onClick = (event) => print('Button clicked: $event');
  button.click('start'); // 输出: Button clicked: start
}

EventCallback 是一个函数类型别名,表示接受一个 String 参数并返回 void。
Button 类使用 EventCallback 类型来定义 onClick 回调函数,使事件处理逻辑更加清晰。
下面来详细解释下这段代码

Typedef 定义

typedef EventCallback = void Function(String event);

(1)用 typedef 关键字定义函数类型别名
(2)函数类型别名为EventCallback
(3)右边指定了函数类型,并且该函数接收一个string类型的参数 event,这个函数没有返回值 返回void

定义 Button 类

class Button {
  EventCallback? onClick;

  void click(String event) {
    if (onClick != null) {
      onClick!(event);
    }
  }
}

1、定义 Button 类
2、定义一个名为 onClick 的可选属性(EventCallback? 表示该属性可以是 EventCallback 类型的函数,也可以是 null)。
3、onClick 是一个函数类型的变量,用于存储事件回调函数。
4、void click(String event) {:
定义一个名为 click 的方法,该方法接受一个 String 类型的参数 event,并且没有返回值(返回类型为 void)。
5、if (onClick != null) {:
检查 onClick 是否不为 null。
6、onClick!(event);:
如果 onClick 不为 null,则调用 onClick 回调函数,并传递 event 参数。
onClick! 中的 ! 表示强制解包(告诉编译器 onClick 在这里肯定不是 null)。

主函数 main

void main() {
  var button = Button();

  button.onClick = (event) => print('Button clicked: $event');
  button.click('start'); // 输出: Button clicked: start
}

void main() {:

定义程序的主入口函数 main。
var button = Button();:

创建一个 Button 类的实例,并赋值给变量 button。
button.onClick = (event) => print('Button clicked: $event');:

为 button 实例的 onClick 属性赋值一个匿名函数(lambda 表达式)。
这个匿名函数接受一个 String 类型的参数 event,并将其输出到控制台。
button.click('start');:

调用 button 实例的 click 方法,并传递 start 作为参数。
click 方法会检查 onClick 是否不为 null,如果不为 null,则调用 onClick 回调函数,最终输出 Button clicked: start

6、总结

typedef 是 Dart 中强大的功能,可以简化函数类型的定义,提高代码的可读性和可维护性。通过使用 typedef,可以更轻松地管理复杂的回调函数和泛型函数类型。

主要要点:
使用 typedef 为函数类型定义别名。
通过 typedef 提高代码的可读性。
typedef 可以与泛型一起使用,定义通用的函数类型。
在回调函数和事件处理程序中使用 typedef 使代码更清晰。
通过对 typedef 的理解和实践,可以编写更简洁、可维护的 Dart 代码。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容