@tuya-oh/netinfo

v11.1.0-rc-0.0.9

Published

5 months ago

React Native Network Info API for harmonyOS

0High
0Medium
0Low

react-native react native netinfo networking network info

模板版本：v0.2.2

[!TIP] Gitee 地址

安装与使用

请到三方库的 Releases 发布地址查看配套的版本信息：@tuya-oh/netinfo Releases 。对于未发布到npm的旧版本，请参考安装指南安装tgz包。

进入到工程目录并输入以下命令：

npm

npm install @tuya-oh/netinfo

yarn

yarn add @tuya-oh/netinfo

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

[!WARNING] 使用时 import 的库名不变。

import React, { Component } from "react";
import { View, Text, Button, SafeAreaView } from "react-native";
import NetInfo from "@react-native-community/netinfo";

export class NetInfoDemo extends Component {
  constructor(props) {
    super(props);
    this.state = {
      connectionInfo: null,
      isConnected: false,
      effectiveType: "unknown",
      type: "unknown",
    };
  }

  componentDidMount() {
    // 初始化时获取连接信息
    this.fetchConnectionInfo();

    // 监听连接状态变化
    this.unsubscribe = NetInfo.removeEventListener(
      "connectionChange",
      this.handleConnectionChange
    );
  }

  componentWillUnmount() {
    // 移除监听
    this.unsubscribe();
  }

  // 获取完整连接信息
  fetchConnectionInfo = async () => {
    try {
      const info = await NetInfo.getConnectionInfo();
      this.setState({
        connectionInfo: JSON.stringify(info, null, 2),
        effectiveType: info?.effectiveType,
        type: info?.type,
      });
    } catch (error) {
      console.error("获取连接信息失败:", error);
    }
  };

  // 检查简单连接状态
  checkConnection = async () => {
    try {
      const isConnected = await NetInfo.isConnected.fetch();
      this.setState({ isConnected });
    } catch (error) {
      console.error("检查连接状态失败:", error);
    }
  };

  // 处理连接变化
  handleConnectionChange = async (isConnected) => {
    this.setState({ isConnected });
    await this.fetchConnectionInfo(); // 状态变化时重新获取详细信息
  };

  render() {
    return (
      <SafeAreaView>
        <View style={{ padding: 20, backgroundColor: "#fff" }}>
          <Text style={{ fontSize: 18, fontWeight: "bold" }}>网络状态检测</Text>

          <Button title="手动检测网络" onPress={this.checkConnection} />

          <Text style={{ marginTop: 20 }}>
            当前连接状态: {this.state.isConnected ? "已连接" : "未连接"}
          </Text>

          <Text style={{ marginTop: 10 }}>网络类型: {this.state.type}</Text>

          <Text style={{ marginTop: 10 }}>
            有效带宽: {this.state.effectiveType}
          </Text>

          <Text style={{ marginTop: 20, whiteSpace: "pre" }}>
            完整连接信息:
            {this.state.connectionInfo || "未获取到"}
          </Text>
        </View>
      </SafeAreaView>
    );
  }
}

Link

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

首先需要使用 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",
    "@tuya-oh/netinfo": "file:../../node_modules/@tuya-oh/netinfo/harmony/netinfo.har"
  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

[!TIP] 如需使用直接链接源码，请参考直接链接源码说明

3.配置 CMakeLists 和引入 RNCNetInfoPackage

打开 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}/@tuya-oh/netinfo/src/main/cpp" ./netinfo)
# 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_netinfo)
# RNOH_END: manual_package_linking_2

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

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "RNCNetInfoPackage.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<RNCNetInfoPackage>(ctx)
    };
}

4.在 ArkTs 侧引入 NetInfoPackage

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

  ...
+ import {NetInfoPackage} from '@tuya-oh/netinfo/ts';

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

5.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

本文档内容基于以下版本验证通过：

RNOH：0.72.50; SDK：5.0.2.126 ; IDE：DevEco Studio 5.0.7.210; ROM：5.0.0.135;

属性

[!TIP] "Platform"列表示该属性在原三方库上支持的平台。

[!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。

ConnectionType enum

| Name | Description | Type | Required | Platform | HarmonyOS Support | | ----------- | ---------------------------------------------------------- | ------ | -------- | ----------- | ----------------- | | none | No network connection is active | String | no | iOS Android | yes | | unknown | The network state could not or has yet to be be determined | String | no | iOS Android | yes | | cellular | Active network over cellular | String | no | iOS Android | yes | | wifi | Active network over Wifi | String | no | iOS Android | yes | | bluetooth | Active network over Bluetooth | String | no | Android | no | | ethernet | Active network over wired ethernet | String | no | iOS Android | yes | | wimax | Active network over WiMax | String | no | Android | no | | vpn | Active network over VPN | String | no | Android | yes | | other | Active network over another type of network | String | no | iOS Android | yes |

EffectiveConnectionType enum

| Name | Description | Type | Required | Platform | HarmonyOS Support | | ------ | ----------------------------------------------------------------------------------------------------------------- | ------ | -------- | ----------- | ----------------- | | null | Either we are not currently connected to a cellular network or type could not be determined | String | no | iOS Android | yes | | 2g | Currently connected to a 2G cellular network. Includes CDMA, EDGE, GPRS, and IDEN type connections | String | no | iOS Android | yes | | 3g | Currently connected to a 3G cellular network. Includes EHRPD, EVDO, HSPA, HSUPA, HSDPA, and UTMS type connections | String | no | iOS Android | yes | | 4g | Currently connected to a 4G cellular network. Includes HSPAP and LTE type connections | String | no | iOS Android | yes | | 5g | Currently connected to a 5G cellular network. Includes NRNSA (iOS only) and NR type connections | String | no | iOS Android | yes |

静态方法

[!TIP] "Platform"列表示该属性在原三方库上支持的平台。

[!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。

| Name | Description | Type | Required | Platform | HarmonyOS Support | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |:--------:|:--------:|:-----------:|:-----------------:| | getConnectionInfo() | Returns a promise that resolves to an object with type and effectiveType keys whose values are a ConnectionType and an EffectiveConnectionType), respectively. | function | yes | iOS Android | yes | | removeEventListener() | Removes the listener for network status changes. | function | yes | iOS Android | yes | | addEventListener() | Adds an event handler.Supported events: | function | yes | iOS Android | yes | | isConnectionExpensive() | Available on Android. Detect if the current active connection is metered or not. A network is classified as metered when the user is sensitive to heavy data usage on that connection due to monetary costs, data limitations or battery/performance issues. | function | yes | iOS Android | yes | | isConnected() | Available on all platforms. Asynchronously fetch a boolean to determine internet connectivity. | function | yes | iOS Android | yes |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme