Skip to content

Latest commit

 

History

History
289 lines (209 loc) · 9.34 KB

react-native-exception-handler.md

File metadata and controls

289 lines (209 loc) · 9.34 KB

模板版本：v0.2.2

react-native-exception-handler

Supported platforms License

[!TIP] Github 地址

安装与使用

请到三方库的 Releases 发布地址查看配套的版本信息：@react-native-oh-tpl/react-native-exception-handler Releases 。对于未发布到npm的旧版本，请参考安装指南安装tgz包。

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

npm

npm install @react-native-oh-tpl/react-native-exception-handler

yarn

yarn add @react-native-oh-tpl/react-native-exception-handler

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

[!WARNING] 使用时 import 的库名不变。

To catch JS_Exceptions

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

export const ReactNativeExceptionHandler = () => {

    const exceptionhandler = (error, isFatal) => {
        // your error handler function
    };

    const setJSExceptionHandlerClick = () => {
        setJSExceptionHandler(exceptionhandler, true);
    }

    const getJSExceptionHandlerClick = () => {
        // getJSExceptionHandler gives the currently set JS exception handler
        const currentHandler = getJSExceptionHandler();
    }

    return (
        <View style={{ flexDirection: "column", justifyContent: "space-between" }}>
            <Button
                title="setJSExceptionHandler"
                onPress={setJSExceptionHandlerClick}
            />
            <Button
                title="getJSExceptionHandler"
                onPress={getJSExceptionHandlerClick}
            />
        </View>
    );
};

To catch Native_Exceptions

import { View, Button } from "react-native";
import { setNativeExceptionHandler } from "react-native-exception-handler";

export const ReactNativeExceptionHandler = () => {

    const exceptionhandler = (exceptionString) => {
        // your exception handler code here
    };

    const setNativeExceptionHandlerClick = () => {
        setNativeExceptionHandler(
            exceptionhandler,
            forceAppQuit,
            executeDefaultHandler
        );
        // - exceptionhandler is the exception handler function
        // - forceAppQuit is an optional ANDROID specific parameter that defines
        //    if the app should be force quit on error.  default value is true.
        //    To see usecase check the common issues section.
        // - executeDefaultHandler is an optional boolean (both IOS, ANDROID)
        //    It executes previous exception handlers if set by some other module.
        //    It will come handy when you use any other crash analytics module along with this one
        //    Default value is set to false. Set to true if you are using other analytics modules.
    }

    return (
        <View style={{ flexDirection: "column", justifyContent: "space-between" }}>
            <Button
                title="setNativeExceptionHandler"
                onPress={setNativeExceptionHandlerClick}
            />
        </View>
    );
};

Link

目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。

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

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

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

2.引入原生端代码

目前有两种方法：

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

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

[!TIP] har 包位于三方库安装路径的 harmony 文件夹下。

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

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

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

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

[!TIP] 如需使用直接链接源码，请参考直接链接源码说明

3.配置 CMakeLists 和引入 ExceptionHandlerPackage

打开 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-oh-tpl/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-oh-tpl/react-native-exception-handler/ts';

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

5.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和 手机 ROM。

请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：@react-native-oh-tpl/reace-native-exception-handler Releases

静态方法

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

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

Name Description Type Required Platform HarmonyOS Support
setJSExceptionHandler 设置 JS 异常处理方法 function no Android, iOS yes
getJSExceptionHandler 获取 JS 异常处理方法 function no Android, iOS yes

API

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

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

Name Description Type Required Platform HarmonyOS Support
setNativeExceptionHandler 设置 native 异常处理方法 function no Android, iOS yes

遗留问题

其他

开源协议

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