Flutter错误处理插件error_handler_2的使用

Description

Flutter error handler 2 是一个简单的插件，用于在代码库区域轻松处理错误。它可以通过将错误发送到 Telegram 来帮助开发者了解应用中发生了什么问题。

Vision

快速且简单地在生产环境中了解错误，无需复杂的配置。

Getting started

初始化设置

首先，您需要初始化 error_handler_2 插件，以激活可选功能，例如将错误发送到 Telegram。在调试模式下，默认会记录错误。

设置 Telegram 参数

Future<void> setTelegram(String tokenTelegramPrivate, String chatIdTelegram, bool isSendToTelegram) async {
    ErrorHandlerVar.tokenTelegramPrivate = tokenTelegramPrivate; // 设置 Telegram Bot 的私钥
    ErrorHandlerVar.chatIdTelegram = chatIdTelegram;           // 设置 Telegram 聊天 ID
    ErrorHandlerVar.isSendToTelegram = isSendToTelegram;        // 是否启用发送错误到 Telegram
}

设置设备数据

为了更好地分析错误，您可以设置设备信息。

Future<void> setDeviceData(String device, String appVersion) async {
    ErrorHandlerVar.device = device;       // 设置设备类型（如 Android/iOS）
    ErrorHandlerVar.appVersion = appVersion; // 设置应用版本号
}

使用独立函数发送错误到 Telegram

发送文本消息

Future<void> sendTelegram({
    /// 函数用于向 Telegram 发送聊天消息
    url,
    statusCode,
    statusMessage,
    statusNote,
    String? paramBody,
    String? device,
    String? appVersion,
    String? env,
    required String tokenPrivate,
    required String chatId,
}) async {
    try {
        // 发送 POST 请求到 Telegram API
        Dio().post(
            "https://api.telegram.org/$tokenPrivate/sendMessage?chat_id=$chatId"
            "&text=url: <b>$url</b>;\nerror_code: <b>$statusCode</b>;\nerror_message: <b>$statusMessage</b>;\nerror_note: <b>$statusNote</b>;\ndevice: <b>$device</b>;\nappVersion: <b>$appVersion</b>;\nenv: <b>$env</b>;\nparamBody: <b>$paramBody</b>;&parse_mode=html",
        );
    } catch (er) {
        log(er.toString()); // 捕获异常并记录日志
    }
}

发送文档

如果需要发送文件或日志文件到 Telegram：

Future<void> sendDocument({
    /// 函数用于向 Telegram 发送文档
    url,
    required String path,
    required String tokenPrivate,
    required String chatId,
}) async {
    try {
        // 构造表单数据
        FormData formData = FormData.fromMap({
            "chat_id": ErrorHandlerVar.chatIdTelegram,
            "document": await MultipartFile.fromFile(path, filename: path),
        });

        // 发送 POST 请求到 Telegram API
        await Dio()
            .post(
                "https://api.telegram.org/${ErrorHandlerVar.tokenTelegramPrivate}/sendDocument",
                data: formData,
            )
            .then((value) {
            log(value.toString()); // 打印响应日志
        });
    } catch (er) {
        log(er.toString()); // 捕获异常并记录日志
    }
}

To Do / Roadmap

Version 1.0.0

• ❌ 使用 http 替代 dio 发送消息到 Telegram

Information

该插件的源码可以在 GitHub 上找到。

完整示例代码

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

import 'package:flutter/material.dart';
import 'package:dio/dio.dart';
import 'package:mime/mime.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

class HomeScreen extends StatefulWidget {
  @override
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  bool _isErrorSent = false;

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

  void initializeErrorHandler() async {
    // 初始化 Telegram 参数
    await setTelegram("YOUR_TELEGRAM_BOT_TOKEN", "YOUR_TELEGRAM_CHAT_ID", true);
    await setDeviceData("Android", "1.0.0");
  }

  Future<void> sendErrorToTelegram() async {
    try {
      // 模拟错误信息
      final url = "https://example.com";
      final statusCode = 500;
      final statusMessage = "Internal Server Error";
      final statusNote = "Something went wrong";

      // 发送错误信息到 Telegram
      await sendTelegram(
        url: url,
        statusCode: statusCode,
        statusMessage: statusMessage,
        statusNote: statusNote,
        device: "Android",
        appVersion: "1.0.0",
      );

      setState(() {
        _isErrorSent = true;
      });
    } catch (e) {
      print("Error sending error to Telegram: $e");
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("Error Handler Example"),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: sendErrorToTelegram,
              child: Text("Simulate Error"),
            ),
            SizedBox(height: 20),
            if (_isErrorSent)
              Text("Error sent successfully!"),
          ],
        ),
      ),
    );
  }
}

注意事项

1. 替换 YOUR_TELEGRAM_BOT_TOKEN 和 YOUR_TELEGRAM_CHAT_ID 为您的实际 Telegram Bot Token 和 Chat ID。
2. 确保已添加 dio 和 mime 依赖到您的 pubspec.yaml 文件中：

   dependencies:
     dio: ^4.0.0
     mime: ^1.0.0