模板版本:v0.4.0

react-native-keys

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

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

三方库名称 三方库版本 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 npm地址
@react-native-ohos/react-native-keys 0.9.0 Gitcode Releases 0.82.* API12+ 0.7.13 Npm Address
@react-native-ohos/react-native-keys 0.8.0 Gitcode Releases 0.77.* API12+ 0.7.10 Npm Address
@react-native-ohos/react-native-keys 0.7.12 Gitcode Releases 0.72.* API12+ 0.7.10 Npm Address
@react-native-oh-tpl/react-native-keys <= 0.7.11@deprecated Github Releases(deprecated) 0.72.* API12+ 0.7.10 Npm Address

1. 安装与使用

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

npm

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

yarn

yarn add @react-native-ohos/react-native-keys

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

使用时 import 的库名不变。

  1. 在React Native应用的根目录下创建一个新文件keys.development.json,并在secure object中添加受保护的变量Envs,并在public中添加Envs以供公共使用:
{
  "secure": {
    "GOOGLE_API": "ABCD",
    "BRANCH_API": "ABCDEF"
  },
  "public": {
    "APP_NAME": "Keys Example",
    "BUNDLE_ID": "com.example.rnkeys.dev",
    "ANDROID_CODE": "50",
    "PACKAGE_ID": "com.example.rnkeys.dev"
  }
}

  1. 使用公钥 & 安全钥匙
import Keys from 'react-native-keys';

Keys.API_URL;
Keys.URI_SCHEME;

Keys.secureFor('API_TOKEN');
Keys.secureFor('GOOGLE_API_KEY');
Keys.secureFor('SECRET_KEY');

是否支持autolink RN框架版本
~0.9.0 Yes 0.82
~0.8.0 No 0.77
~0.7.12 Yes 0.72
<= 0.7.11@deprecated No 0.72

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

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

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

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

2.1. Overrides RN SDK

为了让工程依赖同一个版本的 RN SDK,需要在工程根目录的 oh-package.json5 添加 overrides 字段,指向工程需要使用的 RN SDK 版本。替换的版本既可以是一个具体的版本号,也可以是一个模糊版本,还可以是本地存在的 HAR 包或源码目录。

关于该字段的作用请阅读官方说明

{
  "overrides": {
    "@rnoh/react-native-openharmony": "^0.72.38" // ohpm 在线版本
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony.har" // 指向本地 har 包的路径
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony" // 指向源码路径
  }
}

2.2. 引入原生端代码

目前有两种方法:

  • 通过 har 包引入;
  • 直接链接源码。

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

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

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

"dependencies": {
    "@react-native-ohos/react-native-keys": "file:../../node_modules/@react-native-ohos/react-native-keys/harmony/rnoh_keys.har"
  }

点击右上角的 sync 按钮

或者在命令行终端执行:

cd entry
ohpm install

方法二:直接链接源码

如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)

2.3. 配置 CMakeLists 和引入 RNOHKeysPackage

若使用的是 <= 0.7.11 版本,请跳过本章。

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

+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")

# RNOH_BEGIN: manual_package_linking_1
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/react-native-keys/src/main/cpp" ./rnohkeys)
# RNOH_END: manual_package_linking_1

# RNOH_BEGIN: manual_package_linking_2
+ target_link_libraries(rnoh_app PUBLIC rnoh_keys)
# RNOH_END: manual_package_linking_2

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

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
+ #include "RNKeysPackage.h"

using namespace rnoh;

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

2.4. 在 ArkTs 侧引入 RNKeysPackage

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

  ...
+ import { RNKeysPackage } from '@react-native-ohos/react-native-keys';

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

必要的配置项

该模块的内容无法通过autolink自动生成,始终需要手动配置。

在 DevEco 创建运行前script(生成加解密代码和编译配置文件)

如下步骤中添加配置完成时记得点击Apply按钮让配置生效

  1. 点击右上角 entry -> Edit Configurations... 打开配置面板
  2. 点击面板左上角 + , 选择Shell Script, 打开新建 script的配置面板, 按如下图片提示进行配置
    shell script config
  3. 配置entry -> Before launch,点击加号选择 Run Another Configuration, 选择上一步配置的 Shell Script, 并将配置拖动到Hvigor-Build Make上方
    entry config

2.5. 运行

点击右上角的 sync 按钮

或者在命令行终端执行:

cd entry
ohpm install

然后编译、运行即可。

3. 约束与限制

3.1. 兼容性

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

  1. RNOH: 0.82.0; SDK: HarmonyOS 6.1.0 Release SDK; IDE: DevEco Studio 6.0.2.636; ROM: 6.1.0.117;
  2. RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  3. RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  4. RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio 5.0.3.900; ROM: Next.0.0.71;

4. 属性

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

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

Name Description Type Required Platform HarmonyOS Support
Keys attributes Get public value object no iOS/Android yes
Keys.publicKeys Get all public value function no iOS/Android yes
Keys.secureFor Get secret value function no iOS/Android yes

5. 遗留问题

6. 其他

7. 开源协议

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