Flutter前置条件验证插件 preconditions 的使用

preconditions 是一个用于管理Flutter应用程序中前置条件的插件。它可以帮助你检查应用的各种前提条件是否满足，例如用户是否授予了必要的权限、设备是否在线、是否有足够的磁盘空间等。

特性

• 实现简单的返回 Future 的前置条件函数
• 定义前置条件之间的依赖关系（仅在另一个前置条件成功时运行当前前置条件）
• 声明式缓存正面和负面结果
• 设置前置条件检查的超时时间
• 使用你喜欢的状态管理工具并响应后续变化（设备离线、用户移除之前授予的权限等）

示例Demo

以下是一个完整的示例，展示了如何使用 preconditions 插件来检查和管理应用的前置条件。

1. 实现前置条件函数

首先，我们需要实现一些前置条件函数：

import 'package:preconditions/preconditions.dart';

// 检查权限是否已授予
FutureOr<PreconditionStatus> arePermissionsGranted() async {
  // 这里应该调用实际的权限检查逻辑
  return PreconditionStatus.satisfied();
}

// 检查设备是否在线
FutureOr<PreconditionStatus> isDeviceOnline() async {
  // 使用 connectivity 插件检查网络连接
  var connectivityResult = await (Connectivity().checkConnectivity());
  if (connectivityResult == ConnectivityResult.mobile || connectivityResult == ConnectivityResult.wifi) {
    return PreconditionStatus.satisfied();
  }
  return PreconditionStatus.failed("Device is not online");
}

// 检查订阅是否有效
FutureOr<PreconditionStatus> isSubscriptionValid() async {
  // 这里应该调用实际的订阅检查逻辑
  return PreconditionStatus.satisfied();
}

// 检查服务器是否运行
FutureOr<PreconditionStatus> isMyServerRunning() async {
  try {
    var response = await http.get(Uri.parse('https://yourserver.com/status'));
    if (response.statusCode == 200) {
      return PreconditionStatus.satisfied();
    } else {
      return PreconditionStatus.failed("Server is down");
    }
  } catch (e) {
    return PreconditionStatus.failed(e.toString());
  }
}

2. 创建仓库并注册前置条件

接下来，我们创建一个 PreconditionsRepository 实例，并将这些前置条件函数注册到仓库中：

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

void main() async {
  // 创建仓库实例
  var repository = PreconditionsRepository();

  // 注册前置条件
  repository.registerPrecondition(
    PreconditionId("permissions"),
    arePermissionsGranted,
  );

  repository.registerPrecondition(
    PreconditionId("online"),
    isDeviceOnline,
  );

  repository.registerPrecondition(
    PreconditionId("validSubscription"),
    isSubscriptionValid,
    staySatisfiedCacheDuration: Duration(minutes: 10), // 缓存成功的订阅检查结果10分钟
  );

  repository.registerPrecondition(
    PreconditionId("serverRunning"),
    isMyServerRunning,
    dependsOn: [tight(PreconditionId("online"))], // 只有当设备在线时才检查服务器是否运行
    resolveTimeout: Duration(seconds: 5), // 设置超时时间为5秒
  );

  // 评估所有前置条件
  await repository.evaluatePreconditions();

  runApp(MyApp(repository: repository));
}

3. 在应用中使用前置条件

在应用启动时，我们可以根据前置条件的状态决定是否导航到某些页面或显示错误信息：

class MyApp extends StatelessWidget {
  final PreconditionsRepository repository;

  MyApp({required this.repository});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: AnimatedBuilder(
        animation: repository,
        builder: (context, _) {
          if (repository.isEvaluating) {
            return Center(child: CircularProgressIndicator());
          }

          if (repository.hasAnyUnsatisfiedPreconditions()) {
            return Scaffold(
              appBar: AppBar(title: Text("Error")),
              body: ListView(
                children: repository.getUnsatisfiedPreconditions().map((p) {
                  return ListTile(
                    title: Text(p.id.value),
                    subtitle: Text(p.status.message ?? ""),
                  );
                }).toList(),
              ),
            );
          }

          return HomePage();
        },
      ),
    );
  }
}

class HomePage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text("Home Page")),
      body: Center(child: Text("Welcome to the Home Page!")),
    );
  }
}

4. 定期重新评估前置条件

为了确保应用状态是最新的，我们可以设置一个定时器定期重新评估前置条件：

Timer.periodic(Duration(minutes: 5), (_) {
  repository.evaluatePreconditions();
});

5. 导航到高级内容

如果我们想导航到付费的高级内容，可以先检查用户的订阅是否有效：

var p = await repository.evaluatePrecondition(PreconditionId("validSubscription"));
if (p.isSuccessfull) {
  Navigator.of(context).push(MaterialPageRoute(builder: (_) => PremiumContentPage()));
} else {
  // 显示错误信息或重试按钮
}

6. 复杂前置条件组

我们可以将多个前置条件组合成一个组，并在需要时一起评估：

repository.registerAggregatePrecondition(
  PreconditionId("beforePremiumContent"),
  [
    tight(PreconditionId("isOnline")),
    tight(PreconditionId("hasValidSubscription")),
  ],
);

await repository.evaluatePreconditionById(PreconditionId("beforePremiumContent"));