Flutter网络连接控制提醒插件internet_connection_control_alert的使用

Flutter网络连接控制提醒插件internet_connection_control_alert的使用

internet_connection_control_alert 包是一个用于监控您的 Flutter 应用程序中的互联网连接，并在连接丢失时通知用户的工具。该包会检查互联网连接状态并显示一个可自定义的警报对话框。

功能

• 互联网连接监控：实时监控应用程序的互联网连接。
• 可自定义的警报对话框：当互联网连接丢失时，允许您自定义显示的警报对话框。
• 延迟启动：可以指定时间延迟开始连接检查。
• 取消选项：配置是否允许用户取消警报对话框。
• 互联网状态可见性：通过 internet 变量检查当前的互联网连接状态。

安装

要将该包添加到您的项目中，请在 pubspec.yaml 文件中包含以下行：

dependencies:
  internet_connection_control_alert: ^1.0.0

然后在终端中运行 flutter pub get 来安装包。

导入包

在您的主 Dart 文件中导入包：

import 'package:internet_connection_control_alert/internet_connection_control_alert.dart';

初始化和配置

使用 delayStart() 方法来检查互联网连接并在启动应用程序时显示自定义的警报对话框：

void main() {
  // 延迟启动和自定义警报对话框
  Internet.delayStart(
    delay: 1000, // 延迟时间（毫秒）
    barrier: false, // 确定警报对话框是否可以被取消
    alert: AlertDialog(
      backgroundColor: Colors.white,
      shape: RoundedRectangleBorder(
        borderRadius: BorderRadius.circular(25),
      ),
      content: Container(
        height: 200,
        padding: const EdgeInsets.all(25),
        child: const Column(
          mainAxisAlignment: MainAxisAlignment.spaceEvenly,
          children: [
            Icon(Icons.wifi_off_rounded, size: 50), // 图标
            SizedBox(height: 20), // 空白区域
            Text(
              textAlign: TextAlign.center,
              style: TextStyle(color: Colors.black, fontSize: 15),
              "Internet is not available at the moment. Please check your internet connection and try again.", // 提示信息
            ),
          ],
        ),
      ),
    ),
  );

  runApp(
    MaterialApp(
      navigatorKey: navKey, // 在库中使用的导航键
      home: const Scaffold(
        body: Center(child: Text("Internet Connection Control Alert")), // 主界面文本
      ),
    ),
  );
}

方法

Internet.delayStart({required int delay, bool? barrier, AlertDialog? alert})

此方法会在指定的延迟后开始检查互联网连接。barrier 参数决定警报对话框是否可以被用户取消。alert 参数提供了一个自定义的 AlertDialog。

• delay: 延迟时间（毫秒）。
• barrier: 如果为 true，则允许警报对话框被取消；如果为 false，则不允许。
• alert: 如果没有互联网连接，则显示的 AlertDialog。

Internet.start({bool? barrier, AlertDialog? alert})

此方法开始监控互联网连接。它监听连接变化，并在互联网连接丢失或恢复时显示警报对话框。

• barrier: 如果为 true，则允许警报对话框被取消；如果为 false，则不允许。
• alert: 如果没有互联网连接，则显示的 AlertDialog。

Internet.stop()

此方法停止监控互联网连接并关闭任何已显示的警报对话框。

检查互联网状态

您可以使用 Internet.internet 变量来检查当前的互联网连接状态。如果该变量为 true，则表示互联网连接可用；如果为 false，则表示互联网连接不可用。

示例用法

void main() {
  Internet.delayStart(
    delay: 1000,
    barrier: true,
    alert: AlertDialog(
      backgroundColor: Colors.red,
      shape: RoundedRectangleBorder(
        borderRadius: BorderRadius.circular(15),
      ),
      content: Container(
        height: 150,
        padding: const EdgeInsets.all(20),
        child: const Column(
          mainAxisAlignment: MainAxisAlignment.spaceEvenly,
          children: [
            Icon(Icons.signal_wifi_off, size: 50, color: Colors.white), // 图标
            SizedBox(height: 15), // 空白区域
            Text(
              textAlign: TextAlign.center,
              style: TextStyle(color: Colors.white, fontSize: 16),
              "No internet connection. Please check your connection and try again.", // 提示信息
            ),
          ],
        ),
      ),
    ),
  );

  runApp(
    MaterialApp(
      navigatorKey: navKey,
      home: Scaffold(
        appBar: AppBar(
          title: const Text("Internet Connection Control Example"), // 应用程序标题
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () {
              if (Internet.internet) {
                print("Internet is available"); // 打印消息
              } else {
                print("Internet is not available"); // 打印消息
              }
            },
            child: const Text("Check Internet Status"), // 按钮文本
          ),
        ),
      ),
    ),
  );
}