From 361438fd974d0df23a39cdab260022de029b5df1 Mon Sep 17 00:00:00 2001 From: huangzongzheng <1518931313@qq.com> Date: Tue, 30 Jul 2024 10:40:14 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20[Issues:=20#IAD81M]=E6=96=B0=E5=A2=9Ere?= =?UTF-8?q?act-native-securerandom=20=E6=8C=87=E5=AF=BC=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- zh-cn/react-native-securerandom.md | 192 +++++++++++++++++++++++++++++ 1 file changed, 192 insertions(+) create mode 100644 zh-cn/react-native-securerandom.md diff --git a/zh-cn/react-native-securerandom.md b/zh-cn/react-native-securerandom.md new file mode 100644 index 00000000..74b1d45a --- /dev/null +++ b/zh-cn/react-native-securerandom.md @@ -0,0 +1,192 @@ +> 模板版本:v0.2.2 + +

+

react-native-securerandom

+

+

+ + Supported platforms + + + License + + +

+ +> [!TIP] [Github 地址](https://github.com/react-native-oh-library/react-native-securerandom) + +## 安装与使用 + +请到三方库的 Releases 发布地址查看配套的版本信息:[@react-native-oh-library/react-native-securerandom Releases](https://github.com/react-native-oh-library/react-native-securerandom/releases),并下载适用版本的 tgz 包。 + +进入到工程目录并输入以下命令: + +>[!TIP] # 处替换为 tgz 包的路径 + + + +#### npm + +```bash +npm install @react-native-oh-tpl/react-native-securerandom@file:# +``` + +#### yarn + +```bash +yarn add @react-native-oh-tpl/react-native-securerandom@file:# +``` + + + +下面的代码展示了这个库的基本使用场景: + +>[!WARNING] 使用时 import 的库名不变。 + +```tsx + +import React, { useState } from "react"; +import { Text, TouchableOpacity, View, TextInput, StyleSheet } from 'react-native'; +import { generateSecureRandom } from 'react-native-securerandom'; + +export default function secureRandomDemo(): JSX.Element { + + const [secureRandom, setSecureRandom] = useState('') + const [size, setSize] = useState('30'); + + return + + {secureRandom} + + + { + setSize(s); + }}> + { + generateSecureRandom(Number(size)).then((myRandom:any) => { + setSecureRandom(`${JSON.stringify(myRandom?.data)}`) + }).catch((err)=>{ + console.log(err,'err') + }) + }} style={styles.btn}> + + secureRandom + + + +} +const styles = StyleSheet.create({ + TextInput: { height: 40, borderColor: '#ccc', borderWidth: 1, borderRadius: 4, width: '90%' }, + btn: { borderRadius: 10, display: 'flex', justifyContent: 'center', alignItems: 'center', padding: 10, margin: 10, backgroundColor: 'blue' }, + btnText: { fontWeight: 'bold', color: '#fff', fontSize: 20 } +}); +``` +### 使用 Codegen + +本库已经适配了 Codegen ,在使用前需要主动执行生成三方库桥接代码,详细请参考 [Codegen](/zh-cn/link-source-code.md) 使用文档。 + +## Link + +目前 HarmonyOS 暂不支持 AutoLink,所以 Link 步骤需要手动配置。 + +首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 `harmony` + +### 在工程根目录的 `oh-package.json` 添加 overrides字段 + +```json +{ + ... + "overrides": { + "@rnoh/react-native-openharmony" : "./react_native_openharmony" + } +} +``` + +### 引入原生端代码 + +目前有两种方法: + +1. 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法); +2. 直接链接源码。 + +方法一:通过 har 包引入(推荐) + +> [!TIP] har 包位于三方库安装路径的 `harmony` 文件夹下。 + +打开 `entry/oh-package.json5`,添加以下依赖 + +```json +"dependencies": { + "@rnoh/react-native-openharmony": "file:../react_native_openharmony", + "@react-native-oh-tpl/react-native-securerandom": "file:../../node_modules/@react-native-oh-tpl/react-native-securerandom/harmony/secure_random.har" + } +``` + +点击右上角的 `sync` 按钮 + +或者在终端执行: + +```bash +cd entry +ohpm install +``` + +方法二:直接链接源码 + +> [!TIP] 如需使用直接链接源码,请参考[直接链接源码说明](/zh-cn/link-source-code.md) + +### 在 ArkTs 侧引入 SecureRandomPackage + +打开 `entry/src/main/ets/RNPackagesFactory.ts`,添加: + +```diff + ... ++ import { SecureRandomPackage } from '@react-native-oh-tpl/react-native-secure_random/ts'; + +export function createRNPackages(ctx: RNPackageContext): RNPackage[] { + return [ + new SamplePackage(ctx), ++ new SecureRandomPackage(ctx) + ]; +} +``` + +### 运行 + +点击右上角的 `sync` 按钮 + +或者在终端执行: + +```bash +cd entry +ohpm install +``` + +然后编译、运行即可。 + +## 约束与限制 + +### 兼容性 + +要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。 + +请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息:[@react-native-oh-library/react-native-securerandom Releases](https://github.com/react-native-oh-library/react-native-securerandom/releases) + + +## API + +> [!Tip] "Platform"列表示该属性在原三方库上支持的平台。 + +> [!Tip] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。 + + +| Name | Description | Type | Required | Platform | HarmonyOS Support | +|----------------|-------------------------------| -- | -------- | ----------- | ----------------- | +| generateSecureRandom | A library to generate cryptographically-secure random byte. | Function | No | ios/Android | yes | + +## 其他 + +## 开源协议 + +本项目基于 [The MIT License (MIT)](https://github.com/robhogan/react-native-securerandom/blob/main/LICENSE) ,请自由地享受和参与开源。 -- Gitee