Flutter 鸿蒙化实战:catcher 适配 OpenHarmony

前言

随着鸿蒙生态的快速发展,越来越多的 Flutter 应用需要适配 OpenHarmony 平台。但生态早期,大量常用三方库只有 Android / iOS 实现,鸿蒙侧只能自己造轮子。

为了解决这个问题,CPF-Flutter 社区对一批高频使用的 Flutter 三方库做了 OpenHarmony 平台适配,统一托管在 GitCode 的 CPF-Flutter 组织 下,全部通过 TAG 版本隔离、配套门禁编译验证,开箱即用。

本篇是系列文章之一,主角是 catcher —— 全局异常捕获与上报插件。

catcher 是什么

catcher(原库 0.7.0)是 Flutter 的全局错误捕获库,能在 app 运行时自动捕获未被处理的异常并统一上报:

  1. 全局捕获Catcher 初始化后自动接管异常,无需逐处 try-catch;
  2. 主动上报reportCheckedError 手动上报已捕获的错误,sendTestException 发送测试异常;
  3. 错误页addDefaultErrorWidget 添加默认错误提示页;
  4. 配置updateConfiggetCurrentConfig 动态增改上报配置。

适配情况

Flutter 框架版本TAG 名称分支名
3.70.7.0-ohos-1.0.0master
3.220.7.0-ohos-1.0.0master
3.270.7.0-ohos-1.0.0master
3.350.7.0-ohos-1.0.0master

快速接入

在 pubspec.yaml 中添加 git 依赖:

dependencies:
  catcher:
    git:
      url: https://gitcode.com/CPF-Flutter/fluttertpc_catcher.git
      # 按你的 Flutter 框架版本,从上方映射表选择对应 TAG
      ref: 0.7.0-ohos-1.0.0

执行:

flutter pub get

使用示例

import 'package:catcher/catcher.dart';

void main() {
  Catcher(
    runAppFunction: () => runApp(const MyApp()),
    config: CatcherConfig(
      reportConfigs: [
        ConsoleReportConfig(),
        EmailManualReportConfig(),
      ],
    ),
  );
}

// 主动上报一个已捕获的错误
await Catcher.reportCheckedError('业务错误', null);

API 支持一览

API说明ohos 支持
Catcher初始化全局异常捕获yes
reportCheckedError主动上报已捕获错误yes
updateConfig更新捕获配置yes
getCurrentConfig获取当前配置yes
addDefaultErrorWidget添加默认错误提示页yes
sendTestException发送测试异常yes

[!TIP] ohos Support 为 yes 表示鸿蒙平台支持该能力,使用方式与 iOS / Android 保持一致。

仓库地址

  • OpenHarmony 适配仓库:https://gitcode.com/CPF-Flutter/fluttertpc_catcher
  • 使用问题反馈:请到 CPF-Flutter 社区 Issues 提交问题(社区统一收集跟进);本仓库 Issues 区亦可。

系列预告

截至目前,CPF-Flutter 社区已完成 250+ 个 Flutter 三方库的 OpenHarmony 平台适配,覆盖权限管理、UI 组件、设备信息、位置服务、媒体处理、网络、支付等多个领域,完整的适配清单(含每个库的版本映射表)见:

  • 适配总览文档:https://gitcode.com/CPF-Flutter/docs/blob/main/ThirdpartyLibrarites.md
  • 仓库组织:https://gitcode.com/CPF-Flutter

本系列后续会陆续挑选高频库展开讲解,比如扫码识别(flutter_barcode_scanner)、录音(record_mp3)、自定义光标(flutter_custom_cursor)等。

如果你的 Flutter 应用正在计划适配鸿蒙,欢迎关注 CPF-Flutter 组织,也欢迎参与共建。

Logo

开源鸿蒙跨平台开发社区汇聚开发者与厂商,共建“一次开发,多端部署”的开源生态,致力于降低跨端开发门槛,推动万物智联创新。

更多推荐