Flutter未知功能插件aqua的探索使用

Flutter未知功能插件aqua的探索使用

1. 插件简介

aqua 是一个用于简化Flutter UI开发的工具类和函数集合。它提供了许多实用的功能，如日志记录、数据存储、API交互、UI组件等，帮助开发者更高效地构建应用程序。

2. 使用示例

为了更好地理解 aqua 插件的功能，下面是一个完整的示例demo，展示了如何在Flutter项目中使用 aqua 的各种功能。

3. 完整示例Demo

import 'package:flutter/material.dart';
import 'package:aqua/aqua.dart' as aqua;

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Aqua Usage Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: AquaUsage(),
    );
  }
}

class AquaUsage extends StatefulWidget {
  @override
  AquaUsageState createState() => AquaUsageState();
}

class AquaUsageState extends State<AquaUsage> {
  final TextEditingController _textEditingController = TextEditingController();
  final FocusNode _focusNode = FocusNode();
  String _logContent = '';
  String _savedData = '';
  String _timeAgo = '';
  String _randomNumber = '';
  String _capitalizedWord = '';
  String _obscuredText = '';
  String _formattedNumber = '';
  String _uuid = '';
  int _currentStep = 0;

  @override
  void dispose() {
    _textEditingController.dispose();
    _focusNode.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    // 初始化屏幕尺寸
    aqua.Dimensions().init(context);

    return Scaffold(
      appBar: AppBar(
        title: Text('Aqua Usage Demo'),
      ),
      body: ListView(
        padding: EdgeInsets.all(16),
        children: [
          // 日志记录
          ElevatedButton(
            onPressed: () async {
              await aqua.log('This is a log message', 'path/to/log.txt', clear: true, time: true);
              setState(() {
                _logContent = 'Log written to file';
              });
            },
            child: Text('Write Log to File'),
          ),
          SizedBox(height: 10),
          Text(_logContent),

          // 数据存储
          ElevatedButton(
            onPressed: () async {
              var id = 'test_id';
              var value = 1920;
              await aqua.Pref.set(id, value);
              var savedValue = await aqua.Pref.get(id);
              setState(() {
                _savedData = 'Saved value: $savedValue';
              });
            },
            child: Text('Save and Retrieve Data'),
          ),
          SizedBox(height: 10),
          Text(_savedData),

          // 时间显示
          ElevatedButton(
            onPressed: () {
              var now = DateTime.now().millisecondsSinceEpoch ~/ 1000;
              var time = aqua.readTimestamp(now);
              setState(() {
                _timeAgo = 'Time ago: $time';
              });
            },
            child: Text('Show Time Ago'),
          ),
          SizedBox(height: 10),
          Text(_timeAgo),

          // 随机数生成
          ElevatedButton(
            onPressed: () {
              var random = aqua.getRandomNumber(min: 10, max: 10000);
              setState(() {
                _randomNumber = 'Random number: $random';
              });
            },
            child: Text('Generate Random Number'),
          ),
          SizedBox(height: 10),
          Text(_randomNumber),

          // 首字母大写
          ElevatedButton(
            onPressed: () {
              var word = 'hello world';
              var capitalized = aqua.capitalize(word);
              setState(() {
                _capitalizedWord = 'Capitalized: $capitalized';
              });
            },
            child: Text('Capitalize Word'),
          ),
          SizedBox(height: 10),
          Text(_capitalizedWord),

          // 隐藏文本
          ElevatedButton(
            onPressed: () {
              var text = 'hidden text';
              var obscured = aqua.obscureText(text);
              setState(() {
                _obscuredText = 'Obscured: $obscured';
              });
            },
            child: Text('Obscure Text'),
          ),
          SizedBox(height: 10),
          Text(_obscuredText),

          // 格式化数字
          ElevatedButton(
            onPressed: () {
              var number = '1000000';
              var formatted = aqua.pretifyNumber(number);
              setState(() {
                _formattedNumber = 'Formatted number: $formatted';
              });
            },
            child: Text('Format Number'),
          ),
          SizedBox(height: 10),
          Text(_formattedNumber),

          // 生成UUID
          ElevatedButton(
            onPressed: () {
              var uuid = aqua.generateUUID(length: 30);
              setState(() {
                _uuid = 'Generated UUID: $uuid';
              });
            },
            child: Text('Generate UUID'),
          ),
          SizedBox(height: 10),
          Text(_uuid),

          // Stepped Progress
          Slider(
            value: _currentStep.toDouble(),
            min: 0,
            max: 2,
            divisions: 2,
            onChanged: (value) {
              setState(() {
                _currentStep = value.toInt();
              });
            },
          ),
          aqua.SteppedProgress(
            steps: ['Step 1', 'Step 2', 'Step 3'],
            thickness: 1.5,
            dashWidth: 5,
            currentStep: _currentStep,
          ),
        ],
      ),
    );
  }
}

4. 功能说明

1. 日志记录：

   • 使用 aqua.log 方法将日志内容写入文件，并可以选择是否清空文件以及是否添加时间戳。

   await aqua.log('This is a log message', 'path/to/log.txt', clear: true, time: true);
   

2. 数据存储：

   • 使用 aqua.Pref.set 和 aqua.Pref.get 方法可以轻松地将数据保存到设备并读取。

   await aqua.Pref.set(id, value);
   var savedValue = await aqua.Pref.get(id);
   

3. 时间显示：

   • 使用 aqua.readTimestamp 方法可以将时间戳转换为“几分钟前”、“几小时前”等格式。

   var time = aqua.readTimestamp(now);
   

4. 随机数生成：

   • 使用 aqua.getRandomNumber 方法可以在指定范围内生成随机数。

   var random = aqua.getRandomNumber(min: 10, max: 10000);
   

5. 首字母大写：

   • 使用 aqua.capitalize 方法可以将字符串的首字母大写。

   var capitalized = aqua.capitalize(word);
   

6. 隐藏文本：

   • 使用 aqua.obscureText 方法可以将文本替换为星号或其他字符。

   var obscured = aqua.obscureText(text);
   

7. 格式化数字：

   • 使用 aqua.pretifyNumber 方法可以在数字中添加逗号分隔符。

   var formatted = aqua.pretifyNumber(number);
   

8. 生成UUID：

   • 使用 aqua.generateUUID 方法可以生成指定长度的唯一标识符。

   var uuid = aqua.generateUUID(length: 30);
   

9. Stepped Progress：

   • 使用 aqua.SteppedProgress 组件可以创建一个逐步进度条，适用于多步骤流程。

   aqua.SteppedProgress(
     steps: ['Step 1', 'Step 2', 'Step 3'],
     thickness: 1.5,
     dashWidth: 5,
     currentStep: _currentStep,
   );