Flutter错误报告插件n_bug_reporter的使用

Flutter错误报告插件n_bug_reporter的使用

获取开始

本项目是一个Flutter插件包的起点，这种插件包包含针对Android和/或iOS平台的特定实现代码。

对于如何开始使用Flutter，可以查看我们的在线文档，该文档提供了教程、示例、移动开发指南以及完整的API参考。

示例代码

以下是一个完整的示例代码，展示了如何在Flutter应用中使用n_bug_reporter插件来创建错误报告任务和获取屏幕截图。

import 'dart:typed_data';

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

import 'package:flutter/services.dart';
import 'package:n_bug_reporter/n_bug_reporter.dart';
import 'package:n_bug_reporter/model/clickup_custom_field_ids.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = '未知';
  String? _createdTaskId = '未知';
  static const String privateKey = ''; // 请在此处填写私钥
  Uint8List? _currentSS;

  // 这个键必须传递给nbugreporter
  // 并且scaffold应该包裹在repaint边界内
  // 关于repaint边界: https://www.woolha.com/tutorials/flutter-using-repaintboundary-examples
  final GlobalKey _key = GlobalKey();

  [@override](/user/override)
  void initState() {
    super.initState();
    NBugReporter.configure(
        privateKey: privateKey,
        listId: '', // 请在此处填写列表ID
        templateId: '', // 请在此处填写模板ID
        customFieldIds: ClickUpCustomFieldIds(
            appBundleId: '', // 请在此处填写应用包ID
            activity: '', // 请在此处填写活动
            deviceInfo: '', // 请在此处填写设备信息
            platform: ''), // 请在此处填写平台
        repaintBoundaryKey: _key);
    initPlatformState();
  }

  // 平台消息是异步的，所以我们初始化在一个异步方法中。
  Future<void> initPlatformState() async {
    String platformVersion;
    String createdTaskId;
    // 平台消息可能会失败，所以我们使用try/catch来捕获PlatformException。
    // 我们还处理了消息可能返回null的情况。
    try {
      platformVersion = await NBugReporter.platformVersion ?? '未知平台版本';
    } on PlatformException {
      platformVersion = '获取平台版本失败。';
    }

    // 如果小部件在异步平台消息发送时从树中移除，我们希望丢弃回复而不是调用setState来更新不存在的外观。
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    final ButtonStyle style = ElevatedButton.styleFrom(textStyle: const TextStyle(fontSize: 20));

    return MaterialApp(
      home: RepaintBoundary(
        key: _key,
        child: Scaffold(
          appBar: AppBar(
            title: const Text('插件示例应用'),
          ),
          body: Stack(
            children: [
              Positioned(
                  child: NBugReporter.nBugReporterButton(
                    prereport: (){},
                    postreport: (){},
                  ),
                  left: 0,
                  bottom: 0),
              Center(
                child: Column(
                  children: [
                    Text('运行在: $_platformVersion\n'),
                    Text('创建的任务ID: $_createdTaskId\n'),
                    ElevatedButton(
                      style: style,
                      onPressed: () async {
                        var res = await NBugReporter.createTaskFromTemplate();
                        setState(() {
                          _createdTaskId = res?.id;
                        });
                      },
                      child: const Text('创建N BUG REPORTER任务'),
                    ),
                    ElevatedButton(
                      style: style,
                      onPressed: () async {
                        var ss = await NBugReporter.getScreenshot(repaintBoundaryKey: _key);
                        setState(() {
                          _currentSS = ss;
                        });
                      },
                      child: Column(
                        children: [
                          _currentSS != null
                              ? Image.memory(
                                  _currentSS!,
                                  height: 100,
                                  width: 100,
                                )
                              : const SizedBox.shrink(),
                          const Text('获取屏幕截图'),
                        ],
                      ),
                    )
                  ],
                ),
              )
            ],
          ),
        ),
      ),
    );
  }
}