rntpc_react-native-restart:基于 React Native 的应用重启工具项目

基于 react-native-restart 的 OpenHarmony 适配版,运行时重启/重载应用

分支4Tags4
文件最后提交记录最后更新时间
14 天前
14 天前
11 个月前
11 个月前
6 年前
6 年前
6 年前
3 年前
6 年前
11 个月前
1 个月前
3 年前
14 天前
11 个月前
6 年前
6 年前
1 个月前
8 小时前
8 小时前
3 年前
1 个月前
3 年前
11 个月前
14 天前
3 年前

文档模板:v0.4.2

react-native-restart

本项目基于 react-native-restart 开发。

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

三方库名称 三方库版本(npm地址) 发布信息 支持RN版本 AutoLink 编译API版本 社区基线版本 源码地址
@react-native-ohos/react-native-restart ~ 0.2.0(开发中) Gitcode Releases 0.82.* API12+ 0.0.27 br_rnoh0.82

简介

react-native-restart 是 React Native 生态中一个轻量且关键的原生模块(Native Module)。它的核心功能是在应用运行时,强制重启整个 React Native 应用进程,从而实现类似“热重启”(Hot Restart)的效果。

下载安装

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

npm

npm install @react-native-ohos/react-native-restart

yarn

yarn add @react-native-ohos/react-native-restart
是否支持autolink RN框架版本
~0.2.0 Yes 0.82

使用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. 引入原生端代码

目前有两种方法:

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

方法一:通过 har 包引入(推荐)

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

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

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
   	"@react-native-ohos/react-native-restart": "file:../../node_modules/@react-native-ohos/react-native-restart/harmony/rn_restart.har",
  }

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

方法二:直接链接源码

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

3. 配置CMakeLists 和引入 RestartPackage

若使用的是 <= 0.0.27-0.0.3 版本,请跳过本章。

打开 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-restart/src/main/cpp" ./restart)
# 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_restart)
# RNOH_END: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp,添加:

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "RestartPackage.h"

using namespace rnoh;

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

4. 在 ArkTs 侧引入 RNRestartPackage

打开 entry/src/main/ets/RNPackagesFactory.ts,添加:

import type { RNPackageContext, RNPackage } from "rnoh/ts";
import { SamplePackage } from "rnoh-sample-package/ts";
+ import { RNRestartPackage } from '@react-native-ohos/react-native-restart/ts';

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

运行

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

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

  1. RNOH: 0.82.22; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.878; ROM: 6.0.0.130;

使用示例

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

使用时 import 的库名不变。

import { useState } from "react";
import { StyleSheet, Text } from "react-native";
import RNRestart from "react-native-restart";
import { Tester, TestSuite, TestCase } from "@rnoh/testerino";

export default function RestartDemo() {
  const [restartReason, setRestartReason] = useState("");

  return (
    <Tester>
      <TestSuite name="restart">
        <TestCase tags={["C_API"]} itShould="restart">
          <Text
            style={styles.button}
            onPress={() => RNRestart.restart("restart_a")}
          >
            restart
          </Text>
        </TestCase>
        <TestCase
          tags={["C_API"]}
          itShould="getReason"
          initialState={"reason"}
          arrange={({ setState }) => {
            return (
              <Text
                style={styles.button}
                onPress={async () => {
                  try {
                    const reason = await RNRestart.getReason();
                    setRestartReason(reason);
                    setState(reason);
                  } catch (e) {
                    setRestartReason("");
                    setState("");
                  }
                }}
              >
                getReason{restartReason ? `(原因:${restartReason})` : ""}
              </Text>
            );
          }}
          assert={async ({ expect, state }) => {
            expect(state).include("restart_");
          }}
        />
      </TestSuite>
    </Tester>
  );
}

const styles = StyleSheet.create({
  button: {
    paddingVertical: 6,
    paddingHorizontal: 12,
    backgroundColor: "hsl(193, 95%, 68%)",
    borderWidth: 2,
    borderColor: "hsl(193, 95%, 30%)",
  },
});

接口说明

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

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

API

Name Description Type Required Platform HarmonyOS Support
restart 重启RN工程 Function no All yes
getReason 获取重启原因 Function no All yes

遗留问题

其他

目录结构

/rntpc_react-native-restart  # 项目根目录
├── harmony              # 鸿蒙适配代码
│    └─ rn_restart.har          # har包
│    └─ restart                  # 鸿蒙适配核心代码
│          └─ Index.ets    # 鸿蒙适配代码入口    
│          └─ src/main/ets  
│              └─ RNRestartTurboModule.ts  # Restart核心实现   
├── src                  # RN代码
│    └─ index.tsx  # 入口文件 
│    └─ NativeRestart.ts 类型文件          
├── README_en.md           # 英文安装使用方法    
├── README.md   # 中文安装使用方法                    

贡献代码

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

开源协议

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

项目介绍

基于 react-native-restart 的 OpenHarmony 适配版,运行时重启/重载应用

定制我的领域