Flutter性能监控插件sreporter的使用

SReporter 是一个用于从您的应用程序向Telegram聊天（私聊、群聊或频道）发送报告、崩溃日志和消息的 Dart 包。或者，您可以将其发送到特定的 Discord 频道。

构建状态与评分

使用方法

要使用此插件，请在 pubspec.yaml 文件中添加 SReporter 作为依赖项。

dependencies:
  sreporter: ^1.0.0

示例代码

导入库

import 'package:sreporter/sreporter.dart';

发送Telegram报告

预览

如何使用

Telegram 报告支持在其标题和内容中使用 Markdown 元素。

// 可选语言
TeleCode('// Code...', lang: 'java').toString();
// 下划线
TeleUnderline(' text ').toString();
// 隐藏文本
TeleSpoiler(' text ').toString();
// 删除线
TeleStrikeThrough(' text ').toString();
// 斜体
TeleItalics(' text ').toString();
// 粗体
TeleBold(' text ').toString();

整个代码：

SReporter.teleReporter(
  botToken: '195211143...', // 在 Telegram 中从 @botFather 获取
  targetChat: '14888...', // 聊天ID 或者提及用户名 '@smith8h'
  reportHeader: 'Report sent from ${Italic('Demo App')}.',
  reportSubHeader: '${Spoiler(Underline('Flutter-Demo').toString())}', // 可选
  reportMessage: '${Code('Custom.message', lang: 'dart')}',
  reportFooter: 'Footer (More Info)...', // 可选
  onSuccess: () {
    // 成功发送报告时调用
  },
  onFailure: (msg) {
    // 发送报告失败时调用
  },
).report();

发送Discord报告

预览

如何使用

Discord 报告支持在其标题和内容中使用 Markdown 元素。

// 多行代码
DiscCode('// Code...', multiline: true).toString(); // 默认为单行
// 下划线
DiscUnderline(' text ').toString();
// 隐藏文本
DiscSpoiler(' text ').toString();
// 删除线
DiscStrikeThrough(' text ').toString();
// 斜体
DiscItalics(' text ').toString();
// 粗体
DiscBold(' text ').toString();
// 标题
DiscHeader(' text ', type: 1).toString(); // 类型代表标题级别 h1, h2, h3...
// 链接
DiscLink('text', 'url').toString();
// 列表项
DiscListItem('text', indent: true).toString(); // 缩进以使列表项属于次级列表。
// 引用
DiscBlockQuote('text', wholeMsg: true).toString(); // 设置引用为单行或整条消息。

整个代码：

SReporter.discReporter(
  webhook: 'https://discord.com/api/webhooks/11...',
  contentMessage: 'Content Message with ${DiscBold('spoiler text')}...',
  onSucess: () {
    // 成功发送报告时调用
  },
  onFailure: (failMsg) {
    // 发送报告失败时调用
  },
).report();

完整示例代码

以下是完整的示例代码，展示了如何在 Flutter 应用程序中使用 SReporter 插件来发送 Telegram 和 Discord 报告。

// ignore_for_file: unused_local_variable

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:sreporter/sreporter.dart';
import 'package:sreporter/utils/utils.dart';

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    sendReport();
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }

  void sendReport() {
    SReporter.teleReporter(
      botToken: '195211143...', // 在 Telegram 中从 @botFather 获取
      targetChat: '14888...', // 聊天ID 或者提及用户名 '@smith8h'
      reportHeader: 'Report sent from ${TeleItalics('Demo App')}.',
      reportSubHeader: '${TeleSpoiler('${TeleUnderline('Flutter-Demo')}')}', // 可选
      reportMessage: '${TeleCode('Custom.message')}',
      reportFooter: 'Footer...', // 可选
      onSuccess: () {
        if (kDebugMode) {
          print('tele ==== done!!!!');
        }
      },
      onFailure: (msg) {
        if (kDebugMode) {
          print('tele ==== $msg');
        }
      },
    ).report();

    SReporter.discReporter(
      webhook: 'https://discord.com/api/webhooks/1171...', // Discord webhook URL
      contentMessage: 'Content Message with ${DiscBold('spoiler text')}...',
      onSucess: () {
        if (kDebugMode) {
          print('disc ==== done!!!!');
        }
      },
      onFailure: (failMsg) {
        if (kDebugMode) {
          print('disc ==== $failMsg');
        }
      },
    ).report();
  }
}