HarmonyOS开发5.0【rcp的封装与应用】

于 2024-09-04 16:02:21 发布
阅读量444 收藏 11
点赞数 7
分类专栏： openharmony记录 文章标签： harmonyos 鸿蒙 鸿蒙系统 openharmony 程序员 rcp 封装
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jiujidaima/article/details/141892530
版权

何为rcp？

rcp 即 Remote Communication Protocol（远场通信协议）。在HarmonyOS中，它的实现集成在Remote Communication Kit（远场通信服务）中，是华为提供的HTTP发起数据请求的NAPI封装。

应用通过Remote Communication Kit可以便捷快速地向服务器发起数据请求，rcp支持HTTP的GET、POST、OPTIONS等请求，提供了丰富的业务场景。

我们知道，在鸿蒙SDK的系统服务中，网络请求相关服务已经有了NetWork Kit了，为什么还需要使用rcp呢？可以知道：

http原生库能力还在维护中，ohos.net.http暂不会再演进或新增其他功能，当前推荐使用hms.collaboration.rcp能力替代，在接口易用性、性能、功耗方面比http网络库好。

因此官方推荐使用rcp，我们也需要紧跟官方的步伐，赶快用起来~

使用Remote Communication Kit的主要业务流程如下：

  1. 应用客户端创建会话。
  2. 应用客户端发起请求。
  3. 应用客户端接收请求结果，处理相应业务。

如何使用

首先，需要申请网络权限，在entry/src/main路径下的module.json5中配置如下：

{
  "module": {
    "requestPermissions": [
      {
        "name": "ohos.permission.INTERNET"
      },
      {
        "name": "ohos.permission.GET_NETWORK_INFO"
      }
    ]
  }
}

然后，在需要使用该能力的.ets文件中导入rcp：

import { rcp } from "@kit.RemoteCommunicationKit";

这样，我们就可以使用rcp的能力了。

封装

rcp的使用场景很多，一般场景有：

  • 获取服务器资源
  • 发送数据到服务器
  • 断点续传
  • 双向证书校验
  • 拦截器 …

我们可以对一些主要场景进行封装，达到在项目中方便易用的效果。

这里，我们创建一个工具类HTTPRequestUtil，并声明一个rcp.Configuration和一个rcp.RequestHeaders供全局调用：

const configuration: rcp.Configuration = {
  transfer: {
    autoRedirect: true,
    timeout: {
      // 允许建立连接的最长时间
      connectMs: HTTP_TIMEOUT,
      // 允许传输数据的最长时间
      transferMs: HTTP_TIMEOUT,
    }
  }
};

const header: rcp.RequestHeaders = {
  'content-type': 'application/json'
}

接着，再创建一个session：

// Use the configuration in the session creation
  private static session = rcp.createSession({ requestConfiguration: configuration });

这个session是创建rcp网络请求或连接的基础，由此发起相关事务。 我们可以使用session的fetch能力发起一个HTTP请求，并获取返回结果：

private static sendRequest(url: string, method: rcp.HttpMethod, params: Record<string, string>, succeedCallback: Callback<rcp.Response>, failedCallback: Callback<BusinessError>) {
    let req = new rcp.Request(url);
    if (params) req.content = JSON.stringify(params);
    req.method = method.toUpperCase();
    req.headers = header;

    HTTPRequestUtil.session.fetch(req).then((response) => {
      LogUtil.info("RCP request succeed: " + JSON.stringify(response));
      succeedCallback(response);
      HTTPRequestUtil.session.close();
    }).catch((err: BusinessError) => {
      LogUtil.error("RCP request failed: " + err);
      HTTPRequestUtil.session.close();
      failedCallback(err);
    });
  }

可以看出，以上方法基于参数回调，返回结果和错误都会通过回调返回。 我们也可以通过Promise的方式异步返回结果：

private static async sendRequestP(url: string, method: rcp.HttpMethod, params: Record<string, string>): Promise<rcp.Response | BusinessError> {
    let req = new rcp.Request(url);
    if (params) req.content = JSON.stringify(params);
    req.method = method.toUpperCase();
    req.headers = header;
    req.configuration = configuration;

    try {
      let res = await HTTPRequestUtil.session.fetch(req);
      LogUtil.info("RCP request succeed: " + JSON.stringify(res));
      return res;
    } catch (err) {
      LogUtil.error("RCP request failed: " + err);
      return err as BusinessError;
    } finally {
      HTTPRequestUtil.session.close();
    }
  }

这样，我们就可以通过传入参数的method变化实现一般的GET、POST、PUT等HTTP请求。

通过回调返回的可以实现如下：

  /**
   * 发送 GET 请求
   * @param url: URL
   * @param params: 参数
   * @param succeedCallback: 成功回调
   * @param failedCallback: 失败回调
   *
   * @returns 通过回调返回
   */
static GET(url: string, params: Record<string, string>, succeedCallback: Callback<rcp.Response>, failedCallback: Callback<BusinessError>) {
    HTTPRequestUtil.sendRequest(url, "GET", params, (response: rcp.Response) => {
      succeedCallback(response);
    }, (err: BusinessError) => {
      failedCallback(err);
    });
  }


  /**
   * 发送 POST 请求
   * @param url: URL
   * @param params: 参数
   * @param succeedCallback: 成功回调
   * @param failedCallback: 失败回调
   *
   * @returns 通过回调返回
   */
  static POST(url: string, params: Record<string, string>, succeedCallback: Callback<rcp.Response>, failedCallback: Callback<BusinessError>) {
    HTTPRequestUtil.sendRequest(url, "POST", params, (response: rcp.Response) => {
      succeedCallback(response);
    }, (err: BusinessError) => {
      failedCallback(err);
    });
  }

  /**
   * 发送 PUT 请求
   * @param url: URL
   * @param params: 参数
   * @param succeedCallback: 成功回调
   * @param failedCallback: 失败回调
   *
   * @returns 通过回调返回
   */
  static PUT(url: string, params: Record<string, string>, succeedCallback: Callback<rcp.Response>, failedCallback: Callback<BusinessError>) {
    HTTPRequestUtil.sendRequest(url, "PUT", params, (response: rcp.Response) => {
      succeedCallback(response);
    }, (err: BusinessError) => {
      failedCallback(err);
    });
  }


  /**
   * 发送 DELETE 请求
   * @param url: URL
   * @param params: 参数
   * @param succeedCallback: 成功回调
   * @param failedCallback: 失败回调
   *
   * @returns 通过回调返回
   */
  static DELETE(url: string, params: Record<string, string>, succeedCallback: Callback<rcp.Response>, failedCallback: Callback<BusinessError>) {
    HTTPRequestUtil.sendRequest(url, "DELETE", params, (response: rcp.Response) => {
      succeedCallback(response);
    }, (err: BusinessError) => {
      failedCallback(err);
    });
  }

其使用十分简便：

HTTPRequestUtil.GET(url, {}, (res) => {
  // 返回结果
}, (err) => {
  // 错误处理
});

如果你希望通过Promise返回，同样可以实现如下：

/**
   * 发送 GET 请求（通过 Promise 返回）
   * @param url: URL
   * @param params: 参数
   *
   * @returns Promise 返回结果
   */
  static async get(url: string, params: Record<string, string>): Promise<rcp.Response | BusinessError> {
    try {
      const response = await HTTPRequestUtil.sendRequestP(url, "GET", params);
      return response;
    } catch (error) {
      return error;
    }
  }

  /**
   * 发送 POST 请求（通过 Promise 返回）
   * @param url: URL
   * @param params: 参数
   *
   * @returns Promise 返回结果
   */
  static async post(url: string, params: Record<string, string>): Promise<rcp.Response | BusinessError> {
    try {
      const response = await HTTPRequestUtil.sendRequestP(url, "POST", params);
      return response;
    } catch (error) {
      return error;
    }
  }

  /**
   * 发送 PUT 请求（通过 Promise 返回）
   * @param url: URL
   * @param params: 参数
   *
   * @returns Promise 返回结果
   */
  static async put(url: string, params: Record<string, string>): Promise<rcp.Response | BusinessError> {
    try {
      const response = await HTTPRequestUtil.sendRequestP(url, "PUT", params);
      return response;
    } catch (error) {
      return error;
    }
  }

  /**
   * 发送 DELETE 请求（通过 Promise 返回）
   * @param url: URL
   * @param params: 参数
   *
   * @returns Promise 返回结果
   */
  static async delete(url: string, params: Record<string, string>): Promise<rcp.Response | BusinessError> {
    try {
      const response = await HTTPRequestUtil.sendRequestP(url, "DELETE", params);
      return response;
    } catch (error) {
      return error;
    }
  }

同样，我们可以通过一行代码进行调用：

let res = await HTTPRequestUtil.get(url, "");
LogUtil.info(`HTTPRequestUtil succeed: ${res}`);

我们还可以实现下载文件流程：

/**
   * 下载文件
   * @param url: URL
   * @param toPath: 文件保存路径
   *
   * @returns 通过回调返回
   */
   async downloadFile(url: string, filename: string, progressCallback: (progress: number) => void, succeedCallback: (filepath: string) => void, failedCallback:(err: BusinessError) => void) {
     // Define a custom response handler
     const customHttpEventsHandler: rcp.HttpEventsHandler = {
       onDownloadProgress: (totalSize: number, transferredSize: number) => {
         // Custom logic for handling download progress
         console.info("Download progress:", transferredSize, "of", totalSize);
         let proc = Math.ceil(transferredSize / totalSize * 100);
         progressCallback(proc);
       }
     };

     // Configure tracing settings
     const tracingConfig: rcp.TracingConfiguration = {
       verbose: true,
       infoToCollect: {
         textual: true,
         incomingHeader: true,
         outgoingHeader: true,
         incomingData: true,
         outgoingData: true,
         incomingSslData: true,
         outgoingSslData: true,
       },
       collectTimeInfo: true,
       httpEventsHandler: customHttpEventsHandler,
     };

     // Use the configuration in the session creation
     const session = rcp.createSession({ requestConfiguration: { tracing: tracingConfig } });

     try {
      // 获取保存全路径
      let finalPath = FileUtil.getFilesDirPath('', filename);
      let fileDir = FileUtil.getFilesDirPath('');
      let fn = FileUtil.getFileName(finalPath);
      let path = finalPath.replace(fn, "");
      let isExists = fs.accessSync(finalPath);

      if (isExists) {
        fs.unlinkSync(finalPath);
      } else {
        if (path != fileDir + '/') {
          FileUtil.mkdirSync(path, true);
        }
      }

      let downloadToFile: rcp.DownloadToFile = {
        kind: "file",
        file: finalPath
      } as  rcp.DownloadToFile

      await session.downloadToFile(url, downloadToFile);

      LogUtil.info("File path: " + finalPath);
      succeedCallback(finalPath);
    } catch (err) {
      LogUtil.error("HTTPRequestUtil download file error:" + err);
      failedCallback(err);
    }
  }

}

这里有个关键点在于获取下载进度，这一监听在rcp.HttpEventsHandler的onDownloadProgress中，我们可以在这里实时返回当前进度，如果需要返回一个百分比的数值，可以使用Math.ceil进行转换：let proc = Math.ceil(transferredSize / totalSize * 100);。

如需取消下载，可调用session.cancel()。

总结

这里，我们对rcp的部分功能进行了封装尝试，当然，这只是其中很少的一部分。rcp的能力正如我在前文中列举的那样很强大很全面，如果你需要在项目中用到其他能力，可以尝试按照官方文档进行封装与优化。

最后呢

很多开发朋友不知道需要学习那些鸿蒙技术？鸿蒙开发岗位需要掌握那些核心技术点？为此鸿蒙的开发学习必须要系统性的进行。

而网上有关鸿蒙的开发资料非常的少，假如你想学好鸿蒙的应用开发与系统底层开发。你可以参考这份资料，少走很多弯路，节省没必要的麻烦。由两位前阿里高级研发工程师联合打造的《鸿蒙NEXT星河版OpenHarmony开发文档》里面内容包含了（ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等）鸿蒙（Harmony NEXT）技术知识点

如果你是一名Android、Java、前端等等开发人员，想要转入鸿蒙方向发展。可以直接领取这份资料辅助你的学习。下面是鸿蒙开发的学习路线图。
在这里插入图片描述

针对鸿蒙成长路线打造的鸿蒙学习文档。话不多说，我们直接看详细鸿蒙（OpenHarmony ）手册（共计1236页）与鸿蒙（OpenHarmony ）开发入门视频，帮助大家在技术的道路上更进一步。

  • 《鸿蒙 (OpenHarmony)开发学习视频》
  • 《鸿蒙生态应用开发V2.0白皮书》
  • 《鸿蒙 (OpenHarmony)开发基础到实战手册》
  • OpenHarmony北向、南向开发环境搭建
  • 《鸿蒙开发基础》
  • 《鸿蒙开发进阶》
  • 《鸿蒙开发实战》

在这里插入图片描述

2

mau123789
码农的秘密花园
关注
  • 7
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
eclipse rcp应用系统开发方法与实战源代码.zip
05-11
在"eclipse rcp应用系统开发方法与实战源代码.zip"中，我们可以学习到以下关键知识点： 1. **Eclipse RCP架构**：理解Eclipse RCP的基础架构非常重要，包括插件（Plugins）、工作台（Workbench）、视图（Views）、...
ECLIPSE+RCP应用系统开发方法与实战
07-17
非常好的一本JAVA RCP入门实战的书，兼顾理论和实战。
HarmonyOS开发实战：网络请求能力-rcp
DMZDAMS的博客
07-02 715
rcp采用面向对象和场景的设计，API使用更简单、更灵活，满足不同场景的使用需求，具备更好的扩展性和更优的性能。
HarmonyOS开发实战：自定义装饰器实现Lifecycle组件
m0_64422261的博客
07-10 1097
自定义组件生命周期绑定装饰器，可通过以下方式自动绑定自定义组件的生命周期，使用方法和Android中的Lifecycle类似 无需关注lifecycle的释放，自定义组件aboutToDisappear时，lifecycle会自动释放
鸿蒙开发5.0【基于rcp的网络请求能力】
2301_76813281的博客
08-27 937
rcp模块提供HTTP数据请求功能，请求性能如接口的易用性、性能、功耗方面，对比Network Kit HTTP网络API，rcp采用面向对象和场景的设计，API使用更简单、更灵活，满足不同场景的使用需求，具备更好的扩展性和更优的性能。支持如场景化网络API、网络代理、自定义DNS解析、自定义证书校验、服务器身份校验等特性。
[HarmonyOS Next示例代码]基于RCP的网络请求能力
Alexzhang369学习总结空间
08-27 788
RCP指的是远程通信平台（remote communication platform），RCP提供网络数据请求功能，相较于Network Kit中HTTP请求能力，RCP更具易用性，且拥有更多的功能。例如：支持发送PATCH请求支持设置BaseURL支持取消请求，取消指定或正在进行的会话请求支持自定义证书校验，可以根据自身业务需要，对证书进行校验支持自定义DNS解析支持自定义拦截器实现响应缓存支持在会话中的HTTP请求期间捕获详细的跟踪信息。
【HarmonyOS NEXT】API 12如何实现网络请求自定义拦截器
Mayism123的博客
07-25 517
在API 12中如何自定义请求头拦截器呢，能否给个demo看一下如何进行设置header，然后进行next的操作。API 12 / 网络请求 / 自定义拦截器 / demo / header。
基于RCP封装的芯片模型电热模拟.pdf
07-26
本文主要探讨了在60°C温度范围内，针对RCP（ Redistribution Chip Package，重分布芯片封装）封装的芯片模型进行的电热模拟实验。...这些研究为RCP封装技术的发展和实际应用提供了宝贵的参考依据。
eclipse开发rcp4应用示例
03-26
Eclipse RCP4是Eclipse Rich Client Platform的第四代版本，是一个用于构建桌面...通过深入研究"eclipse开发rcp4应用示例"中的源码和配置，你将能够掌握这些技术的实用技巧，并进一步提升你的Java桌面应用开发能力。
如何快速开发Java RCP企业级应用?
03-06
"这一主题中，我们将深入探讨如何利用Java RCP进行高效的企业级应用开发。 首先，Java RCP是基于Eclipse平台构建的，它提供了丰富的UI组件和事件处理机制，让开发者可以专注于业务逻辑，而不是底层的窗口系统。Java...
HarmonyOS开发实战（ Beta5版）线程间通信场景最佳实践
weixin_55362248的博客
09-02 925
在应用开发中，经常会需要处理一些耗时的任务，如果全部放在主线程中执行就会导致阻塞，从而引起卡顿或者掉帧现象，降低用户体验，此时就可以将这些耗时操作放到子线程中处理。
使用SymbolGlyph和SymbolSpan在HarmonyOS中实现高级图标效果
A1551143530的博客
09-03 481
不仅支持静态图标，还可以通过属性为图标添加动态效果。Column() {Text("弹跳动效示例")'停止' : '开始').onClick(() => {})这个示例展示了如何通过按钮控制图标的动效，利用实现图标的弹跳效果。这样的动效可以显著提升用户界面的动态感。和SymbolSpan组件提供了丰富的功能，使您能够在HarmonyOS中轻松创建和管理图标。通过掌握这些组件的用法，您可以在应用中实现精美的图标效果，并为用户带来更好的视觉体验。4o。
HarmonyOS开发实战（ Beta5版）跨线程序列化耗时点分析工具使用规范指南
weixin_55362248的博客
09-02 1343
DevEco Studio新增主线程序列化和反序列化检测能力，同时支持配置序列化/反序列化超时阈值。对于超过阈值的序列化和反序列化操作，在泳道中给出告警提示，并可以关联该时刻的调用栈信息，更好地帮忙开发者定位性能问题。
HarmonyOS开发实战（ Beta5版）减小应用包大小
weixin_55362248的博客
08-30 1711
当前DevEco Studio默认打包应用时不压缩so库文件，配置so压缩选项后，DevEco Studio会将so库文件以压缩形式打包到包中，从而减小应用包大小。
安卓model转鸿蒙ets
琼小资的专栏
09-03 254
现在的android studio提供了java自动转kotlin的实现，非常方便。那android的java和kotlin有没有可能转成鸿蒙artts呢。先从最简单的model转换开始，把kotlin的model转成ets。本质上都是字符串文件，讲道理应该是可行的。
鸿蒙Next 单元测试框架——hypium
qq_39431405的博客
08-30 1507
单元测试框架(hypium)是HarmonyOS上的测试框架，提供测试用例编写、执行、结果显示能力，用于测试系统或应用接口。表1 单元测试框架功能特性。
鸿蒙（API 12 Beta6版）图形【NativeDisplaySoloist开发指导】方舟2D图形服务
最新发布
鸿蒙的技术博客
09-03 725
如果开发者想在独立线程中进行帧率控制的Native侧业务，可以通过DisplaySoloist来实现，如游戏、自绘制UI框架对接等场景。 开发者可以选择多个DisplaySoloist实例共享一个线程，也可以选择每个DisplaySoloist实例独占一个线程。
HarmonyOS(52) 使用安全控件SaveButton保存图片
菜鸟博客
08-30 1053
SaveButton 安全控件说明
鸿蒙模拟器篇
qq_36859035的博客
08-29 600
1、首先需要在华为官网申请模拟器资格，附链接：鸿蒙模拟器（HarmonyOS Emulator）Beta活动申请填写相关信息提交申请，申请结果状态在个人中心 — 我的活动页面查看2、申请通过之后开始下载模拟器 注意：如果出现请先安装系统镜像或者下面图片上的错误，尝试重装DevEco Studio
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值