模板版本:v0.4.0
react-native-quick-base64
本项目基于 react-native-quick-base64 开发。
该第三方库支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-quick-base64 版本所属关系如下:
| 三方库名称 | 三方库版本 | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | npm地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/react-native-quick-base64 | ~2.3.0 | Github Releases | 0.82.* | 是 | API12+ | 2.2.2 | Npm Address |
| @react-native-ohos/react-native-quick-base64 | ~2.2.0 | Github Releases | 0.77.* | 否 | API12+ | 2.1.2 | Npm Address |
| @react-native-ohos/react-native-quick-base64 | ~2.1.3 | Github Releases | 0.72.* | 是 | API12+ | 2.1.2 | Npm Address |
| @react-native-oh-tpl/react-native-quick-base64 | <=2.1.2-1.0.1@deprecated | Github Releases(deprecated) | 0.72.* | 否 | API12+ | 2.1.2 | Npm Address |
1. 安装与使用
进入到工程目录并输入以下命令:
npm
npm install @react-native-ohos/react-native-quick-base64
yarn
yarn add @react-native-ohos/react-native-quick-base64
下面的代码展示了这个库的基本使用场景:
使用时 import 的库名不变。
import React from 'react';
import { Text, View, TextInput, ScrollView, StyleSheet, Button } from 'react-native';
import { byteLength, btoa, trimBase64Padding } from 'react-native-quick-base64';
export function QuickBase64Test() {
// Test string to base64 conversion
const [textTobase64, onChangeTextToBase64] = React.useState('');
const [testText, onChangeTestText] = React.useState('');
const [base64ToTextLength, onChangeBase64TextLength] = React.useState(0);
const [trimBase64PaddingText, onChangeTrimBase64PaddingText] = React.useState('');
// Click event: string to base64
const onPressBtoA = (text: string) => {
try {
let b64 = btoa(text);
console.log(`String to base64 ${b64}`);
onChangeTextToBase64(b64);
} catch (e) {
console.error(`btoa error: ${e}`);
}
}
// Print the length of base64 converted to Uint8Array byte array
const onPressBase64Length = (text: string) => {
try {
console.log(`Print base64 length ${text}`);
onChangeBase64TextLength(byteLength(text));
} catch (e) {
console.error(`byteLength error: ${e}`);
}
}
/* trimBase64Padding: Remove padding characters from Base64 string */
const onPressTrimBase64Padding = (text: string) => {
try {
let trimBase64 = trimBase64Padding(text);
console.log(`trimBase64Padding ${trimBase64}`);
onChangeTrimBase64PaddingText(trimBase64);
} catch (e) {
console.error(`trimBase64Padding error: ${e}`);
}
}
return (
<ScrollView>
<View style={styles.mainContainer}>
<View>
<TextInput
style={{ height: 40, borderColor: '#978081', borderWidth: 1, width: 300, marginBottom: 20, backgroundColor: '#f5f5f5' }}
onChangeText={(text) => onChangeTestText(text)}
placeholder="please input test text"
placeholderTextColor={'#674651'}
value={testText}
/>
</View>
<Text>BtoA Encodes a character string into a Base64 character string.</Text>
<View style={{ display: 'flex', flexDirection: 'column', marginBottom: 10 }}>
<Text>test string transform base64, testing the text: {testText}</Text>
<Button
title="BtoA"
onPress={() => { onPressBtoA(testText) }}
/>
<Text style={{ color: 'green' }}>{(textTobase64)}</Text>
</View>
<Text>Takes a base64 string and returns the length of the byte array.</Text>
<View style={{ display: 'flex', flexDirection: 'column', marginBottom: 10 }}>
<Text>get Uint8Array length from base64 transform, testing the text: {textTobase64}</Text>
<Button
title="base64ToTextLength"
onPress={() => { onPressBase64Length(textTobase64) }}
/>
<Text style={{ color: 'green' }}>{(base64ToTextLength)}</Text>
</View>
{/* trimBase64Padding: Remove padding characters from Base64 string */}
<Text>trimBase64Padding.</Text>
<View style={{ display: 'flex', flexDirection: 'column', marginBottom: 10 }}>
<Text>trimBase64Padding clears the padding characters of a Base64 string, testing the text: {textTobase64}</Text>
<Button title="test trimBase64Padding" onPress={() => { onPressTrimBase64Padding(textTobase64) }} />
<Text style={{ color: 'green' }}>{trimBase64PaddingText}</Text>
</View>
</View>
</ScrollView>
);
}
const styles = StyleSheet.create({
mainContainer: {
flex: 1,
paddingTop: 20,
paddingLeft: 20,
paddingRight: 20,
paddingBottom: 20,
backgroundColor: '#f5f5f5',
color: '#674651',
},
});
使用 Codegen
本库已经适配了 Codegen ,在使用前需要主动执行生成三方库桥接代码,详细请参考 Codegen 文档。
2. Link
| 是否支持autolink | RN框架版本 | |
|---|---|---|
| ~2.3.0 | Yes | 0.82 |
| ~2.2.0 | No | 0.77 |
| ~2.1.3 | Yes | 0.72 |
| <= 2.1.2-1.0.1@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. 在工程根目录的 oh-package.json5 添加 overrides 字段
{
...
"overrides": {
"@rnoh/react-native-openharmony" : "./react_native_openharmony"
}
}
2.2. 引入原生端代码
目前有两种方法:
- 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法);
- 直接链接源码。
方法一:通过 har 包引入(推荐)
har 包位于三方库安装路径的 `harmony` 文件夹下。
打开 entry/oh-package.json5,添加以下依赖
"dependencies": {
"@rnoh/react-native-openharmony": "file:../react_native_openharmony",
"@react-native-ohos/react-native-quick-base64": "file:../../node_modules/@react-native-ohos/react-native-quick-base64/harmony/rn_quick_base64.har"
}
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)
2.3. 配置 CMakeLists 和引入 RNQuickBase64Package
若使用的是 <=2.1.2-1.0.1 版本,请跳过本章。
打开 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_MODULE_DIR}/@react-native-ohos/react-native-quick-base64/src/main/cpp" ./rn_quick_base64)
# 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_quick_base64)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "SamplePackage.h"
+ #include "RNQuickBase64Package.h"
using namespace rnoh;
std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
return {
std::make_shared<SamplePackage>(ctx),
+ std::make_shared<RNQuickBase64Package>(ctx)
};
}
2.4. 在 ArkTs 侧引入 RNQuickBase64Package Package
打开 entry/src/main/ets/RNPackagesFactory.ts,添加:
+ import { RNQuickBase64Package } from '@react-native-ohos/react-native-quick-base64/ts';
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
new SamplePackage(ctx),
+ new RNQuickBase64Package(ctx),
];
}
2.5. 运行
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
然后编译、运行即可。
3. 约束与限制
3.1. 兼容性
本文档内容基于以下环境验证通过:
- 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;
- RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
- RNOH: 0.82.22; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.878; ROM: 6.0.0.130;
4. 静态方法
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
| NAME | Description | TYPE | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| btoa | 将字符串编码为 base64 格式。 | Function | no | All | yes |
| atob | 解码一个 base64 编码的字符串。 | Function | no | All | yes |
| toByteArray | 接收一个 base64 字符串并返回一个字节数组。可选参数 removeLinebreaks 用于移除所有 \n 字符。 |
Function | no | All | yes |
| byteLength | 接收一个 base64 字符串并返回其字节数组的长度。 | Function | no | All | yes |
| fromByteArray | 接收一个字节数组并返回一个 base64 字符串。可选参数 urlSafe 设为 true 时,将使用 URL 安全的字符集。 |
Function | no | All | yes |
| shim | 将 btoa 和 atob 函数添加到 global 全局对象中。 |
Function | no | All | yes |
| trimBase64Padding | 去除 base64 编码字符串末尾的 = 填充字符。同时,对于 base64url 编码的字符串,它也会去除末尾的 . 字符。 |
Function | no | All | yes |
| getNative | 获取原生的 base64ToArrayBuffer 和 base64FromArrayBuffer 函数。 | Function | no | All | yes |
5. 遗留问题
6. 其他
7. 开源协议
本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。