Flutter辅助工具插件flutter_assist的使用

概述

flutter_assist 包含了多种实用函数和类，旨在简化在使用 Flutter 开发时的一些常见任务。这些实用工具被分组到不同的类别中，例如 DateTime、Flow、Functions、LocalFile、Log、MapMarker 和 Regex。

安装

要使用此包，请将其作为依赖项添加到您的 pubspec.yaml 文件中：

dependencies:
  flutter_assist: ^1.0.0

然后运行以下命令以下载包：

flutter pub get

DateTime 工具

该类别包含一组扩展函数，用于简化与日期和时间相关的操作。

示例代码

import 'package:flutter_assist/flutter_assist.dart';

void main() {
  // 获取当前日期时间
  DateTime now = DateTime.now();
  
  // 将日期时间格式化为字符串
  String formattedDate = now.formatDate("yyyy-MM-dd");
  print(formattedDate); // 输出类似 "2023-10-05"
}

FlowUtils 工具

FlowUtils 类别包含一组静态函数，抽象了 Flutter 的 Navigator 函数。这些函数旨在使屏幕之间的导航更加简单和易读。

示例代码

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

class HomeScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text("Home")),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            // 使用 FlowUtils 进行页面跳转
            FlowUtils.push(context, NextScreen());
          },
          child: Text("Go to Next Screen"),
        ),
      ),
    );
  }
}

class NextScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text("Next Screen")),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            // 使用 FlowUtils 返回上一页
            FlowUtils.pop(context);
          },
          child: Text("Back"),
        ),
      ),
    );
  }
}

FunctionsUtil 工具

该类别包含一个函数，允许您异步执行一系列异步函数，并返回所有函数的输出列表。

示例代码

import 'package:flutter_assist/flutter_assist.dart';

Future<void> main() async {
  // 定义多个异步函数
  Future<String> fetchUserData() async {
    await Future.delayed(Duration(seconds: 1));
    return "User Data";
  }

  Future<int> fetchProductData() async {
    await Future.delayed(Duration(seconds: 1));
    return 123;
  }

  // 使用 FunctionsUtil 执行多个异步函数
  List<dynamic> results = await FunctionsUtil.executeAsync([
    fetchUserData,
    fetchProductData,
  ]);

  print(results); // 输出 ["User Data", 123]
}

LocalFileUtil 工具

LocalFileUtil 类别包含一组静态函数，允许您从用户的文件系统中选择图像和文件。

示例代码

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: FilePickerScreen(),
    );
  }
}

class FilePickerScreen extends StatefulWidget {
  @override
  _FilePickerScreenState createState() => _FilePickerScreenState();
}

class _FilePickerScreenState extends State<FilePickerScreen> {
  String _selectedFilePath = "";

  void _pickFile() async {
    // 使用 LocalFileUtil 选择文件
    String? filePath = await LocalFileUtil.pickFile();
    if (filePath != null) {
      setState(() {
        _selectedFilePath = filePath;
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text("File Picker")),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text(_selectedFilePath),
            ElevatedButton(
              onPressed: _pickFile,
              child: Text("Pick File"),
            ),
          ],
        ),
      ),
    );
  }
}

LogUtil 工具

LogUtil 类别包含一组静态函数，可以有效地将日志记录到调试控制台。

示例代码

import 'package:flutter_assist/flutter_assist.dart';

void main() {
  // 使用 LogUtil 记录日志
  LogUtil.d("Debug Message");
  LogUtil.i("Info Message");
  LogUtil.e("Error Message");
}

MapMarkerUtil 工具

MapMarkerUtil 类别包含一组静态函数，允许您将各种格式转换为 BitmapDescriptor。支持的格式包括：

• SVG 资产
• 图片资产
• 带中心文本的图片资产
• 带文本的圆形画布
• 在线图片
• 图标
• 小部件

示例代码

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MapScreen(),
    );
  }
}

class MapScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text("Map Marker Example")),
      body: Center(
        child: ElevatedButton(
          onPressed: () {
            // 使用 MapMarkerUtil 创建 BitmapDescriptor
            BitmapDescriptor marker = MapMarkerUtil.svgAsset("assets/icons/marker.svg");
            print(marker);
          },
          child: Text("Create Marker"),
        ),
      ),
    );
  }
}

RegexUtil 工具

RegexUtil 类别包含一组静态正则表达式对象，用于表单验证。

示例代码

import 'package:flutter_assist/flutter_assist.dart';

void main() {
  // 验证邮箱格式
  bool isValidEmail = RegexUtil.email.hasMatch("example@example.com");
  print(isValidEmail); // 输出 true
}