模板版本:v0.4.0
react-native-smartassets
本项目基于 react-native-smartassets 开发。
该第三方库的仓库已迁移至 Gitcode,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-smartassets。 版本所属关系如下:
| 三方库名称 | 三方库版本 | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | npm地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/react-native-smartassets | ~ 1.0.6 | Gitcode Releases | 0.72.* / 0.82.* | partially(>=1.0.7) | API12+ | 1.0.4 | Npm Address |
| @react-native-oh-tpl/react-native-smartassets | <=1.0.5@deprecated | Github Releases(deprecated) | 0.72.* | 否 | API12+ | 1.0.4 | Npm Address |
1. 安装与使用
进入到工程目录并输入以下命令:
npm
npm install @react-native-ohos/react-native-smartassets
yarn
yarn add @react-native-ohos/react-native-smartassets
下面的代码展示了这个库的基本使用场景:
使用时 import 的库名不变。
import React from 'react';
import { View, Image } from 'react-native';
import { SmartAssets } from 'react-native-smartassets';
export default function App() {
// 在应用启动时初始化 SmartAssets
SmartAssets.initSmartAssets();
return (
<View>
{/* 正常使用 Image 组件,SmartAssets 会自动处理资源加载 */}
<Image
source={require('./assets/images/demo.png')}
style={{ width: 100, height: 100 }}
/>
</View>
);
}
2. Link
| 是否支持autolink | RN框架版本 | |
|---|---|---|
| ~1.0.6 | Partially(>=1.0.7) | 0.72/0.82 |
| <= 1.0.5@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" : "./react_native_openharmony"
}
}
2.2. 引入原生端代码
目前有两种方法:
- 通过 har 包引入;
- 直接链接源码。
方法一:通过 har 包引入(推荐)
har 包位于三方库安装路径的 `harmony` 文件夹下。
打开 entry/oh-package.json5,添加以下依赖
"dependencies": {
"@rnoh/react-native-openharmony": "file:../react_native_openharmony",
"@react-native-ohos/react-native-smartassets": "file:../../node_modules/@react-native-ohos/react-native-smartassets/harmony/smartassets.har"
}
点击右上角的 sync 按钮
或者在命令行终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)
2.3. 配置 CMakeLists 和引入 SmartAssetsPackage
打开 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-smartassets/src/main/cpp" ./smartassets)
# RNOH_END: manual_package_linking_1
# RNOH_BEGIN: manual_package_linking_2
+ target_link_libraries(rnoh_app PUBLIC smartassets)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
+ #include "SmartAssetsPackage.h"
using namespace rnoh;
std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
return {
std::make_shared<RNOHGeneratedPackage>(ctx),
+ std::make_shared<SmartAssetsPackage>(ctx)
};
}
2.4. 在 ArkTs 侧引入 SmartAssetsPackage
打开 entry/src/main/ets/RNPackagesFactory.ets,添加:
...
+ import { SmartAssetsPackage } from '@react-native-ohos/react-native-smartassets';
export function createRNOHPackages(ctx: RNPackageContext): RNOHPackage[] {
return [
+ new SmartAssetsPackage(ctx)
];
}
2.5. 运行
点击右上角的 sync 按钮
或者在命令行终端执行:
cd entry
ohpm install
然后编译、运行即可。
3. 约束与限制
3.1. 兼容性
本文档内容基于以下版本验证通过:
- RNOH: 0.72.32; SDK: HarmonyOS-Next-DB6 5.0.0.61; IDE: DevEco Studio 5.0.3.706; ROM: 3.0.0.61;
- RNOH: 0.82.1; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
4. 静态方法
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| initSmartAssets | 初始化 SmartAssets,设置图片加载 hook | function | yes | iOS/Android | yes |
| initSmartAssetsInner | 内部初始化逻辑,设置资源解析 hook | function | no | iOS/Android | yes |
| setBundlePath | 指定路径查找图片资源 | function | no | iOS/Android | yes |
| setiOSRelateMainBundlePath | 设置 iOS 路径,查找图片资源 | function | no | iOS | no |
5. 遗留问题
6. 其他
setiOSRelateMainBundlePath方法在原三方库中仅支持 iOS 平台,因此 HarmonyOS 平台不支持此方法。
7. 开源协议
本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。