Flutter条件触发插件conditional_trigger的使用

Flutter条件触发插件conditional_trigger的使用

conditional_trigger插件可以帮助你更轻松地为特定方法设置条件。通过这个插件，你可以根据应用程序的使用情况（如打开次数、天数等）来决定是否执行某些操作，例如显示横幅广告或提示用户进行应用内评分。

插件安装

首先，在pubspec.yaml文件中添加conditional_trigger依赖：

dependencies:
  conditional_trigger: ^latest_version

然后运行flutter pub get以安装插件。

使用示例

以下是一个完整的示例代码，展示了如何使用conditional_trigger插件来实现条件触发功能。我们将创建一个简单的Flutter应用程序，该应用程序会在满足特定条件时显示一个横幅和弹出对话框。

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

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

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  // 创建两个条件触发器
  final bannerSurvey = const ConditionalTrigger(
    'BannerSurvey',
    minDays: 3,      // 至少3天后触发
    minCalls: 5,     // 至少启动5次应用后触发
    debugLog: true,  // 打印调试日志
  );

  final announce = const ConditionalTrigger(
    'Announce',
    minDays: 1,      // 至少1天后触发
    minCalls: 3,     // 至少启动3次应用后触发
    debugLog: true,  // 打印调试日志
  );

  @override
  void initState() {
    initial();
    super.initState();
  }

  // 初始化时检查条件
  void initial() async {
    // 检查公告条件是否满足
    if (await announce.checkOnce() == ConditionalState.satisfied) {
      if (mounted) {
        // 如果条件满足，显示对话框
        showDialog(
          context: context,
          builder: (_) => const AlertDialog(
            title: Text('公告'),
            content: Text('这是一个公告'),
          ),
        );
      }
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: FutureBuilder(
          future: bannerSurvey.checkOnce(),  // 检查横幅条件
          builder: (ctx, snapshot) {
            if (!snapshot.hasData) {
              return const SizedBox.shrink();  // 如果没有数据，返回空 widget
            }

            // 如果条件满足，显示横幅文本
            if (snapshot.data == ConditionalState.satisfied) {
              return const Padding(
                padding: EdgeInsets.all(16.0),
                child: Text('这是一个调查横幅'),
              );
            } else {
              return const Center(
                child: Text('尚未满足条件'),
              );
            }
          },
        ),
      ),
    );
  }
}

参数说明

ConditionalTrigger构造函数接受多个参数，用于定义触发条件：

• name: 条件的名称，同时也是SharedPreferences的前缀。
• minDays: 自上次调用以来的最小天数。
• minCalls: 方法被调用的最小次数（每次执行方法时计数器会增加）。如果将其放在main()中，则相当于应用程序的启动次数。
• noRequestVersions: 如果当前版本在该列表中，则不会触发请求。
• remindedVersions: 允许应用程序提醒用户进行应用内评分的版本列表。
• keepRemind: 如果为true，则每次新版本满足所有条件时都会继续提示；如果为false，则只在第一次满足条件时提示。
• debugLog: 是否启用调试日志。

检查条件

你可以使用check()方法来检查条件是否满足：

final state = await condition.check();

if (state == ConditionalState.satisfied) {
  // 条件满足，执行相应操作
}

如果你已经在其他地方调用过check()，可以直接使用lastState属性获取上次检查的结果：

final state = condition.lastState;

如果你想确保check()只调用一次，可以使用checkOnce()方法：

final stateOnce = await condition.checkOnce();

if (state == ConditionalState.satisfied) {
  // 条件满足，执行相应操作
}

条件状态

ConditionalState枚举定义了可能的条件状态：

• ConditionalState.keepRemindDisabled: 条件满足，但keepRemind为false。
• ConditionalState.noRequestVersion: 当前版本在noRequestVersions列表中，因此不满足条件。
• ConditionalState.notSatisfiedWithMinCallsAndDays: 未满足minCalls和minDays条件。
• ConditionalState.notSatisfiedWithMinCalls: 未满足minCalls条件。
• ConditionalState.notSatisfiedWithMinDays: 未满足minDays条件。
• ConditionalState.satisfied: 所有条件都已满足。

测试

你可以使用setMockInitialValues方法来设置模拟值，以便在测试时控制条件的状态：

condition.setMockInitialValues(ConditionalMock());

如果你想移除模拟值，可以传递一个空的ConditionalMock对象：

condition.setMockInitialValues();