Dart中的扩展方法

最新推荐文章于 2024-03-30 05:34:00 发布

阳光明媚123

最新推荐文章于 2024-03-30 05:34:00 发布

阅读量1.8k

点赞数 1

分类专栏： Flutter专项文章标签：开发语言 flutter

本文链接：https://blog.csdn.net/weixin_43836055/article/details/126073256

版权

Flutter专项专栏收录该内容

2 篇文章 0 订阅

订阅专栏

本文介绍了Dart 2.7中新增的扩展方法，如何不修改类结构为API添加新功能，以及使用时的注意事项，包括类型推断、dynamic限制、API冲突解决策略和扩展原则的遵循。通过实例演示了如何简化代码和提升开发效率。

摘要由CSDN通过智能技术生成

扩展方法是什么

Dart 2.7版本新增了扩展方法的功能

旨在不修改类、不继承类的情况下，向一个类添加新的函数。扩展使我们可以合理地遵循开闭原则（对扩展开放，而对修改是封闭的）。
比如：当使用其他人编写的API或者开源库的时候，我们很难去改变这些API，但是又想添加我们自己想要的功能，这个时候我们可以考虑使用extension来扩展API。

扩展方法如何使用

声明：

 extension <extension name> on <type> {
     (<member definition>)*
 }

extension：扩展函数使用关键字。
extension name：是扩展函数的名称。
on ：关键字后接需要扩展的类型。
大括号：内部是扩展的方法。

使用1: 比如，我们希望将一个整数字符串转换为 int 类型整数，但是 String 类型并没有 toInt 方法，这时扩展函数就有了用武之地，我们给 String 扩展一个 toInt 方法。

extension StringExtension on String {
  int toInt() {
    return int.parse(this);
  }
}

调用时可以这么写：

'10'.toInt();

当然，不使用扩展函数也可以实现，在不使用扩展的情况我们会这样写：

int.parse('10');

但是这种写法没有扩展后的写法美观、使用方便。

使用2： 给定一个时间，需要判断该时间是否是今天。

extension DateTimeExtension on DateTime {
  bool isSameDay(DateTime date) {
    final dateFormat = DateFormat("yyyy-MM-dd");
    final date1 = dateFormat.format(this);
    final date2 = dateFormat.format(date);
    return date1 == date2;
  }
}

调用：

DateTime.now().isSameDay(DateTime.parse("2022-07-01 18:09"));

使用3： 对Widget类进行扩展，比如: 我们可以扩展写ui时用的比较多的设置边距的padding方法及点击事件。

extension WidgetExt on Widget {
  Widget padding(EdgeInsetsGeometry padding) {
    return Padding(
      child: this,
      padding: padding,
    );
  }
  
  Material gesture({
    GestureTapCallback? onTap, //点击
    GestureTapCallback? onDoubleTap, //双击
    GestureLongPressCallback? onLongPress, //长按
  }) {
    return InkWell(
        child: this,
        onTap: onTap,
        onDoubleTap: onDoubleTap,
        onLongPress: onLongPress,
    );
  }
}

给一个文本设置边距及点击事件可以这么写

Center(
  child: Text(
    'You have pushed the button this many times:$_counter',
  ).padding(EdgeInsets.all(10)).gesture(onTap: _incrementCounter),
)

再来和实现同样功能不使用扩展的写法对比一下

Center(
  child: InkWell(
    onTap: _incrementCounter,
    child: Padding(
      padding: EdgeInsets.all(10),
      child: Text(
        'You have pushed the button this many times:$_counter',
      ),
    ),
  ),
)

可以看出使用扩展可以简化代码，减少嵌套。
当然，扩展不仅可以定义方法，还可以定义其他成员，例如getter，setter和operator。

使用时的注意事项

拓展方法可用于推断类型
```
var a = '10';
print(a.toInt()); //Output: 10
```
因为变量a通过推断可以得到a的类型是String，只要该类型可以被推断出来，那么就可以使用extention扩展。

拓展方法不能用于dynamic

dynamic a = '10';
print(a.toInt());

运行时会报错

======== Exception caught by widgets library =======================================================
The following NoSuchMethodError was thrown building MyHomePage(dirty, state: _MyHomePageState#de9bf):
Class 'String' has no instance method 'toInt'.
Receiver: "10"
Tried calling: toInt()

这是因为扩展方法针对静态类型进行了解析. 声明dynamic，无法在静态解析时确定其真正的类型。

API冲突

假设现在有2个扩展函数，分别在 string_ext1.dart 和 string_ext2.dart 文件中
string_ext1.dart代码：

//string_ext1.dart
extension StringExt on String {
  int toInt() {
    return int.parse(this);
  }
}

string_ext2.dart代码：

//string_ext2.dart
extension StringExt2 on String {
 int toInt() {
   return int.parse(this);
 }

 double toDouble() {
   return double.parse(this);
 }
}

如果在同一个文件里引入了这两个2个扩展函数并使用 toInt 方法：

//test.dart
import 'package:flutter_log/common/string_ext1.dart';
import 'package:flutter_log/common/string_ext2.dart';
print('10'.toInt());

此时编译器会报错

这是因为所引入的2个扩展函数中都有 toInt 方法。

解决方案1： 使用 hide 和 show 来限制

//test.dart
import 'package:flutter_log/common/string_ext1.dart';
import 'package:flutter_log/common/string_ext2.dart' hide StringExt2; 

print('10'.toInt());

这种方式会导致StringExt2中的其他方法无法使用

解决方案2： 显式指定使用哪一个扩展函数

import 'package:flutter_log/common/string_ext1.dart';
import 'package:flutter_log/common/string_ext2.dart';
print(StringExt('10').toInt());
print(StringExt2('10').toInt());

这适合扩展名不一样的情况，如果两个扩展名都相同，比如string_ext1.dart和string_ext3.dart中都有StringExt

//string_ext3.dart
extension StringExt on String {
  int toInt() {
    return int.parse(this);
  }

  double toDouble() {
    return double.parse(this);
  }
}

那么编译器会报错

解决方案3： 用as 给扩展文件指定别名

import 'package:flutter_log/common/string_ext1.dart';
import 'package:flutter_log/common/string_ext3.dart' as parse;

print(StringExt('10').toInt());
print(parse.StringExt('10').toInt());
//在导入的文件中，如果函数是唯一的,那么不需要“xxx”去调用“StringExt”扩展类，直接调用扩展函数即可。
print('10'.toDouble());

小结：两个文件名称不同，但是扩展名一样，都是“StringExt”，而且有相同的扩展函数“toInt”,那么可以使用别名“as xxx”,然后用“xxx”去调用“StringExt”扩展类，再去调用里面的扩展函数。但是在导入的文件中，如果函数是唯一的，那么不需要“xxx”去调用“StringExt”扩展类，直接调用扩展函数即可。上例中的'10'.toDouble()这个“toDouble”就是“string_ext3.dart”里面的唯一的函数, 所以不加别名调用也是可以的。