4.1.7-0.0.2 • Published 6 months ago

@ohmi/react-native-udp v4.1.7-0.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
6 months ago

模板版本:v0.2.2

!TIP(https://gitee.com/kunyuan-hongke/react-native-udp.git)

安装与使用

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

npm

npm install @ohmi/react-native-udp

yarn

yarn add @ohmi/react-native-udp

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

!WARNING 使用时 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;

使用 Codegen

本库已经适配了 Codegen ,在使用前需要主动执行生成三方库桥接代码,详细请参考 Codegen 使用文档

Link

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

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

1.在工程根目录的 oh-package.json5 添加 overrides 字段

{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony" : "./react_native_openharmony"
  }
}

2.引入原生端代码

目前有两种方法:

  1. 通过 har 包引入(在 IDE 完善相关功能后该方法会被遗弃,目前首选此方法);
  2. 直接链接源码。

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

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

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

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@ohmi/react_native_udp": "file:../../node_modules/@ohmi/react-native-udp/harmony/react_native_udp.har"
  }

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

方法二:直接链接源码

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

3.在 ArkTs 侧引入 RNUdpPackage

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

...

+ import {RNUdpPackage} from '@ohmi/react_native_udp/ts';

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

4.配置 CMakeLists 和引入 RNUdpPackage

打开 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}/@ohmi/react_native_udp/src/main/cpp" ./udp)
# 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_udp)
# RNOH_END: manual_package_linking_2

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

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

4.运行

点击右上角的 sync 按钮

或者在终端执行:

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。

请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息:@ohmi/react-native-udp Releases

API

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

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

NameDescriptionTypeRequiredPlatformHarmonyOS Support
createSocketCreates a Socket object.FunctionfalseAndroid/iOSyes
closeClose the underlying socket and stop listening for data on it. If a callback is provided.FunctionfalseAndroid/iOSyes
bindFor UDP sockets, causes the UdpSocket to listen for datagram messages on a named port.FunctionfalseAndroid/iOSyes
sendBroadcasts a datagram on the socket.FunctionfalseAndroid/iOSyes
addressReturns an object containing the address information for a socket.FunctionfalseAndroid/iOSyes
setBroadcastSets or clears the SO_BROADCAST socket option.FunctionfalseAndroid/iOSyes
addMembershipTells the kernel to join a multicast group at the given multicastAddress and multicastInterface using the IP_ADD_MEMBERSHIP socket option.FunctionfalseAndroid/iOSyes
dropMembershipInstructs the kernel to leave a multicast group at multicastAddress using the IP_DROP_MEMBERSHIP socket option.FunctionfalseAndroid/iOSyes

遗留问题

其他

开源协议

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