Flutter功能扩展插件extender_dart的使用

Flutter功能扩展插件extender_dart的使用

Extender Dart 是一个为Dart开发者设计的实用库。它提供了一系列常用的操作和别名，包括对Lists和Maps进行不可变添加、删除、更新和插入操作的扩展。旨在简化日常任务，防止意外的就地修改。

功能

• 常用操作：轻松执行常用操作。
• 别名集合：通过直观的别名简化开发过程，包括时间别名用于int和字符串类型转换检查。
• 列表扩展：通过不可变操作扩展你的列表，防止意外的就地修改。
• 映射扩展：在映射上执行不可变操作，防止无意的就地更改。
• 排序操作：轻松按各种顺序对集合进行排序，包括按属性排序，并处理空值。

安装

dependencies:
  extender_dart: latest_version

dev_dependencies:
  extender_dart_builder: latest_version

然后运行：

pub get

使用

别名

整数别名

这些别名允许你使用整数作为持续时间，非常简单。

import 'package:extender_dart/extender_dart.dart';

var fiveMinutes = 5.minutes;  // 相当于Duration(minutes: 5)
var twoHours = 2.h;  // 相当于Duration(hours: 2)

字符串别名

这些字符串别名使得类型转换和验证变得轻而易举。

import 'package:extender_dart/extender_dart.dart';

var integerValue = "123".toIntOrNull();  // 如果有效，将字符串转换为整数
bool isItDouble = "12.34".isDouble;  // 检查字符串是否为有效的双精度表示

var dateTimeValue = "2023-10-12T14:30:00Z".toDateTimeOrNull();  // 如果有效，将字符串转换为DateTime

列表扩展

import 'package:extender_dart/extender_dart.dart';

var myList = [1, 2, 3];

// 不可变地添加元素
var extendedList = myList.addWith(4);  // [1, 2, 3, 4]

// 不可变地删除元素
var reducedList = myList.removeWith(2);  // [1, 3]

// 不可变地在特定索引处插入元素
var insertedList = myList.insertWith(1, 10);  // [1, 10, 2, 3]

// 不可变地删除特定索引处的元素
var removedList = myList.removeAtWith(0);  // [2, 3]

List<Person> people = [
  Person(1, 'Alice'),
  Person(2, 'Bob'),
  Person(1, 'Alice'),
  Person(3, 'Charlie'),
];

// 获取基于ID的唯一人员列表：
var uniqueById = people.uniqueBy((p) => p.id);
print(uniqueById); // 将打印基于ID的唯一人员列表。

// 获取基于名称的唯一人员列表：
var uniqueByName = people.uniqueBy((p) => p.name);
print(uniqueByName); // 将打印基于名称的唯一人员列表。

映射扩展

import 'package:extender_dart/extender_dart.dart';

var myMap = {'a': 1, 'b': 2};

// 不可变地添加键值对
var extendedMap = myMap.addWith('c', 3);  // {'a': 1, 'b': 2, 'c': 3}

// 不可变地添加MapEntry
var extendedWithEntryMap = myMap.addEntryWith(MapEntry('d', 4));  // {'a': 1, 'b': 2, 'd': 4}

// 不可变地删除键值对
var reducedMap = myMap.removeWith('a');  // {'b': 2}

// 不可变地更新键对应的值
var updatedMap = myMap.updateWith('b', (value) => value * 2);  // {'a': 1, 'b': 4}

排序操作

Extender Dart 提供了易于使用的排序工具，使你可以轻松地以不同的顺序对列表进行排序。

升序和降序

你可以轻松地以升序或降序对列表进行排序。

import 'package:extender_dart/extender_dart.dart';

List<int> numbers = [1, 3, 5, 4, 2];
numbers.sort(SortOrder.asc);  // [1, 2, 3, 4, 5]
numbers.sort(SortOrder.desc); // [5, 4, 3, 2, 1]

属性排序

对于更复杂的类型如Maps，你可以选择一个属性进行排序。

import 'package:extender_dart/extender_dart.dart';

List<Map<String, int>> persons = [
  {"age": 20},
  {"age": 30},
  {"age": 10},
];
persons.sort(SortOrder.pick<Map>((e) => e["age"]).asc);  // [{"age": 10}, {"age": 20}, {"age": 30}]

处理空值

该库还提供了用于处理包含空值的列表的排序工具。

import 'package:extender_dart/extender_dart.dart';

List<int?> numbersWithNulls = [1, 3, null, null, 2];
numbersWithNulls.sort(SortOrder.nullsFirst); // [null, null, 1, 2, 3]
numbersWithNulls.sort(SortOrder.nullsLast);  // [1, 2, 3, null, null]

控制台显示

ConsoleText 是一个用于调试会话期间在控制台上显示彩色文本的工具。以下是其提供的功能及相应的示例代码。

ConsoleText 类可以通过调用styled方法创建，它是String类型的扩展。

彩色文本

你可以应用各种颜色到文本及其背景上。

print("Success".styled.green);  // 绿色文本
print("Warning".styled.bgRed.white); // 白色文本，红色背景

文本样式

你可以调整文本的权重和样式，包括加粗、斜体和下划线等选项。

print("Bold Text".styled.bold);  // 加粗
print("Italic Text".styled.italic);  // 斜体
print("Underlined Text".styled.underline);  // 下划线

文本边框

你可以通过给文本添加边框来强调文本。

print("Bordered Text".styled.bordered());  // 带边框
print("Thick Border".styled.bordered(style: BorderStyle.thick()));  // 带粗边框
print("Dotted Border".styled.bordered(style: BorderStyle.dotted()));  // 带虚线边框

格式化JSON显示

你可以格式化并显示JSON数据。

var user = {
  'name': 'Alice',
  'age': 28,
  'address': {'city': 'Tokyo', 'zip': '100-0001'}
};
print(
  "json".styled.bordered(style: BorderStyle.box(enableBottomBorder: false)),
);
print(user.styled.blue.bordered()); // 蓝色边框的JSON显示

使用此工具，你可以以清晰且易懂的方式显示调试信息。它在同时调试多个信息时特别有用，或者当你需要突出特定细节时。

自动为类字段生成枚举

该包提供了一种强大的代码生成功能，可以自动生成与数据类字段相对应的枚举类。只需使用[@fieldEnum](/user/fieldEnum)或[@freezedFieldEnum](/user/freezedFieldEnum)注解你的数据类，就可以生成一个枚举，这在类型安全地引用字段时非常有用，例如在表单、序列化或数据库查询时。

使用方法

要使用此功能，请遵循以下步骤：

1. 使用[@fieldEnum](/user/fieldEnum)注解你的类，以触发生成一个枚举类，列出所有字段。

   例子：

   // [@fieldEnum](/user/fieldEnum) 注解并生成 UserField 枚举
   [@fieldEnum](/user/fieldEnum)
   class User {
     String name;
     int age;
     String? email;
     String? phone;
   
     User({
       required this.name,
       required this.age,
       this.email,
       this.phone,
     });
   }
   // 这将生成：
   // enum UserField { name, age, email, phone }
   

2. 对于Freezed类，使用[@freezedFieldEnum](/user/freezedFieldEnum)与[@freezed](/user/freezed)注解一起实现相同的功能。

   例子：

   // [@freezedFieldEnum](/user/freezedFieldEnum) 注解并生成 FreezedUserField 枚举
   [@freezed](/user/freezed)
   [@freezedFieldEnum](/user/freezedFieldEnum)
   class FreezedUser with _$FreezedUser {
     const FreezedUser._();
     const factory FreezedUser({
       required String name,
       required int age,
       required String? email,
       required String? phone,
     }) = _FreezedUser;
   }
   // 这将生成：
   // enum FreezedUserField { name, age, email, phone }