Flutter功能扩展插件ultimate_extension的使用

ultimate_extension是一个为Dart集合和对象提供强大且易于使用的扩展的插件。该包扩展了List、Iterable、Map和Object，提供了诸如随机选择、复制、分区、JSON处理等实用工具。

目录

• 开始使用
• 常用扩展方法
  • 防抖与节流
  • 对象扩展
  • 字符串扩展
  • 颜色扩展
  • 可迭代对象扩展
  • 映射扩展
  • 数值扩展
  • 其他扩展

开始使用

首先，在pubspec.yaml文件中添加ultimate_extension作为依赖项：

dependencies:
  flutter:
    sdk: flutter
  ultimate_extension: ^[version]

然后导入包：

import 'package:ultimate_extension/ultimate_extension.dart';

常用扩展方法

防抖与节流

防抖（Debounce）

防抖确保如果在短时间内多次调用一个方法，则只执行最后一次调用。每次调用都会重置计时器，只有在计时器完成且没有中断的情况下才会调用目标方法。

UltimateExtension().debounce(
  id: "Debounce",
  delay: Duration(seconds: 1),
  action: () => yourMethod(),
);

节流（Throttle）

节流确保在指定的时间段内最多调用一次方法。它通过允许第一个调用来执行并忽略期间内的后续调用来防止多次调用。

UltimateExtension().throttle(
  id: "Throttle",
  delay: Duration(seconds: 1),
  action: () => yourMethod(),
);

对象扩展

tryConvertTo

用于将接收到的类型转换为目标数据类型，即使接收的类型不同。当前仅支持内置数据类型。

double data = "12344.5".tryConvertTo<double>();

字符串扩展

amISame

检查当前字符串是否与另一个字符串相同，忽略大小写和前导/尾随空格。

bool isSame = "test".amISame(to: "TeST"); // true

displayIfNull

为null字符串提供默认值。

String display = null.displayIfNull(displayString: "N/A"); // N/A

颜色扩展

ColorHelper.fromHex

从十六进制代码获取颜色。

Color backgroundColor = ColorHelper.fromHex("#aabbcc");

可迭代对象扩展

getFirstElementWithIndex

获取元素及其索引。

List<int> numbers = [1, 2, 3];
IndexValue<int>? result = numbers.getFirstElementWithIndex((element) => element > 1);
print(result?.itemIndex); // 1
print(result?.data); // 2

映射扩展

prettyPrint

将映射转换为格式化的JSON字符串。

Map<String, dynamic> data = {
  "name": "John",
  "email": "john@example.com",
};

print(data.prettyPrint());
//{
//  "name": "John",
//  "email": "john@example.com"
//}

示例Demo

以下是一个完整的示例项目，演示如何使用ultimate_extension插件中的部分功能：

import 'package:flutter/material.dart';
import 'package:ultimate_extension/ultimate_extension.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  Color backgroundColor = ColorHelper.fromHex("#aabbcc");
  String hexcode = Colors.red.toHex();

  void _incrementCounter() async {
    for (int i = 0; i < 1000; i++) {
      UltimateExtension().throttle(
        id: "Testing",
        delay: Duration(seconds: 1),
        action: () => yourMethod(),
      );
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }

  void yourMethod() {
    print("Method called");
  }
}