模板版本:v0.4.0
react-native-http-bridge
本项目基于 react-native-http-bridge 开发。
请到三方库的 Releases 发布地址查看配套的版本信息:@react-native-ohos/react-native-http-bridge Releases。对于未发布到npm的旧版本,请参考安装指南安装tgz包。
| 三方库名称 | 三方库版本 | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | npm地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/react-native-http-bridge | ~0.8.0 | GitCode Releases | 0.82.* | 是 | API12+ | 0.6.1 | Npm Address |
| @react-native-ohos/react-native-http-bridge | ~0.7.0 | GitCode Releases | 0.77.* | 否 | API12+ | 0.6.1 | Npm Address |
| @react-native-ohos/react-native-http-bridge | ~0.6.2 | GitCode Releases | 0.72.* | 是 | API12+ | 0.6.1 | Npm Address |
| @react-native-oh-tpl/react-native-http-bridge | <=0.6.1-0.0.4@deprecated | Github Releases(deprecated) | 0.72.* | 否 | API12+ | 0.6.1 | Npm Address |
1. 安装与使用
进入到工程目录并输入以下命令:
npm
npm install @react-native-ohos/react-native-http-bridge
yarn
yarn add @react-native-ohos/react-native-http-bridge
下面的代码展示了这个库的基本使用场景:
使用时 import 的库名不变。
import React, { useState ,useEffect } from "react";
import { ScrollView, Text, Button, View, StyleSheet } from 'react-native';
var httpBridge = require('react-native-http-bridge');
const HttpBridgeDemo = () => {
const [getRequestResult, setGetRequestResult] = useState('');
const [postRequestResult, setPostRequestResult] = useState('');
const GetMothedExample = () => {
fetch('http://127.0.0.1:8888/student/getStuInfo?value=GET', {
method: 'GET',
headers: {
'Content-Type': 'application/json',
}
})
}
const PostMothedExample = () => {
fetch('http://127.0.0.1:8888/student/postStuInfo', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
firstParam: 'yourValue',
secondParam: 'yourOtherValue',
})
})
}
useEffect(() => {
httpBridge.start(8888, 'http_service', (request: any) => {
switch (request.type) {
case 'GET':
setGetRequestResult('requestId: ' + request.requestId + '\ntype: ' +
request.type + '\nurl: ' + request.url + '\npostData: ' + request.postData);
break;
case 'POST':
setPostRequestResult('requestId: ' + request.requestId + '\ntype: ' +
request.type + '\nurl: ' + request.url + '\npostData: ' + request.postData);
break;
}
if (request.type === "GET" && request.url.split("/")[1] === "user") {
httpBridge.respond(request.requestId, 200, "application/json", "{\"message\": \"OK\"}");
} else {
httpBridge.respond(request.requestId, 400, "application/json", "{\"message\": \"Bad Request\"}");
}
});
return () => {
httpBridge.stop();
}
}, []);
return (
<ScrollView>
<View>
<Text style={styles.text}>httpBridgeExample Port : 8888</Text>
<View>
<Text style={styles.text}>Method:GET</Text>
<Button
title="GET"
color="#9a73ef"
onPress={GetMothedExample}
/>
<Text style={styles.result} allowFontScaling>{getRequestResult}</Text>
</View>
<View>
<Text style={styles.text}>Method:POST</Text>
<Button
title="POST"
color="#9a73ef"
onPress={PostMothedExample}
/>
<Text style={styles.result} allowFontScaling>{postRequestResult}</Text>
</View>
</View>
</ScrollView>
)
};
const styles = StyleSheet.create({
text: {
fontSize: 18,
marginBottom: 10,
color: 'red',
},
result: {
marginTop: 10,
fontSize: 18,
marginBottom: 10,
color: 'white',
}
});
export default HttpBridgeDemo;
2. Link
| 是否支持autolink | RN框架版本 | |
|---|---|---|
| ~0.8.0 | Yes | 0.82 |
| ~0.7.0 | No | 0.77 |
| ~0.6.2 | Yes | 0.72 |
| <= 0.6.1-0.0.4@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.json 添加 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-http-bridge": "file:../../node_modules/@react-native-ohos/react-native-http-bridge/harmony/http_bridge.har"
}
点击右上角的 sync 按钮
或者在终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)
2.3. 配置 CMakeLists 和引入 HttpBridgePackage
若使用的是 <=0.6.1-0.0.4 版本,请跳过本章。
打开 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-http-bridge/src/main/cpp" ./http_bridge)
# 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_http_bridge)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "HttpBridgePackage.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<HttpBridgePackage>(ctx)
};
}
2.4. 在 ArkTs 侧引入 RNHttpBridgePackage
打开 entry/src/main/ets/RNPackagesFactory.ts,添加:
...
+ import { RNHttpBridgePackage } from "@react-native-ohos/react-native-http-bridge/ts";
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
new SamplePackage(ctx),
+ new RNHttpBridgePackage(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.1; SDK: HarmonyOS 6.0.1 Release SDK; IDE: DevEco Studio 6.0.1 Release; ROM:6.0.0.130 SP8;
3.2. 权限要求
3.2.1. 在 entry 目录下的module.json5中添加权限
打开 entry/src/main/module.json5,添加:
...
"requestPermissions": [
+ {
+ "name": "ohos.permission.KEEP_BACKGROUND_RUNNING",
+ "reason": "$string:app_name",
+ "usedScene": {
+ "abilities": [
+ "FormAbility"
+ ],
+ "when": "always"
+ }
+ },
]
4. API
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| start | 启动 HTTP 服务器 | callback | no | Android/iOS | Yes |
| respond | 服务器响应结果 | void | no | Android/iOS | Yes |
| stop | 停止 HTTP 服务器 | void | no | Android/iOS | Yes |
4.1. start
start(port:number, serviceName:string, callback): void;
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| port | HTTP 服务器端口号 | number | Yes | iOS/Android | Yes |
| serviceName | HTTP 服务器名称 | string | Yes | iOS/Android | Yes |
4.2. respond
respond(requestId:string, code:number, type:string, body:string): void;
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| requestId | HTTP 服务器请求 ID | string | Yes | iOS/Android | Yes |
| code | 服务器响应状态码 | number | Yes | iOS/Android | Yes |
| type | 服务器响应中的 Content-Type |
string | Yes | iOS/Android | Yes |
| body | 服务器响应体 | string | Yes | iOS/Android | Yes |
5. 遗留问题
6. 其他
7. 开源协议
本项目基于The MIT License(MIT) ,请自由地享受和参与开源。