基于 react-native-exception-handler 的 OpenHarmony 适配版，用于捕获和处理 JS 与原生的全局异常/崩溃

当前项目代码仓暂无内容

文档模板：v0.4.2

`react-native-exception-handler`

本项目基于原库react-native-exception-handler 开发。

该第三方库的仓库已迁移至 Gitcode，且支持直接从 npm 下载，新的包名为：@react-native-ohos/react-native-exception-handler 版本所属关系如下：

三方库名称	三方库版本（npm地址）	发布信息	支持RN版本	Autolink	编译API版本	社区基线版本	源码地址
@react-native-ohos/react-native-exception-handler	~2.10.11	Gitcode Releases	0.72.*	是	API12+	2.10.10	br_rnoh0.72
@react-native-oh-tpl/react-native-exception-handler	<=2.10.10-0.1.7@deprecated	Github Releases(deprecated)	0.72.*	否	API12+	2.10.10	sig

简介

react-native-exception-handler 是一个用于注册全局错误处理器，捕获应用中未处理的致命或非致命异常。

下载安装

进入到工程目录并输入以下命令：

npm

npm install @react-native-ohos/react-native-exception-handler

yarn

yarn add @react-native-ohos/react-native-exception-handler

Link

	是否支持autolink	RN框架版本
~2.10.11	Yes	0.72
<=2.10.10-0.1.7@deprecated	No	0.72

使用AutoLink的工程需要根据该文档配置，Autolink框架指导文档：https://gitcode.com/CPF-RN/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md

如您使用的版本支持 Autolink，并且工程已接入 Autolink，可跳过ManualLink配置。

ManualLink: 此步骤为手动配置原生依赖项的指导

首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony。

1. 在工程根目录的 `oh-package.json5` 添加 overrides 字段

{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony" : "./react_native_openharmony"
  }
}

2. 引入原生端代码

目前有两种方法：

通过 har 包引入（在 IDE 完善相关功能后该方法会被遗弃，目前首选此方法）；
直接链接源码。

方法一：通过 har 包引入（推荐）

har 包位于三方库安装路径的 `harmony` 文件夹下。

打开 entry/oh-package.json5，添加以下依赖

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",

    "@react-native-ohos/react-native-exception-handler": "file:../../node_modules/@react-native-ohos/react-native-exception-handler/harmony/exception_handler.har",
  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

如需使用直接链接源码，请参考[直接链接源码说明](https://gitcode.com/CPF-RN/usage-docs/blob/master/zh-cn/link-source-code.md)

3. 配置 CMakeLists 和引入 ExceptionHandlerPackage

若使用的是 <=2.10.10-0.1.7 版本，请跳过本章

打开 entry/src/main/cpp/CMakeLists.txt，添加：

project(rnapp)
cmake_minimum_required(VERSION 3.4.1)
set(CMAKE_SKIP_BUILD_RPATH TRUE)
set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
set(NODE_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../node_modules")
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp")
set(LOG_VERBOSITY_LEVEL 1)
set(CMAKE_ASM_FLAGS "-Wno-error=unused-command-line-argument -Qunused-arguments")
set(CMAKE_CXX_FLAGS "-fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -s -fPIE -pie")
set(WITH_HITRACE_SYSTRACE 1) # for other CMakeLists.txt files to use
add_compile_definitions(WITH_HITRACE_SYSTRACE)

add_subdirectory("${RNOH_CPP_DIR}" ./rn)

# RNOH_BEGIN: manual_package_linking_1
add_subdirectory("../../../../sample_package/src/main/cpp" ./sample-package)
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/react-native-exception-handler/src/main/cpp" ./exception-handler)
# RNOH_END: manual_package_linking_1

file(GLOB GENERATED_CPP_FILES "./generated/*.cpp")

add_library(rnoh_app SHARED
    ${GENERATED_CPP_FILES}
    "./PackageProvider.cpp"
    "${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
)
target_link_libraries(rnoh_app PUBLIC rnoh)

# RNOH_BEGIN: manual_package_linking_2
target_link_libraries(rnoh_app PUBLIC rnoh_sample_package)
+ target_link_libraries(rnoh_app PUBLIC rnoh_exception_handler)
# RNOH_END: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp，添加：

#include "RNOH/PackageProvider.h"
#include "SamplePackage.h"
+ #include "ExceptionHandlerPackage.h"

using namespace rnoh;

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
      std::make_shared<SamplePackage>(ctx),
+     std::make_shared<ExceptionHandlerPackage>(ctx)
    };
}

4. 在 ArkTs 侧引入 ExceptionHandlerPackage

打开 entry/src/main/ets/RNPackagesFactory.ts，添加：

    ...
+   import {ExceptionHandlerPackage} from '@react-native-ohos/react-native-exception-handler/ts';

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
    new SamplePackage(ctx),
+   new ExceptionHandlerPackage(ctx)
  ];
}

运行

点击右上角的 sync 按钮

或者在命令行终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

本文档内容基于以下环境验证通过：

RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;

使用示例

下面的代码展示了这个库的基本使用场景：

使用时 import 的库名不变。

import { useState } from "react";
import { View, Button, Text } from "react-native";
import { setJSExceptionHandler } from "react-native-exception-handler";

const App = () => {
  const [result, setResult] = useState('');

  return (
    <View style={{ paddingBottom: 80 }}>
      <View style={{ height: 100, padding: 20 }}>
        <Button onPress={() => {
          setJSExceptionHandler(() => {
            setResult('自定义handler被调用');
          }, false);
          throw new Error('allowedInDevMode=false error');
        }}
          title='setJSExceptionHandler allowedInDevMode=false' />
        <Text>{result}</Text>
      </View>
    </View>
  );
};

接口说明

"Platform"列表示该属性在原三方库上支持的平台。

"OpenHarmony Support"列为 yes 表示 OpenHarmony平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。

API

名称	类型	参数类型	返回值	必填	平台	OpenHarmony平台支持	描述
setJSExceptionHandler	function	customHandler: (error: Error, isFatal: boolean) => void, allowedInDevMode?: boolean	void	No	Android, iOS	Yes	设置 JS 异常处理方法
getJSExceptionHandler	function	/	(error: Error, isFatal: boolean) => void	No	Android, iOS	Yes	获取当前已设置的 JS 异常处理方法
setNativeExceptionHandler	function	customErrorHandler: (exceptionString: string) => void, forceAppQuit?: boolean, executeDefaultHandler?: boolean	void	No	Android, iOS	Yes	设置 native 异常处理方法

遗留问题

无

其他

无

目录结构

/rntpc_react-native-exception-handler        # 项目根目录
├── harmony                                  # HarmonyOS 原生模块目录
│    ├── exception_handler.har               # har 包
│    └── exception_handler                   # 原生库 HAR 模块
│         ├── index.ets                      # 模块入口，导出 ExceptionHandlerPackage
│         ├── ts.ets                         # 导出 ArkTS Package 与 TurboModule
│         └── src/main
│              ├── cpp                       # C++ 侧代码
│              │    ├── CMakeLists.txt       # CMake 构建脚本
│              │    ├── ExceptionHandlerPackage.h       # C++ 侧 Package，注册 TurboModule
│              │    ├── ExceptionHandlerTurboModule.h   # C++ TurboModule 声明
│              │    ├── ExceptionHandlerTurboModule.cpp # C++ TurboModule 实现，桥接 JSI
│              │    └── generated                       # codegen 生成的 C++ 代码
│              ├── ets                       # ArkTS 侧代码
│              │    ├── ExceptionHandlerPackage.ets     # ArkTS 侧 Package 注册
│              │    ├── ExceptionHandlerTurboModule.ets # Native 异常捕获与错误弹窗实现
│              │    └── generated                       # codegen 生成的 ArkTS 代码
├── src                                      # JS/TS 侧代码
│    ├── index.tsx                           # JS 入口，导出异常处理 API
│    └── NativeExceptionHandler.tsx          # TurboModule Spec 接口定义（codegen 输入）
├── README.md                                # 中文安装使用说明
└── README_en.md                             # 英文安装使用说明

贡献代码

使用过程中发现任何问题都可以提交 Issue，当然，也非常欢迎提交 PR 。

开源协议

本项目基于 The MIT License (MIT)，请自由地享受和参与开源。

项目介绍