@bingtang-rn/react-native-shake-event for HarmonyOS

本项目基于 react-native-shake-event 开发，为 React Native 鸿蒙（OpenHarmony）适配版本。如果在使用过程中有任何问题，可以在GitCode提Issue，会及时跟进。issue地址：issues。

版本对应关系

| 鸿蒙适配包版本 | 原始库版本 | 支持 RN 版本 | Autolink | 编译 API 版本 | | ------------ | ---------- | ------------ | -------- | ------------- | | 4.0.1 | 4.0.1 | 0.72+ | 是 | API17+ |

安装

npm install @bingtang-rn/react-native-shake-event

使用

import RNShakeEvent from 'react-native-shake-event';

// 注册摇晃监听（单监听器语义：重复调用覆盖前一个）
RNShakeEvent.addEventListener('shake', () => {
  console.log('设备被摇晃');
});

// 移除监听（同时停止加速度计订阅）
RNShakeEvent.removeEventListener('shake');

说明：本模块仅真实设备可用（模拟器无加速度计）。鸿蒙端需声明 ohos.permission.ACCELEROMETER（normal 级 / system_grant，已在库 module.json5 中声明，安装即授予，无需运行时弹窗）。摇晃判定算法对齐 Android com.squareup:seismic ShakeDetector 默认参数（gForce > 2.0g，3 次去抖触发一次）。

Link

| 版本 | 是否支持 Autolink | |------|------------------| | 当前版本 | 是 |

如使用版本支持 Autolink 且工程已接入，可跳过手动配置。

说明：本模块需要同时在 C++ 侧和 ETS 侧注册 Package。

1. Overrides RN SDK

在工程根目录 oh-package.json5 添加：

{
  "overrides": {
    "@rnoh/react-native-openharmony": "./react_native_openharmony"
  }
}

2. 引入原生端依赖

打开 entry/oh-package.json5，添加：

"dependencies": {
  "@bingtang-rn/react-native-shake-event": "file:../../node_modules/@bingtang-rn/react-native-shake-event/harmony/shake_event.har"
}

执行 ohpm install。

3. 配置 CMakeLists

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

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

add_subdirectory("${OH_MODULES}/@bingtang-rn/react-native-shake-event/src/main/cpp" ./shake_event)

target_link_libraries(rnoh_app PUBLIC shake_event)

4. 注册 Package（C++ 侧）

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

#include "ShakeEventPackage.h"

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

5. 注册 Package（ETS 侧）

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

import { ShakeEventPackage } from '@bingtang-rn/react-native-shake-event/ts';

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

属性 / API

| API | 描述 | 参数 | 返回值 | HarmonyOS 支持 | |-----|------|------|--------|----------------| | addEventListener(type, handler) | 注册摇晃监听（单监听器，重复调用覆盖前一个）；harmony 平台触发 TurboModule 实例化并启动加速度计订阅 | type: 'shake', handler: () => void | Listener | ✅ 支持 | | removeEventListener(type, handler?) | 移除监听并停止加速度计订阅；若传入 handler 先回调一次（与原库行为一致） | type: 'shake', handler?: () => void | void | ✅ 支持 |

iOS debug 期挂钩 RN DevMenu（RCTShowDevMenuNotification）属 RN 调试特性，鸿蒙端不实现，仅做生产态“摇晃→发 ShakeEvent 事件”。事件名 ShakeEvent、模块名 RNShakeEvent 与原 Android/iOS 跨层契约一致。

快速验证（运行 Example）

前置条件

| 依赖 | 版本要求 | |------|----------| | Node.js | >= 18 | | DevEco Studio | 5.0+ / 6.0+ | | HarmonyOS SDK | API 17+ |

运行步骤

1. 克隆仓库

git clone <仓库地址>
cd <仓库目录>

2. 安装依赖并构建

npm install --legacy-peer-deps
npm pack           # 生成 tgz 包（会自动触发 prepare 构建 JS 产物）

3. 进入 example 目录，安装依赖

cd example
npm install --legacy-peer-deps

4. 生成 JS Bundle

npm run dev

产物：harmony/entry/src/main/resources/rawfile/bundle.harmony.js

5. 用 DevEco Studio 打开鸿蒙工程

• 打开 DevEco Studio
• 选择 example/harmony 目录
• 等待 Sync 完成

6. 编译并运行 HAP

在 DevEco Studio 中点击运行按钮，将 HAP 安装到设备/模拟器。

注意：Example 中已预置插件依赖和 Package 注册，无需手动配置 Link。

约束与限制

兼容性

• RNOH: 0.72+
• HarmonyOS SDK: API 17+
• DevEco Studio: 5.0+

遗留问题

• 加速度计仅真实设备可用，模拟器无传感器，摇晃事件不会触发（属平台限制，非实现缺陷）。
• iOS debug 期挂钩 RN DevMenu 的调试特性鸿蒙端不实现（属 RN 调试特性，非生产能力）。

开源协议

本项目基于 [原始库协议](原始库 LICENSE 链接)，详见 LICENSE 文件。