Flutter错误监控插件djangoflow_sentry_reporter的使用

Djangoflow Sentry Reporter 是一个库，允许您使用 DjangoflowErrorReporter 类将错误报告到 Sentry。它基于 sentry_flutter 包构建，并提供了一个简单易用的类来向 Sentry 报告错误。

安装

在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  djangoflow_sentry_reporter: <最新版本>
  djangoflow_error_reporter: <最新版本> // 添加此行以使用 DjangoflowErrorReporter
  sentry_flutter: <最新版本> // 如果需要 Sentry 的其他功能，请添加此行

然后运行以下命令以安装包：

flutter pub get

使用

要使用 DjangoflowSentryReporter 类，您需要通过传递您的 Sentry DSN 作为构造函数参数来创建其实例。

final sentryReporter = DjangoflowSentryReporter("https://your_dsn_key@sentry.io/project_id");

接下来，您可以将 DjangoflowSentryReporter 实例添加到 DjangoflowErrorReporter 中：

DjangoflowErrorReporter.instance.addAll([sentryReporter]);

最后，您可以使用 DjangoflowErrorReporter.instance.report(e, s) 方法将错误报告给 Sentry：

try {
  // 一些可能抛出异常的代码
} catch (e, s) {
  DjangoflowErrorReporter.instance.report(exception: e, stackTrace: s); // 这会通过 Sentry 发送错误
}

启用错误报告

默认情况下，错误报告是禁用的。您可以使用 DjangoflowErrorReporter.instance.enableErrorReporting() 方法启用它：

DjangoflowErrorReporter.instance.enableErrorReporting();

初始化

您还可以通过传递环境 (env) 和发布版本 (release) 值来初始化 DjangoflowSentryReporter 实例：

DjangoflowErrorReporter.instance.initialize(env: 'production', release: '1.0.0');

更新用户信息

您可以通过传递 id、email 和 name 值来更新用户信息：

DjangoflowErrorReporter.instance.updateUserInformation(id: '123', email: 'user@example.com', name: 'John Doe');

示例

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    // 创建 DjangoflowSentryReporter 实例
    final sentryReporter = DjangoflowSentryReporter("https://your_dsn_key@sentry.io/project_id");

    // 启用错误报告
    DjangoflowErrorReporter.instance.enableErrorReporting();

    // 将 Sentry 报告器添加到 DjangoflowErrorReporter
    DjangoflowErrorReporter.instance.addAll([sentryReporter]);

    // 初始化环境和发布版本
    DjangoflowErrorReporter.instance.initialize(env: 'production', release: '1.0.0');

    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: RaisedButton(
            onPressed: () {
              try {
                throw Exception('Something went wrong');
              } catch (e, s) {
                // 报告错误到 Sentry
                DjangoflowErrorReporter.instance.report(exception: e, stackTrace: s);
              }
            },
            child: Text('Throw Exception'),
          ),
        ),
      ),
    );
  }
}

示例代码

以下是完整的示例代码，您可以直接运行它：

import 'package:djangoflow_error_reporter/djangoflow_error_reporter.dart';
import 'package:djangoflow_sentry_reporter/djangoflow_sentry_reporter.dart';
import 'package:flutter/material.dart';

const String _kSentryDsn = ''; // 添加您的 Sentry DSN

void main() {
  // 创建 DjangoflowSentryReporter 实例
  final reporter = DjangoflowSentryReporter(_kSentryDsn);

  // 将 Sentry 报告器添加到 DjangoflowErrorReporter
  DjangoflowErrorReporter.instance.addAll([reporter]);

  // 启用错误报告
  DjangoflowErrorReporter.instance.enableErrorReporting();

  // 初始化环境和发布版本
  DjangoflowErrorReporter.instance.initialize(env: 'production', release: '1.0.0+1');

  runApp(const MainApp());
}

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

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

class _HomePage extends StatefulWidget {
  const _HomePage();

  [@override](/user/override)
  State<_HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<_HomePage> {
  _AppEnv _appEnv = _AppEnv.live;

  _AppEnv get appEnv => _appEnv;

  set appEnv(_AppEnv value) {
    setState(() {
      _appEnv = value;
      DjangoflowErrorReporter.instance.initialize(
        env: value.toString(),
        release: '1.0.0+1',
      );
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Home Page')),
      body: ListView(
        padding: const EdgeInsets.all(16),
        children: [
          SwitchListTile.adaptive(
            value: appEnv == _AppEnv.live,
            title: Text('${appEnv.name.toString().toUpperCase()} Environment'),
            onChanged: (value) {
              appEnv = value ? _AppEnv.live : _AppEnv.staging;
            },
          ),
          const SizedBox(height: 16),
          ElevatedButton(
            onPressed: () {
              try {
                throw Exception('Test Exception');
              } catch (e, stacktrace) {
                // 报告错误到 Sentry
                DjangoflowErrorReporter.instance.report(
                  exception: e,
                  stackTrace: stacktrace,
                );
              }
            },
            child: const Text('Throw Exception'),
          ),
        ],
      ),
    );
  }
}

enum _AppEnv { live, staging }