模板版本:v0.4.0

react-native-udp

本项目基于 react-native-udp 开发。

该第三方库的仓库已迁移至 Gitcode,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-udp 版本所属关系如下:

三方库名称 三方库版本 发布信息 支持RN版本 Autolink 编译API版本 社区基线版本 npm地址
@react-native-ohos/react-native-udp ~ 4.3.0 Gitcode Releases 0.82.* API12+ 4.1.7 Npm Address
@react-native-ohos/react-native-udp ~ 4.2.0 Gitcode Releases 0.77.* API12+ 4.1.7 Npm Address
@react-native-ohos/react-native-udp ~ 4.1.8 Gitcode Releases 0.72.* API12+ 4.1.7 Npm Address
@react-native-oh-tpl/react-native-udp <= 4.1.7-0.0.2@deprecated Github Releases(deprecated) 0.72.* API12+ 4.1.7 Npm Address

1. 安装与使用

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

npm

npm install @react-native-ohos/react-native-udp

yarn

yarn add @react-native-ohos/react-native-udp

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

使用时 import 的库名不变。

import React, {Component} from 'react';
import {ScrollView, StyleSheet, Text, View} from 'react-native';

import dgram from 'react-native-udp';

function randomPort() {
  return (Math.random() * 60536) | (0 + 5000); // 60536-65536
}

function toByteArray(obj) {
  var uint = new Uint8Array(obj.length);
  for (var i = 0, l = obj.length; i < l; i++) {
    uint[i] = obj.charCodeAt(i);
  }

  return new Uint8Array(uint);
}

class App extends Component {
  constructor(props) {
    super(props);

    this.updateChatter = this.updateChatter.bind(this);
    this.state = {chatter: []};
  }

  updateChatter(msg) {
    this.setState({
      chatter: this.state.chatter.concat([msg]),
    });
  }

  componentDidMount() {
    let self = this;

    let a = dgram.createSocket('udp4');
    let aPort = randomPort();
    a.bind(aPort, function(err) {
      if (err) throw err;
      self.updateChatter('a bound to ' + JSON.stringify(a.address()));
    });

    let b = dgram.createSocket('udp4');
    var bPort = randomPort();
    b.bind(bPort, function(err) {
      if (err) throw err;
      self.updateChatter('b bound to ' + JSON.stringify(b.address()));
    });

    a.on('message', function(data, rinfo) {
      var str = String.fromCharCode.apply(null, new Uint8Array(data));
      self.updateChatter(
        'a received echo ' + str + ' ' + JSON.stringify(rinfo),
      );
      a.close();
      b.close();
    });

    b.on('message', function(data, rinfo) {
      var str = String.fromCharCode.apply(null, new Uint8Array(data));
      self.updateChatter('b received ' + str + ' ' + JSON.stringify(rinfo));

      // echo back
      b.send(data, 0, data.length, aPort, '127.0.0.1', function(err) {
        if (err) throw err;
        self.updateChatter('b echoed data');
      });
    });

    b.once('listening', function() {
      var msg = toByteArray('hello');
      a.send(msg, 0, msg.length, bPort, '127.0.0.1', function(err) {
        if (err) throw err;
        self.updateChatter('a sent data');
      });
    });
  }

  render() {
    return (
      <View style={styles.container}>
        <ScrollView>
          {this.state.chatter.map((msg, index) => {
            return (
              <Text key={index} style={styles.welcome}>
                {msg}
              </Text>
            );
          })}
        </ScrollView>
      </View>
    );
  }
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#F5FCFF',
  },
  welcome: {
    fontSize: 20,
    textAlign: 'center',
    margin: 10,
  },
  instructions: {
    textAlign: 'center',
    color: '#333333',
    marginBottom: 5,
  },
});

export default App;
是否支持autolink RN框架版本
~4.3.0 Yes 0.82
~4.2.0 No 0.77
~4.1.8 Yes 0.72
<= 4.1.7-0.0.2@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

此步骤为手动配置原生依赖项的指导。

首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony

2.1. Overrides RN SDK

为了让工程依赖同一个版本的 RN SDK,需要在工程根目录的 oh-package.json5 添加 overrides 字段,指向工程需要使用的 RN SDK 版本。替换的版本既可以是一个具体的版本号,也可以是一个模糊版本,还可以是本地存在的 HAR 包或源码目录。

关于该字段的作用请阅读官方说明

{
  "overrides": {
    "@rnoh/react-native-openharmony": "^0.72.38" // ohpm 在线版本
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony.har" // 指向本地 har 包的路径
    // "@rnoh/react-native-openharmony" : "./react_native_openharmony" // 指向源码路径
  }
}

2.2. 引入原生端代码

目前有两种方法:

  • 通过 har 包引入;
  • 直接链接源码。

方法一:通过 har 包引入(推荐)

har 包位于三方库安装路径的 `harmony` 文件夹下。

打开 entry/oh-package.json5,添加以下依赖

"dependencies": {
    "@react-native-ohos/react-native-udp": "file:../../node_modules/@react-native-ohos/react-native-udp/harmony/react_native_udp.har"
  }

点击右上角的 sync 按钮

或者在命令行终端执行:

cd entry
ohpm install

方法二:直接链接源码

如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)

2.3. 配置 CMakeLists 和引入 UdpPackage

若使用的是 <=4.1.7-0.0.2版本,请跳过本章。

打开 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-udp/src/main/cpp" ./rnoh_udp)
# RNOH_END: manual_package_linking_1

# RNOH_BEGIN: manual_package_linking_2
+ target_link_libraries(rnoh_app PUBLIC rnoh_udp)
# RNOH_END: manual_package_linking_2

打开 entry/src/main/cpp/PackageProvider.cpp,添加:

#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
+ #include "UdpPackage.h"

using namespace rnoh;

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

2.4. 在 ArkTs 侧引入 RNUdpPackage Package

打开 entry/src/main/ets/RNPackagesFactory.ts,添加:

  ...
+ import {RNUdpPackage} from '@react-native-ohos/react-native-udp/ts';

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

2.5. 运行

点击右上角的 sync 按钮

或者在命令行终端执行:

cd entry
ohpm install

然后编译、运行即可。

3. 约束与限制

3.1. 兼容性

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

  1. RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  2. RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
  3. RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
  4. RNOH: 0.82.7; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;

3.2. 权限要求

3.3. 编译运行API要求

4. 属性

5. 静态方法

6. API

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

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

Name Description Type Required Platform HarmonyOS Support
createSocket 创建一个套接字对象。 Function false Android/iOS yes
close 关闭底层套接字,并停止监听其上的数据。如果提供了回调函数,则在关闭完成后调用。 Function false Android/iOS yes
bind 对于UDP套接字,使其在指定端口上监听数据报消息。 Function false Android/iOS yes
send 在该套接字上发送(广播)一个数据报。 Function false Android/iOS yes
address 返回一个对象,包含该套接字的地址信息。 Function false Android/iOS yes
setBroadcast 设置或清除SO_BROADCAST套接字选项。 Function false Android/iOS yes
addMembership 通过IP_ADD_MEMBERSHIP套接字选项,通知内核加入指定的多播组(multicastAddress 和 multicastInterface)。 Function false Android/iOS yes
dropMembership 通过IP_DROP_MEMBERSHIP套接字选项,通知内核离开指定的多播组(multicastAddress)。 Function false Android/iOS yes

7. 遗留问题

8. 其他

9. 开源协议

本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。