Flutter网络时间同步插件sync_time_ntp_totalxsoftware的使用

Totalx Software

概述

sync_time_ntp_totalxsoftware 是一个用于检查和同步设备时间与NTP（网络时间协议）服务器时间的Flutter包。该包确保设备时间在可配置的容差范围内准确，并在检测到差异时提供用户友好的对话框提示进行校正。

特性

• 从NTP服务器获取准确的时间。
• 使用可配置的容差验证设备时间与NTP时间。
• 显示关于时间问题的对话框并引导用户进入日期/时间设置。
• 支持Android和iOS平台的设置导航。

安装

在项目的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  sync_time_ntp_totalxsoftware: ^0.0.3

运行以下命令：

flutter pub get

使用

1. 验证设备时间

检查设备时间是否与NTP服务器同步：

import 'package:sync_time_ntp_totalxsoftware/sync_time_ntp_totalxsoftware.dart';

void validateTime() async {
  bool isTimeSynced = await NtpTimeSyncChecker.validateDeviceTime(
      toleranceInSeconds: 5,
    );

  if (isTimeSynced) {
    print("Device time is synchronized.");
  } else {
    print("Device time is NOT synchronized.");
  }
}

2. 获取NTP网络时间

从NTP服务器获取当前准确的时间：

import 'package:sync_time_ntp_totalxsoftware/sync_time_ntp_totalxsoftware.dart';

void fetchNTPTime() async {
  DateTime? networkTime = await NtpTimeSyncChecker.getNetworkTime();

  if (networkTime != null) {
    print("Network Time: $networkTime");
  } else {
    print("Failed to fetch NTP time.");
  }
}

3. 显示时间同步问题对话框

当设备时间未同步时显示对话框，提示用户进行校正：

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

// Show a dialog if time is not synchronized
NtpTimeSyncChecker.showTimeSyncIssueDialog(
  context: context,
  onRetry: () {
    Navigator.pop(context);
    _validateTime();
  },
);

4. 完整示例

以下是一个完整的示例，展示如何使用该包：

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

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'NTP Time Sync Example',
      home: const HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  _HomePageState createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  String _status = "Not Checked";
  String _networkTime = "-";

  Future<void> _validateTime() async {
    bool isSynced = await NtpTimeSyncChecker.validateDeviceTime(
      toleranceInSeconds: 5,
    );
    setState(() {
      _status = isSynced ? "Time is synchronized" : "Time is NOT synchronized!";
    });

    if (!isSynced) {
      NtpTimeSyncChecker.showTimeIssueDialog(
        context: context,
        onRetry: _validateTime,
      );
    }
  }

  Future<void> _fetchNetworkTime() async {
    DateTime? time = await NtpTimeSyncChecker.getNetworkTime();
    setState(() {
      _networkTime = time?.toString() ?? "Failed to fetch time";
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('NTP Time Sync Example')),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text('Network Time: $_networkTime'),
            ElevatedButton(
              onPressed: _fetchNetworkTime,
              child: const Text('Fetch NTP Time'),
            ),
            const SizedBox(height: 20),
            Text('Status: $_status'),
            ElevatedButton(
              onPressed: _validateTime,
              child: const Text('Validate Device Time'),
            ),
          ],
        ),
      ),
    );
  }
}

API 参考

validateTime({int toleranceInSeconds = 5}) → Future<bool>

• 描述: 验证设备时间是否在指定的容差内与NTP服务器一致。
• 参数:
  • toleranceInSeconds: 可接受的时间差异秒数（默认：5秒）。
• 返回值: 如果同步则返回 true，否则返回 false。

getNetworkTime() → Future<DateTime?>

• 描述: 从NTP服务器获取当前准确的时间。
• 返回值: 包含网络时间的 DateTime 对象或失败时为 null。

showTimeIssueDialog({required BuildContext context, required void Function() onRetry})

• 描述: 显示提示用户修复时间同步问题的对话框。
• 参数:
  • context: 显示对话框的小部件上下文。
  • onRetry: 重试时间验证的回调函数。

支持的平台

• Android: 打开日期/时间设置。
• iOS: 打开日期/时间设置。

探索更多关于 TotalX - 您信赖的软件开发公司！