Flutter可重用工具插件reusable_tools的使用

Flutter可重用工具插件reusable_tools的使用

在Flutter开发中，reusable_tools 是一个非常实用的插件，它提供了许多有用的工具类和扩展方法，可以简化日常开发工作。本文将详细介绍如何使用 reusable_tools 插件。

1. 安装 reusable_tools

首先，在你的 pubspec.yaml 文件中添加 reusable_tools 依赖：

dependencies:
  reusable_tools: ^x.x.x

然后运行 flutter pub get 命令来安装该插件。

2. 导入必要的模块

根据你的需求，你可以导入具体的工具类或扩展方法。例如，如果你只需要使用 SecurityTools 类，你可以这样导入：

import 'package:reusable_tools/reusable_tools.dart' show SecurityTools;

3. 使用 reusable_tools 中的工具

3.1. 扩展 dart:core 模块的方法

reusable_tools 提供了许多扩展方法，这些方法可以增强 dart:core 模块中的基本类型（如 Map, List, String, double, int）的功能。

Map 扩展

Map 类型有一个扩展方法 toJsonString，可以将其转换为 JSON 字符串：

void main() {
  final map = {'name': 'John', 'age': 30};
  print(map.toJsonString()); // 输出 {"name":"John","age":30}
}

List 扩展

List 类型有许多有用的扩展方法，比如 toJsonString, joinPath, joinComma, joinDot, 和 joinSpace 方法：

void main() {
  final list = ['apple', 'banana', 'cherry'];
  
  // 转换为 JSON 字符串
  print(list.toJsonString()); // 输出 ["apple", "banana", "cherry"]
  
  // 使用平台分隔符连接
  print(list.joinPath()); // 输出 "apple\cherry" (Windows) 或 "apple/cherry" (Unix)
  
  // 使用逗号连接
  print(list.joinComma()); // 输出 "apple,banana,cherry"
  
  // 使用点连接
  print(list.joinDot()); // 输出 "apple.banana.cherry"
  
  // 使用空格连接
  print(list.joinSpace()); // 输出 "apple banana cherry"
}

String 扩展

String 类型有一个扩展方法 toJsonObject，可以将其转换为 JSON 对象：

void main() {
  final jsonString = '{"name": "John", "age": 30}';
  print(jsonString.toJsonObject()); // 输出 {"name": "John", "age": 30}
}

double 扩展

double 类型有两个扩展方法，toIntIfTrue 和 toPrecision：

void main() {
  final number = 3.14;
  
  // 如果数字是整数，则返回整数部分
  print(number.toIntIfTrue()); // 输出 3
  
  // 返回指定精度的小数
  print(number.toPrecision(1)); // 输出 3.1
}

int 扩展

int 类型有两个扩展方法，bytesToBinaryPrefix 和 bytesToSIUnit，用于将字节数转换为人类可读的形式：

void main() {
  final bytes = 1024 * 1024 * 1024;
  
  // 转换为二进制前缀形式
  print(bytes.bytesToBinaryPrefix()); // 输出 "1.00 GiB"
  
  // 转换为 SI 单位形式
  print(bytes.bytesToSIUnit()); // 输出 "1.07 GB"
}

3.2. 扩展 dart:io 模块的方法

reusable_tools 还提供了对 dart:io 模块的扩展方法，包括文件和目录相关的操作。

File 扩展

File 类型有以下扩展方法：toSha256, toSha1, toMd5, 和 toBase64，用于计算文件的哈希值和编码：

import 'dart:io';
import 'package:reusable_tools/reusable_tools.dart';

void main() async {
  final file = File('path/to/file.txt');
  
  // 计算文件的 SHA256 哈希值
  print(await file.toSha256());
  
  // 计算文件的 SHA1 哈希值
  print(await file.toSha1());
  
  // 计算文件的 MD5 哈希值
  print(await file.toMd5());
  
  // 将文件内容编码为 Base64 字符串
  print(await file.toBase64());
}

Directory 扩展

Directory 类型有一个扩展方法 doCheck，用于检查并创建目录：

import 'dart:io';
import 'package:reusable_tools/reusable_tools.dart';

void main() async {
  final directory = Directory('path/to/directory');
  
  // 检查并创建目录
  await directory.doCheck();
  
  // 现在目录应该存在
  if (await directory.exists()) {
    print('Directory exists!');
  } else {
    print('Directory does not exist.');
  }
}

3.3. 使用 SecurityTools 工具类

SecurityTools 类提供了多种安全相关的工具方法，如生成密码、生成 UUID 等：

import 'package:reusable_tools/reusable_tools.dart';

void main() {
  // 检查密码强度
  print(SecurityTools.checkPasswordStrength('password123')); // 输出密码强度的分数
  
  // 生成英文单词组成的口令
  print(SecurityTools.generatePassphrase()); // 输出类似 "apple banana cherry" 的口令
  
  // 生成随机密码
  print(SecurityTools.generatePassword()); // 输出类似 "aB3#dE5@fG" 的密码
  
  // 获取 UUID V5
  print(SecurityTools.getUuidV5('namespace', 'name')); // 输出 UUID V5
  
  // 获取 UUID V4
  print(SecurityTools.getUuidV4); // 输出 UUID V4
  
  // 获取 UUID V1
  print(SecurityTools.getUuidV1); // 输出 UUID V1
}

3.4. 使用 NetworkTools 工具类

NetworkTools 类提供了网络请求相关的工具方法，如配置日志记录器和获取网络客户端：

import 'package:reusable_tools/reusable_tools.dart';

void main() {
  // 设置网络客户端的日志配置
  NetworkTools.logConfig = _LogConfig();
  
  // 获取网络客户端实例
  final client = NetworkTools.client;
}