Flutter数据报告插件easy_report的使用

easy_report 插件提供了一种简单的方式来报告和管理用户生成的内容，如用户、帖子、评论、照片、聊天等。它适用于任何包含用户生成内容的应用。

TODO

• 让管理员列出已报告的用户及其内容，并决定是否禁用他们的账户，从而阻止他们继续使用应用。

概念

• 它不要求用户提供输入来避免给用户带来不便。相反，它会提示用户按一个按钮来选择报告的原因。它提供了三个选项：“垃圾信息”、“滥用”、“其他”，这些选项已经足够了。

• 它保存以下信息：

  • 负责数据的用户的 UID。这可以是创建数据的用户的 UID 或数据管理员的 UID。
  • 数据的路径。数据可以是实时数据库的路径或 Firestore 文档的路径。
  • 数据的类型。它可以是 user、post、comment、photo、chat 等。
  • 报告的原因。它可以是 spam（垃圾信息）、abusive（滥用）、other（其他）。
  • 报告的摘要。它可以是一段描述报告的文字，也可以是一段描述原因或数据的文字。

数据库结构

报告节点结构

• 路径为 reports/$reportKey
  • $reportKey 是节点数据键。
    • reportee 字段：负责数据的用户的 UID。
    • reporter 字段：创建报告的用户的 UID。通常是登录用户的 UID。
    • path 字段：数据的路径。它可以是实时数据库的路径或 Firestore 文档的路径。
    • type 字段：数据的类型。它可以是 user、post、comment、photo、chat 等。
    • reason 字段：报告的原因。它可以是 spam、abusive、other。
    • summary 字段：报告的摘要。
    • createdAt 字段：报告创建的时间。

报告列表节点结构

• 路径为 reports/---key-list/$reportKey
  • ---key-list 是节点数据键。它保存所有的报告键。这是为了管理员的报告列表目的。
    • $reportKey 字段：这个键是报告键。它有 UID 作为值。

如何使用

初始化

你可以选择在使用前初始化 ReportService。

通过 init 方法，你可以自定义 onCreate 回调。onCreate 回调在报告创建后被调用，它包含了新创建的 report 信息。

ReportService.instance.init();

显示报告按钮

你可以像这样显示报告按钮，并调用 report 方法。

TextButton(
  onPressed: () async {
    await ReportService.instance.report(
      context: context,
      otherUid: user.uid,
      documentReference: user.ref,
    );
  },
  child: const Text('报告'),
),

显示被封禁用户列表

你可以显示被封禁用户的列表。

ElevatedButton(
  onPressed: () =>
      ReportService.instance.showReportListScreen(context),
  child: const Text(
    '报告列表',
  ),
),

UI/UX 自定义

这是一个开源项目。你可以直接打开包的源码并复制/粘贴/编辑代码。代码应该足够简单以便重用。

• 若要显示登录用户所作的报告，调用 ReportService.instance.showReportListScreen()。
• 若要自定义报告列表屏幕的 UI，你可以创建自己的屏幕并使用 ReportListView。
  • ReportListView 支持大多数列表视图小部件的属性。

onCreate 回调

onCreate 是报告创建后的回调，它包含新创建的 report 信息。

例如，我们可以在报告创建后发送推送通知到管理员。

ReportService.instance.init(
  onCreate: (Report report) async {
    /// 设置推送通知。例如，向报告者发送推送通知
    /// 或者开发者可以向管理员发送推送通知
    MessagingService.instance.sendMessageToUids(
      uids: [report.reportee],
      title: '你已被举报',
      body: '举报原因 ${report.reason}',
      data: {
        "action": 'report',
        'reportId': report.id,
        'documentReference': report.documentReference.toString(),
      },
    );
  },
);

示例代码

import 'package:easyuser/easyuser.dart';
import 'package:firebase_database/firebase_database.dart';
import 'package:flutter/material.dart';
import 'package:easy_report/easy_report.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  print('firebase project id: ${FirebaseDatabase.instance.app.options.projectId}');
  runApp(const EasyReportApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: HomeScreen(),
    );
  }
}

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

  [@override](/user/override)
  State<HomeScreen> createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  [@override](/user/override)
  void initState() {
    super.initState();
    init();
  }

  init() async {
    ReportService.instance.init();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(),
      body: Column(
        children: [
          AuthStateChanges(
            builder: (user) {
              return user == null
                  ? const EmailPasswordLogin()
                  : Column(
                      children: [
                        Text('欢迎用户 uid: ${user.uid}'),
                        ElevatedButton(
                          onPressed: () {
                            UserService.instance.signOut();
                          },
                          child: const Text('退出登录'),
                        ),
                      ],
                    );
            },
          ),
          ElevatedButton(
            onPressed: () {
              ReportService.instance.report(
                context: context,
                reportee: 'reportee',
                type: 'type',
                path: 'user-uid',
                summary: 'summary',
              );
            },
            child: const Text('报告一个用户'),
          ),
          ElevatedButton(
            onPressed: () {
              ReportService.instance.report(
                context: context,
                reportee: 'u2',
                type: 'post',
                path: 'post 1',
                summary: 'summary 1',
              );
            },
            child: const Text('报告一篇帖子'),
          ),
          ElevatedButton(
            onPressed: () {
              ReportService.instance.report(
                context: context,
                reportee: 'u3',
                type: 'comment',
                path: 'comment 1',
                summary: '我举报这条评论 3',
              );
            },
            child: const Text('报告一条评论'),
          ),
          ElevatedButton(
            onPressed: () {
              ReportService.instance.report(
                context: context,
                reportee: 'uid of the user: if it is a chat room, report one of the master',
                type: 'chat',
                summary: '举报聊天室',
                path: '/chat/room/chat_room_id',
              );
            },
            child: const Text('举报一个聊天室'),
          ),
          AuthStateChanges(
            builder: (user) => user == null
                ? const SizedBox.shrink()
                : const Expanded(
                    child: ReportListView(),
                  ),
          ),
        ],
      ),
    );
  }
}