Flutter状态打印插件gg_status_printer的使用

Flutter状态打印插件gg_status_printer的使用

描述

GgStatusPrinter 是一个 Dart 包装器，旨在增强用户在异步操作执行期间的反馈。虽然 Dart 使用 Future 而不是 Promise，但概念是相似的。此包旨在简化通知用户关于这些异步操作状态的过程。

在启动异步操作时，提供即时反馈给用户，表示操作已经开始。GgStatusPrinter 通过自动显示带有“⌛️”（小时玻璃）表情符号的临时消息来处理这一点，表明操作正在进行中。

一旦操作完成，该包会根据操作的结果更新反馈。如果操作成功，它会显示带有“✅”（检查标记）的消息，表示成功。相反，如果操作遇到错误或失败，它会显示带有“❌”（交叉标记）的消息，表示失败。

此包简化了为异步操作提供实时、友好的反馈过程，通过保持用户对后台任务状态的了解来增强整体用户体验。

特性

• 自动开始反馈：自动打印带有“⌛️”的消息以指示操作的开始。
• 成功通知：在异步操作成功完成后，打印带有“✅”的消息。
• 错误通知：在失败时，打印带有“❌”的消息。
• 自定义消息：允许自定义初始、成功和错误消息以适应不同应用程序的需求。
• 易于集成：设计用于轻松集成到现有的 Dart 项目中，配置简单。

工作原理

1. 初始化：将 GgStatusPrinter 包导入到您的 Dart 项目中。
2. 包裹异步操作：使用 GgStatusPrinter 包裹任何异步操作，提供描述操作的消息。
3. 自动通知：包自动处理根据操作状态打印适当消息的操作，无需手动干预。

示例用法

import 'package:gg_status_printer/gg_status_printer.dart';

void main() async {
  print('\nPrint all states one the same line');
  // ⌛️✅ Loading data
  await const GgStatusPrinter<void>(
    message: 'Loading data',
    useCarriageReturn: true,
  ).run(() => Future<void>.delayed(const Duration(seconds: 1)));

  print('\nPrint all states on different lines');
  // ⌛️ Loading data
  // ✅ Loading data
  await const GgStatusPrinter<void>(
    message: 'Loading data',
    useCarriageReturn: false,
  ).run(() => Future<void>.delayed(const Duration(seconds: 1)));

  print('\nPrint fail states');
  // ⌛️ Loading data
  // ❌ Loading data

  try {
    await const GgStatusPrinter<void>(
      message: 'Loading data',
      useCarriageReturn: false,
    ).run(
      () => Future<void>.delayed(const Duration(seconds: 1))
          .then((_) => throw Exception('Failed')),
    );
  } catch (_) {}
}

示例代码

#!/usr/bin/env dart
// [@license](/user/license)
// Copyright (c) 2019 - 2024 Dr. Gabriel Gatzsche. All Rights Reserved.
//
// Use of this source code is governed by terms that can be
// found in the LICENSE file in the root of this package.

import 'package:gg_status_printer/gg_status_printer.dart';

void main() async {
  print('\nPrint all states one the same line');
  // ⌛️✅ Loading data
  await GgStatusPrinter<void>(
    message: 'Loading data',
    useCarriageReturn: true,
  ).run(() => Future<void>.delayed(const Duration(seconds: 1)));

  print('\nPrint all states on different lines');
  // ⌛️ Loading data
  // ✅ Loading data
  await GgStatusPrinter<void>(
    message: 'Loading data',
    useCarriageReturn: false,
  ).run(() => Future<void>.delayed(const Duration(seconds: ));

  print('\nPrint fail states');
  // ⌛️ Loading data
  // ❌ Loading data

  try {
    await GgStatusPrinter<void>(
      message: 'Loading data',
      useCarriageReturn: false,
    ).run(
      () => Future<void>.delayed(const Duration(seconds: ))
          .then((_) => throw Exception('Failed')),
    );
  } catch (_) {}
}