@react-native-ohos/react-native-wechat-lib
v3.2.0
Published
react native ohos react native wechat lib
Readme
模板版本：v0.4.2
本项目基于 react-native-wechat-lib 开发。
该第三方库的仓库支持直接从 npm 下载，新的包名为：@react-native-ohos/react-native-wechat-lib 版本所属关系如下：
| 三方库名称 | 三方库版本（npm地址） | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | 源码地址 | | ------------ | ------------ |------------------------------ |------------- | ------------- |------------------------ | ------------- | ------------- | | @react-native-ohos/react-native-wechat-lib | ~3.2.0（开发中） | Gitcode Releases | 0.82.* | 是 | API12+ | 3.0.4 | br_rnoh0.82 |
简介
react-native-wechat-lib 组件用于 React Native，应用中接入微信开放能力。
下载安装
进入到工程目录并输入以下命令：
npm
npm install @react-native-ohos/react-native-wechat-libyarn
yarn add @react-native-ohos/react-native-wechat-lib下面的代码展示了这个库的基本使用场景：
[!WARNING] 使用时 import 的库名不变。
[tips] 下面 demo 在使用的过程中，请将 AppID 改为在微信开放平台申请鸿蒙应用的 AppID
import * as React from 'react';
import { StyleSheet, View, Text, Button, Alert } from 'react-native';
import { getApiVersion, registerApp, openWXApp, sendAuthRequest, shareText } from 'react-native-wechat-lib';
export default function App() {
const [versionNumber, setVersionNumber] = React.useState<string | undefined>();
React.useEffect(() => {
registerApp('AppID', 'universalLink').then((res) => {
console.log("registerApp: " + res)
});
}, []);
function onLogin() {
sendAuthRequest('snsapi_userinfo', '')
.then((response: any) => {
Alert.alert('登录成功，code: ' + response.code)
})
.catch(error => {
console.log(error)
let errorCode = Number(error.code);
if (errorCode === -2) {
Alert.alert('已取消授权登录')
} else {
Alert.alert('微信授权登录失败')
}
});
}
function onShareText() {
shareText({
text: 'test content.',
scene: 0
}).then()
}
return (
<View style={styles.container}>
<Text style={styles.title}>Call wechat SDK demo</Text>
<Text style={styles.versionBox}>
Version: {versionNumber}
</Text>
<View style={styles.buttonGroup}>
<View style={styles.button}>
<Button title={'拉起微信'} onPress={() => { openWXApp().then() }} />
</View>
<View style={styles.button}>
<Button title={'授权登录'} onPress={() => { onLogin() }} />
</View>
<View style={styles.button}>
<Button title={'分享'} onPress={() => { onShareText() }} />
</View>
</View>
</View>
);
}
const styles = StyleSheet.create({
container: {
width: '100%',
// flex: 1,
alignItems: 'center',
// justifyContent: 'center',
},
box: {
width: 60,
height: 60,
marginVertical: 20,
},
title: {
marginTop: 48,
fontSize: 24,
color: 'rgba(0, 0, 0, 0.6)',
},
versionBox: {
color: 'rgba(0, 0, 0, 0.6)'
},
buttonGroup: {
width: '100%',
padding: 6,
marginTop: 24,
},
button: {
margin: 6,
}
});Link
| | 是否支持autolink | RN框架版本 | |--------------------------------------|-----------------|------------| | ~3.2.0 | Yes | 0.82 |
使用AutoLink的工程需要根据该文档配置，Autolink框架指导文档：https://gitcode.com/CPF-RN/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md
如您使用的版本支持 Autolink，并且工程已接入 Autolink，可跳过ManualLink配置。
首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony。
1. 在工程根目录的 oh-package.json5 添加 overrides 字段
{
...
"overrides": {
"@rnoh/react-native-openharmony" : "./react_native_openharmony"
}
}2. 引入原生端代码
目前有两种方法：
- 通过 har 包引入（在 IDE 完善相关功能后该方法会被遗弃，目前首选此方法）；
- 直接链接源码。
方法一：通过 har 包引入（推荐）
[!TIP] har 包位于三方库安装路径的
harmony文件夹下。
打开 entry/oh-package.json5，添加以下依赖
"dependencies": {
"@rnoh/react-native-openharmony": "file:../react_native_openharmony",
"@react-native-ohos/react-native-wechat-lib": "file:../../node_modules/@react-native-ohos/react-native-wechat-lib/harmony/react_native_wechat_lib.har"
}点击右上角的 sync 按钮
或者在终端执行：
cd entry
ohpm install方法二：直接链接源码
[!TIP] 如需使用直接链接源码，请参考直接链接源码说明
3. 配置 CMakeLists 和引入 RNWechatLibPackage
打开 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_MODULES}/@react-native-ohos/react-native-wechat-lib/src/main/cpp" ./wechat-lib)
# 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 wechat_lib)
# RNOH_END: manual_package_linking_2打开 entry/src/main/cpp/PackageProvider.cpp，添加：
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "RNWechatLibPackage.h"
using namespace rnoh;
std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
return {
std::make_shared<RNOHGeneratedPackage>(ctx),
std::make_shared<SamplePackage>(ctx),
+ std::make_shared<RNWechatLibPackage>(ctx),
};
}4. 在 ArkTs 侧引入 WechatLibPackage
打开 entry/src/main/ets/RNPackagesFactory.ts，添加：
...
+ import { WechatLibPackage } from '@react-native-ohos/react-native-wechat-lib/ts';
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
new SamplePackage(ctx),
+ new WechatLibPackage(ctx),
];
}必要的配置项
[!TIP] 该模块的内容无法通过autolink自动生成，始终需要手动配置。
1. 配置 EntryAbility（该模块始终需要手动配置）
鸿蒙工程下 EntryAbility，一般位于 entry\src\main\ets\entryability\EntryAbility.ets
import {RNAbility} from '@rnoh/react-native-openharmony';
+ import { AbilityConstant, Want } from '@kit.AbilityKit';
+ import { WechatLibTurboModule } from '@react-native-ohos/react-native-wechat-lib';
export default class EntryAbility extends RNAbility {
+ onCreate(want: Want) {
+ super.onCreate(want)
+ this.handleWeChatCallIfNeed(want)
+ }
getPagePath() {
return 'pages/Index';
}
+ onNewWant(want: Want, _launchParam: AbilityConstant.LaunchParam): void {
+ this.handleWeChatCallIfNeed(want)
+ }
+ private handleWeChatCallIfNeed(want: Want) {
+ WechatLibTurboModule.handleWant(want)
+ }
}
2. 配置 module.json5（该模块始终需要手动配置）
打开 entry/src/main/module.json5，添加：
{
"module": {
"name": "entry",
"type": "entry",
"description": "$string:module_desc",
"mainElement": "EntryAbility",
"deviceTypes": [
"default"
],
+ "querySchemes": [
+ "weixin",
+ ],
"abilities": [
{
"name": "EntryAbility",
"description": "$string:EntryAbility_desc",
"icon": "$media:icon",
"label": "$string:EntryAbility_label",
"startWindowIcon": "$media:icon",
"startWindowBackground": "$color:start_window_background",
"visible": true,
"skills": [
{
"entities": [
"entity.system.home"
],
"actions": [
"action.system.home"
]
},
+ {
+ "actions": [
+ "wxentity.action.open"
+ ]
+ }
],
"srcEntry": "./ets/entryability/EntryAbility.ets",
"orientation": "auto_rotation"
}
]
...
}
}运行
点击右上角的 sync 按钮
或者在终端执行：
cd entry
ohpm install然后编译、运行即可。
约束与限制
兼容性
本文档内容基于以下版本验证通过：
- RNOH: 0.82.7; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM: 6.0.0.328 SP26;
接口说明
[!TIP] "Platform"列表示该属性在原三方库上支持的平台。
[!TIP] "OpenHarmony Support"列为 yes 表示 OpenHarmony平台支持 该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。
API
[!TIP] 移动应用跳转至小程序的规则，请见APP拉起小程序的功能介绍
| Name | Description | Type | Required | Platform | HarmonyOS Support | | --------------------------------------------- | ------------------ | -------- | -------- | ----------- | ----------------- | | registerApp(appid) | 注册 | Function | no | Android/iOS | yes | | isWXAppInstalled() | 判断微信是否已安装 | Function | no | Android/iOS | yes | | isWXAppSupportApi() | 检查支持情况 | Function | no | Android/iOS | no | | getApiVersion() | 获取 API 版本号 | Function | no | Android/iOS | no | | openWXApp() | 打开微信 | Function | no | Android/iOS | yes | | sendAuthRequest([scope[, state]]) | 微信授权登录 | Function | no | Android/iOS | yes | | shareText(ShareTextMetadata) | 分享/收藏 文本 | Function | no | Android/iOS | partially(Session、Timeline) | | shareImage(ShareImageMetadata) | 分享/收藏 图片 | Function | no | Android/iOS | partially(Session、Timeline) | | shareLocalImage(ShareImageMetadata) | 分享/收藏 本地图片 | Function | no | Android/iOS | partially(Session、Timeline) | | shareFile(ShareFileMetadata) | 分享文件 | Function | no | Android/iOS | partially(Session) | | shareMusic(ShareMusicMetadata) | 分享音频 | Function | no | Android/iOS | no | | shareVideo(ShareVideoMetadata) | 分享视频 | Function | no | Android/iOS | partially(Session) | | shareWebpage (ShareWebpageMetadata) | 分享网页 | Function | no | Android/iOS | partially(Session) | | shareMiniProgram(ShareMiniProgramMetadata) | 分享小程序 | Function | no | Android/iOS | partially(Session) | | launchMiniProgram (LaunchMiniProgramMetadata) | 跳到小程序 | Function | no | Android/iOS | yes | | chooseInvoice (ChooseInvoice) | 选择发票 | Function | no | Android/iOS | no | | pay(payload) | 支付 | Function | no | Android/iOS | yes | | subscribeMessage(SubscribeMessageMetadata) | 一次性订阅消息 | Function | no | Android/iOS | yes |
遗留问题
其他
- ShareText、ShareImage、ShareLocalImage、ShareMiniProgram、ShareFile、ShareVideo、ShareWebpage 只支持分享，不支持收藏，原因为目前微信 Open SDK 还不支持 HarmonyOS 平台的收藏
- isWXAppSupportApi、getApiVersion、ShareMusic、ChooseInvoice 这些接口目前在 HarmonyOS 微信 Open SDK 还不支持
目录结构
/rntpc_react-native-wechat-lib # 项目根目录
├── harmony # 鸿蒙适配代码
│ ├── react_native_wechat_lib.har # har 包
│ └── react_native_wechat_lib # 鸿蒙适配核心代码
│ ├── index.ets # 鸿蒙适配代码入口
│ ├── ts.ets # 类型声明入口
│ └── src/main
│ ├── cpp # C++ 桥接代码
│ │ ├── RNWechatLibPackage.h # C++ Package 注册
│ │ ├── CMakeLists.txt # CMake 构建配置
│ │ └── generated # codegen 生成的 TurboModule C++ 胶水代码
│ ├── ets
│ │ ├── WechatLibPackage.ets # ArkTS Package 注册
│ │ ├── WechatLibTurboModule.ets # 微信能力核心实现
│ │ ├── model/WXApiWrap.ets # WXApi 封装
│ │ └── generated # codegen 生成的类型与接口
│ └── resources # 资源文件
├── src # RN 代码
│ ├── index.ts # JS 入口文件，封装 Promise 风格 API
│ └── specs
│ └── NativeRNWechatLibModule.ts # TurboModule Spec 类型定义
├── example # 示例工程（Android/HarmonyOS）
├── README.md # 中文安装使用方法
├── README_en.md # 英文安装使用方法
└── License # 开源协议开源协议
本项目基于 The MIT License (MIT) ，请自由地享受和参与开源。