模板版本:v0.4.0
react-native-network-info
本项目基于 react-native-network-info 开发。
该第三方库的仓库已迁移至 Gitcode,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-network-info。 版本所属关系如下:
| 三方库名称 | 三方库版本 | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | npm地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/react-native-network-info | ~ 5.4.0 | Gitcode Releases | 0.82.* | 是 | API12+ | 5.2.1 | Npm Address |
| @react-native-ohos/react-native-network-info | ~ 5.3.0 | Gitcode Releases | 0.77.* | 否 | API12+ | 5.2.1 | Npm Address |
| @react-native-ohos/react-native-network-info | ~ 5.2.2 | Gitcode Releases | 0.72.* | 是 | API12+ | 5.2.1 | Npm Address |
| @react-native-oh-tpl/react-native-network-info | <= 5.2.1-0.0.1@deprecated | Github Releases(deprecated) | 0.72.* | 否 | API12+ | 5.2.1 | Npm Address |
1. 安装与使用
进入到工程目录并输入以下命令:
npm
npm install @react-native-ohos/react-native-network-info
yarn
yarn add @react-native-ohos/react-native-network-info
下面的代码展示了这个库的基本使用场景:
使用时 import 的库名不变。
import React, {useState} from 'react';
import {
View,
Text,
StyleSheet,
ScrollView,
TouchableOpacity,
} from 'react-native';
import {NetworkInfo} from 'react-native-network-info';
interface NetworkInfoState {
ipAddress: string | null;
ipv4Address: string | null;
broadcast: string | null;
ssid: string | null;
bssid: string | null;
subnet: string | null;
defaultGateway: string | null;
frequency: number | null;
}
export function NetworkInfoDemo() {
const [info, setInfo] = useState<NetworkInfoState>({
ipAddress: '',
ipv4Address: '',
broadcast: '',
ssid: '',
bssid: '',
subnet: '',
defaultGateway: '',
frequency: 0,
});
return (
<ScrollView style={styles.container}>
<View style={styles.infoContainer}>
<TouchableOpacity
onPress={async () => {
const value = await NetworkInfo.getIPAddress();
setInfo({...info, ipAddress: value});
}}>
<Text style={styles.button}>ipAddress</Text>
</TouchableOpacity>
<Text style={styles.infoText}>{`${info.ipAddress}`}</Text>
</View>
<View style={styles.infoContainer}>
<TouchableOpacity
onPress={async () => {
const value = await NetworkInfo.getIPV4Address();
setInfo({...info, ipv4Address: value});
}}>
<Text style={styles.button}>ipv4Address</Text>
</TouchableOpacity>
<Text style={styles.infoText}>{`${info.ipv4Address}`}</Text>
</View>
<View style={styles.infoContainer}>
<TouchableOpacity
onPress={async () => {
const value = await NetworkInfo.getBroadcast();
setInfo({...info, broadcast: value});
}}>
<Text style={styles.button}>broadcast</Text>
</TouchableOpacity>
<Text style={styles.infoText}>{`${info.broadcast}`}</Text>
</View>
<View style={styles.infoContainer}>
<TouchableOpacity
onPress={async () => {
const value = await NetworkInfo.getSSID();
setInfo({...info, ssid: value});
}}>
<Text style={styles.button}>ssid</Text>
</TouchableOpacity>
<Text style={styles.infoText}>{`${info.ssid}`}</Text>
</View>
</ScrollView>
);
}
const styles = StyleSheet.create({
container: {
flex: 1,
padding: 20,
},
infoContainer: {
flexDirection: 'row',
justifyContent: 'space-between',
alignItems: 'center',
marginBottom: 10,
},
infoText: {
fontSize: 16,
},
button: {
paddingVertical: 6,
paddingHorizontal: 12,
backgroundColor: 'hsl(193, 95%, 68%)',
borderWidth: 2,
borderColor: 'hsl(193, 95%, 30%)',
borderRadius: 4,
},
});
2. Link
| 是否支持autolink | RN框架版本 | |
|---|---|---|
| ~5.4.0 | Yes | 0.82 |
| ~5.3.0 | No | 0.77 |
| ~5.2.2 | Yes | 0.72 |
| <= 5.2.1-0.0.1@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-network-info": "file:../../node_modules/@react-native-ohos/react-native-network-info/harmony/rn_network_info.har"
}
点击右上角的 sync 按钮
或者在命令行终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)
2.3. 配置 CMakeLists 和引入 NetworkInfoPackage
若使用的是 <= 5.2.1-0.0.1 版本,请跳过本章。
打开 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-network-info/src/main/cpp" ./rn_network_info)
# RNOH_END: manual_package_linking_1
# RNOH_BEGIN: manual_package_linking_2
+ target_link_libraries(rnoh_app PUBLIC rnoh_network_info)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
+ #include "NetworkInfoPackage.h"
using namespace rnoh;
std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
return {
std::make_shared<RNOHGeneratedPackage>(ctx),
+ std::make_shared<NetworkInfoPackage>(ctx),
};
}
2.4. 在 ArkTs 侧引入 RNNetworkInfoPackage
打开 entry/src/main/ets/RNPackagesFactory.ts,添加:
...
+ import { RNNetworkInfoPackage } from '@react-native-ohos/react-native-network-info/ts';
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
new SamplePackage(ctx),
+ new RNNetworkInfoPackage(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.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
3.2. 权限要求
在 entry 目录下的 module.json5 中添加wifi和网络信息权限
打开entry/src/main/module.json5,添加:
...
"requestPermissions": [
{
"name" : "ohos.permission.GET_WIFI_INFO"
},
{
"name": "ohos.permission.GET_NETWORK_INFO"
}
]
4. 静态方法
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| getSSID | 获取 SSID | function | no | All | yes |
| getBSSID | 获取 BSSID | function | no | All | yes |
| getBroadcast | 获取广播地址 | function | no | All | yes |
| getIPAddress | 获取本地 IP 地址 | function | no | All | yes |
| getIPV4Address | 获取 IPv4 IP 地址(优先 WiFi,其次蜂窝网络) | function | no | All | yes |
| getSubnet | 获取子网掩码 | function | no | All | yes |
| getGatewayIPAddress | 获取默认网关 IP 地址 | function | no | All | yes |
| getFrequency | 获取频率 | function | no | Android | yes |
5. 遗留问题
6. 其他
7. 开源协议
本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。