一款使用react-native 加载Harmony OS Svga动画开源插件

yrjw
212 阅读3分钟

这是一款使用 ReactNative 加载HarmonyOS Svga 动画的播放器插件 三端 Svga 动画统一使用点击这里

版本：latest

react-native-ohos-svgaplayer

License

[!TIP] Github 地址

安装与使用

npm
npm install react-native-ohos-svgaplayer
yarn
yarn add react-native-ohos-svgaplayer

API 参考

Props

属性类型默认值描述
sourceSvgaSource-SVGA 文件源
autoPlaybooleantrue是否自动播放
loopsnumber0循环播放次数，默认值：0 表示无限循环
clearsAfterStopbooleantrue动画停止后是否清空画布
fillMode'Forward' | 'Backward''Forward'填充模式：Forward 停留在最后一帧，Backward 回到第一帧
onFinishedfunction-播放完成时的回调函数
onFramefunction-帧变化时的回调函数
onPercentagefunction-播放进度变化时的回调函数

Ref 方法

方法描述
startAnimation()从第 0 帧开始播放动画
startAnimationWithRange(location, length, reverse)在指定范围内播放动画，可选择反向播放
pauseAnimation()暂停动画，停留在当前帧
stopAnimation()停止动画，根据 clearsAfterStop 决定是否清空画布
stepToFrame(frame, andPlay)跳转到指定帧，可选择是否从该帧开始播放
stepToPercentage(percentage, andPlay)跳转到指定百分比位置 (0.0-1.0)，可选择是否播放

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

[!WARNING] 使用时 import 的库名不变。alias: react-native-svga-player 主要是统一 android/ios import 导入

import { RNSvgaPlayer } from 'react-native-svga-player';
<RNSvgaPlayer
  style={{ width: 200, height: 200 }}
  source={`https://raw.githubusercontent.com/yyued/SVGAPlayer-iOS/master/SVGAPlayer/Samples/Goddess.svga`}
/>;

更多详情用法参考 三端 Svga 动画统一使用点击这里

Link

目前 HarmonyOS 暂不支持 AutoLink，所以 Link 步骤需要手动配置。

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

1.在工程根目录的 oh-package.json5 添加 overrides 字段

{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony": "file:../libs/react_native_openharmony_release.har"

  }
}

2.引入原生端代码 ，目前有两种方法：

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

方法一：通过 har 包引入（推荐）

[!TIP] har 包位于三方库安装路径的 harmony 文件夹下。

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

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../libs/react_native_openharmony_release.har"
    "@react-native-ohos/react-native-svga-player": "file:../../node_modules/react-native-ohos-svgaplayer/harmony/svgaplayer.har",
  },

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

[!TIP] 从 react-native-ohos-svga-player 获取到 svgaplayer 源码文件，直接在 harmony 工程中通过 File->New->Import->Import Module 导入即可 主工程entry/oh-package.json5中添加

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../libs/react_native_openharmony_release.har"
    "@react-native-ohos/react-native-svga-player": "file:../svgaplayer",

  }

3.配置 CMakeLists 和引入 SvgaPlayerPackage

打开 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(OH_MODULE_DIR "${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-svga-player/src/main/cpp" ./svgaplayer)

# 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_svgaplayer)

# RNOH_END: manual_package_linking_2

#三方包得加上folly编译配置
+ target_compile_options(rnoh_svgaplayer PUBLIC ${folly_compile_options})

打开 entry/src/main/cpp/PackageProvider.cpp，添加：

#include "RNOH/PackageProvider.h"
#include "SamplePackage.h"
+ #include "SvgaPlayerPackage.h"

using namespace rnoh;

std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
    return {
      std::make_shared<SamplePackage>(ctx),
+     std::make_shared<SvgaPlayerPackage>(ctx),

    };
}

4.在 ArkTs 侧引入 SvgaPlayerView 组件

找到 function buildCustomComponent()，一般位于 entry/src/main/ets/pages/index.ets 或 entry/src/main/ets/rn/LoadBundle.ets，添加：

+ import { SvgaPlayerView } from '@react-native-ohos/react-native-svga-player';

@Builder
function buildCustomComponent(ctx: ComponentBuilderContext) {
+  if (ctx.componentName === SvgaPlayerView.NAME) {
+   SvgaPlayerView({
+     ctx: ctx.rnComponentContext,
+     tag: ctx.tag
+   })
+ }
 ...
}
...

[!TIP] 本库使用了混合方案，需要添加组件名。

在entry/src/main/ets/pages/index.ets 或 entry/src/main/ets/rn/LoadBundle.ets 找到常量 arkTsComponentNames 在其数组里添加组件名

const arkTsComponentNames: Array<string> = [
  SampleView.NAME,
  GeneratedSampleView.NAME,
  PropsDisplayer.NAME,
+ SvgaPlayerView.NAME
  ];

5.在 ArkTs 侧引入 WebViewPackage

打开 entry/src/main/ets/RNPackagesFactory.ts，添加：

import type {RNPackageContext, RNPackage} from 'rnoh/ts';
import {SamplePackage} from 'rnoh-sample-package/ts';
+ import { SvgaPlayerPackage } from '@react-native-ohos/react-native-svga-player';

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

  ];
}

6.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

开源不易，希望您可以动一动小手点点小 ⭐⭐
👴 希望大家如有好的需求踊跃提交,如有问题请提交 issue，空闲时间会扩充与修复优化

开源协议

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

avatar
文章
阅读
粉丝