Flutter应用评分提示插件app_review_helper的使用

简介

app_review_helper 是一个 Flutter 插件，它可以帮助你在应用内请求用户评分，同时提供了一些自定义对话框的功能。以下是该插件的一些关键特性和使用方法。

特性

• 支持 Android 和 iOS 平台。
• 提供多种内置对话框样式。
• 可以自定义对话框。
• 支持最小调用次数和最小天数条件。
• 支持版本控制，可以指定某些版本不显示评分请求。
• 支持调试模式。

使用方法

初始化

首先，你需要在你的 Flutter 项目中添加 app_review_helper 依赖。在 pubspec.yaml 文件中添加以下内容：

dependencies:
  app_review_helper: ^latest_version

然后运行 flutter pub get 来安装依赖。

基本用法

以下是一个基本的初始化示例：

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

void main() {
  runApp(MaterialApp(
    home: const MyApp(),
    theme: ThemeData(useMaterial3: false),
  ));
}

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

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

class _MyAppState extends State<MyApp> {
  final instance = AppReviewHelper.instance;

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

  Future<void> init() async {
    await instance.initial(
      reviewDialog: DefaultReviewDialog(
        context: context,
        satisfactionText: 'How do you feel about this app?',
        satisfactionLikeText: 'Like',
        satisfactionLikeIcon: const Icon(Icons.thumb_up),
        satisfactionDislikeText: 'Dislike',
        satisfactionDislikeTextColor: Colors.grey,
        satisfactionDislikeIcon: const Icon(Icons.thumb_down, color: Colors.grey),
        opinionText: 'Please let us know what we can do to improve this app',
        opinionSubmitText: 'Submit',
        opinionCancelText: 'Cancel',
        opinionAnonymousText: 'Completely anonymous',
        opinionFeedback: (opinion) {
          print(opinion);
        },
        barrierColor: null,
      ),
      minDays: 3,
      minCalls: 3,
      noRequestVersions: ['<=1.0.0', '3.0.0', '>4.0.0'],
      remindedVersions: ['2.0.0', '3.0.0'],
      keepRemind: true,
      duration: const Duration(seconds: 1),
      isDebug: false,
    );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Review Helper')),
      body: const Center(child: Text('Example')),
    );
  }
}

内置对话框

app_review_helper 提供了多种内置对话框，你可以根据需要选择使用：

• DefaultReviewDialog：默认对话框，包含喜欢和不喜欢的图标。
• AdaptiveReviewDialog：适应不同平台（iOS 和 macOS）的对话框。
• FriendlyReviewDialog：基于 DefaultReviewDialog，但使用笑脸和愁脸图标。
• FriendlyAdaptiveReviewDialog：基于 AdaptiveReviewDialog，但使用笑脸和愁脸图标。

例如，使用 AdaptiveReviewDialog：

await instance.initial(
  reviewDialog: AdaptiveReviewDialog(
    context: context,
    opinionFeedback: (opinion) {
      print(opinion);
    },
  ),
  minDays: 3,
  minCalls: 3,
  keepRemind: true,
  isDebug: false,
);

自定义对话框

你也可以创建自己的对话框，实现 ReviewDialog 接口：

class CustomReviewDialog implements ReviewDialog {
  CustomReviewDialog();

  @override
  FutureOr<bool?> satisfaction() async {
    // 显示自定义满意度对话框
    bool? result = await showDialog<bool>(
      context: context,
      builder: (context) => AlertDialog(
        title: Text('How do you feel about this app?'),
        actions: [
          TextButton(
            onPressed: () => Navigator.of(context).pop(true),
            child: Text('Like'),
          ),
          TextButton(
            onPressed: () => Navigator.of(context).pop(false),
            child: Text('Dislike'),
          ),
        ],
      ),
    );
    return result;
  }

  @override
  FutureOr<void> opinion() async {
    // 显示自定义意见对话框
    String? opinion = await showDialog<String>(
      context: context,
      builder: (context) => AlertDialog(
        title: Text('Please let us know what we can do to improve this app'),
        content: TextField(
          decoration: InputDecoration(hintText: 'Your feedback'),
          maxLines: 3,
          onChanged: (value) {},
        ),
        actions: [
          TextButton(
            onPressed: () => Navigator.of(context).pop(null),
            child: Text('Cancel'),
          ),
          TextButton(
            onPressed: () => Navigator.of(context).pop('User feedback'),
            child: Text('Submit'),
          ),
        ],
      ),
    );
    if (opinion != null) {
      print(opinion);
    }
  }
}

然后在初始化时使用自定义对话框：

await instance.initial(
  reviewDialog: CustomReviewDialog(),
  minDays: 3,
  minCalls: 3,
  keepRemind: true,
  isDebug: false,
);

打开应用商店

如果你希望直接打开应用商店页面，可以使用 openStore 方法：

instance.openStore();

返回值

app_review_helper 提供了多种返回值，帮助你了解请求的状态：

• ReviewState.unSupportedPlatform：当前平台不支持。
• ReviewState.unavailable：当前无法请求应用内评分。
• ReviewState.keepRemindDisabled：已禁用重复提醒。
• ReviewState.noRequestVersion：当前版本满足不请求评分的条件。
• ReviewState.completed：评分请求完成。
• ReviewState.compeletedInDebugMode：在调试模式下完成评分请求。
• ReviewState.notSatisfiedWithMinCallsAndDays：不满足最小调用次数和最小天数条件。
• ReviewState.notSatisfiedWithMinCalls：不满足最小调用次数条件。
• ReviewState.notSatisfiedWithMinDays：不满足最小天数条件。

示例代码

以下是一个完整的示例代码，展示了如何使用 app_review_helper 插件：

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

void main() {
  runApp(MaterialApp(
    home: const MyApp(),
    theme: ThemeData(useMaterial3: false),
  ));
}

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

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

class _MyAppState extends State<MyApp> {
  final instance = AppReviewHelper.instance;

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

  Future<void> init() async {
    debugPrint('DefaultReviewDialog');
    await instance.initial(
      reviewDialog: DefaultReviewDialog(
        context: context,
        opinionFeedback: (opinion) {
          debugPrint(opinion);
        },
      ),
      minCalls: 0,
      minDays: 0,
      keepRemind: true,
      isDebug: false,
    );

    debugPrint('AdaptiveReviewDialog');
    if (mounted) {
      await instance.initial(
        reviewDialog: AdaptiveReviewDialog(
          context: context,
          opinionFeedback: (opinion) {
            debugPrint(opinion);
          },
        ),
        minCalls: 0,
        minDays: 0,
        keepRemind: true,
        isDebug: false,
      );
    }

    debugPrint('FriendlyReviewDialog');
    if (mounted) {
      await instance.initial(
        reviewDialog: FriendlyReviewDialog(
          context: context,
          opinionFeedback: (opinion) {
            debugPrint(opinion);
          },
        ),
        minCalls: 0,
        minDays: 0,
        keepRemind: true,
        isDebug: false,
      );
    }

    debugPrint('FriendlyAdaptiveReviewDialog');
    if (mounted) {
      await instance.initial(
        reviewDialog: FriendlyAdaptiveReviewDialog(
          context: context,
          opinionFeedback: (opinion) {
            debugPrint(opinion);
          },
        ),
        minCalls: 0,
        minDays: 0,
        keepRemind: true,
        isDebug: false,
      );
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Review Helper')),
      body: const Center(child: Text('Example')),
    );
  }
}

通过以上示例代码，你可以看到如何在 Flutter 应用中使用 app_review_helper 插件来请求用户评分，并处理用户的反馈。希望这些信息对你有所帮助！