首页 > 其他分享 >HarmonyOS实战开发：@ohos.pluginComponent （插件组件管理器）

HarmonyOS实战开发：@ohos.pluginComponent （插件组件管理器）

时间：2024-05-29 17:59:26浏览次数：27  
标签：插件 管理器 log KVObject HarmonyOS 鸿蒙 组件 console data

用于给插件组件的使用者请求组件与数据，使用者发送组件模板和数据。如需实现插件模板的显示，请参考PluginComponent。

说明：

  • 本模块首批接口从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

导入模块

import pluginComponentManager from '@ohos.pluginComponent'
import Want from '@ohos.app.ability.Want';

PluginComponentTemplate

Plugin组件模板参数。

系统能力：SystemCapability.ArkUI.ArkUI.Full

参数类型必填描述
源字符串是组件模板名。
bundle名称字符串是提供者Ability的bundleName。

PluginComponentManager

KVObject（英语：KVObject）

以键值对形式存储信息，符合json格式。

系统能力：SystemCapability.ArkUI.ArkUI.Full

取值范围说明
[键：字符串]关键字，数据类型为字符串，可取空字符串。
数键值，表示值类型为数字。
字符串键值，表示值类型为字符串，可取空字符串。
布尔键值，表示值类型为布尔值。
[]键值，可取值为[]。
KVObject（英语：KVObject）键值，表示值类型为KVObject。

PushParameters

用于设置FA模型下使用PluginManager.Push方法时候的需要传递的参数。

模型约束： 此接口仅适用于FA模型。

系统能力：SystemCapability.ArkUI.ArkUI.Full

名称类型必填说明
要要是组件使用者Ability信息。
名字字符串是组件名称。
数据KVObject（英语：KVObject）是组件数据值。
额外数据KVObject（英语：KVObject）是附加数据值。
json路径字符串否存放模板路径的external.json件的路径。

PushParameterForStage

用于设置Stage模型下使用PluginManager.Push方法时候的需要传递的参数。

模型约束： 此接口仅适用于Stage模型。

系统接口： 此接口为系统接口。

系统能力：SystemCapability.ArkUI.ArkUI.Full

名称类型必填说明
所有者要是组件提供方Ability信息。
目标要是组件使用者Ability信息。
名字字符串是组件名称。
数据KVObject（英语：KVObject）是组件数据值。
额外数据KVObject（英语：KVObject）是附加数据值。
json路径字符串否存放模板路径的external.json文件的路径。

RequestParameters

用于设置FA模型下使用PluginManager.Request方法时候的需要传递的参数。

模型约束： 此接口仅适用于FA模型。

系统能力：SystemCapability.ArkUI.ArkUI.Full

名称类型必填说明
要要是组件提供者Ability信息。
名字字符串是请求组件名称。
数据KVObject（英语：KVObject）是附加数据。
json路径字符串否存放模板路径的external.json文件的路径。jsonPath字段不为空或者未设置的时候不触发Request通信。

RequestParameterForStage

用于设置Stage模型下使用PluginManager.Request方法时候的需要传递的参数。

系统接口： 此接口为系统接口。

模型约束： 此接口仅适用于Stage模型。

系统能力：SystemCapability.ArkUI.ArkUI.Full

名称类型必填说明
所有者要是组件使用者Ability信息。
目标要是组件提供者Ability信息。
名字字符串是请求组件名称。
数据KVObject（英语：KVObject）是附加数据。
json路径字符串否存放模板路径的external.json文件的路径。jsonPath字段不为空或者未设置的时候不触发Request通信。

RequestCallbackParameters

PluginManager.Request方法时候接收到的回调结果。

系统能力：SystemCapability.ArkUI.ArkUI.Full

名称类型必填说明
componentTemplatePluginComponentTemplate是组件模板。
数据KVObject（英语：KVObject）是组件数据。
额外数据KVObject（英语：KVObject）是附加数据。

RequestEventResult

注册Request监听方法后，接受到的请求事件时候回应请求的数据类型。

系统能力：SystemCapability.ArkUI.ArkUI.Full

名称类型必填说明
模板字符串否组件模板。
数据KVObject（英语：KVObject）否组件数据。
额外数据KVObject（英语：KVObject）否附加数据。

OnPushEventCallback

OnPushEventCallback =（源：Want，模板：PluginComponentTemplate，数据：KVObject， extraData： KVObject） => void

对应Push事件的监听回调函数。

参数：

参数类型必填说明
源要是Push请求发送方相关信息。
模板PluginComponentTemplate是Push请求发送方相关信息请求组件模板名称。
数据KVObject（英语：KVObject）是数据。
额外数据KVObject（英语：KVObject）是附加数据。

示例：

import pluginComponentManager from '@ohos.pluginComponent'
import Want from '@ohos.app.ability.Want';
function onPushListener(source: Want, template: PluginComponentTemplate, data: pluginComponentManager.KVObject, extraData: pluginComponentManager.KVObject) {
  console.log("onPushListener template.source=" + template.source)
  console.log("onPushListener source=" + JSON.stringify(source))
  console.log("onPushListener template=" + JSON.stringify(template))
  console.log("onPushListener data=" + JSON.stringify(data))
  console.log("onPushListener extraData=" + JSON.stringify(extraData))
}

OnRequestEventCallback

OnRequestEventCallback =（源：Want，名称：字符串，数据：KVObject）=> RequestEventResult

对应request事件的监听回调函数。

参数：

参数类型必填说明
源要是request请求发送方相关信息。
名字字符串是模板名称。
额外数据KVObject（英语：KVObject）是附加数据。

示例：

import pluginComponentManager from '@ohos.pluginComponent'
import Want from '@ohos.app.ability.Want';
function onRequestListener(source:Want, name:string, data:pluginComponentManager.KVObject) {
  console.error("onRequestListener");
  console.log("onRequestListener source=" + JSON.stringify(source));
  console.log("onRequestListener name=" + name);
  console.log("onRequestListener data=" + JSON.stringify(data));
  let RtnData:Record<string,string|pluginComponentManager.KVObject> = { 'template': "ets/pages/plugin.js", 'data': data }
  return RtnData;
}

推

push（param： PushParameters ， callback： AsyncCallback<void>）： void

组件提供者向组件使用者主动发送组件与数据。

模型约束： 此接口仅适用于FA模型。

参数： |参数名 |类型 |必填 |说明 | |-------- |--------------------------------- |---- |------------ | |参数 |推送参数 |是 |组件使用者的详细信息。 | |回调 |AsyncCallback<void> |是 |此次接口调用的异步回调。 |

示例：

import pluginComponentManager from '@ohos.pluginComponent'
pluginComponentManager.push(
  {
    want: {
      bundleName: "com.example.provider",
      abilityName: "com.example.provider.MainAbility",
    },
    name: "plugintemplate",
    data: {
      "key_1": "plugin component test",
      "key_2": 34234
    },
    extraData: {
      "extra_str": "this is push event"
    },
    jsonPath: "",
  },
  (err, data) => {
    console.log("push_callback: push ok!");
  }
)

推

push（param： PushParameterForStage， callback： AsyncCallback<void>）： void

组件提供者向组件使用者主动发送组件与数据。

系统接口： 此接口为系统接口。

模型约束： 此接口仅适用于Stage模型。

参数： |参数名 |类型 |必填 |说明 | |-------- |---------------------------------------- |---- |------------ | |参数 |PushParameterForStage 的 |是 |组件使用者的详细信息。 | |回调 |AsyncCallback<void> |是 |此次接口调用的异步回调。 |

示例：

import pluginComponentManager from '@ohos.pluginComponent'
pluginComponentManager.push(
  {
    owner: {
      bundleName: "com.example.provider",
      abilityName: "com.example.provider.MainAbility"
    },
    target: {
      bundleName: "com.example.provider",
      abilityName: "com.example.provider.MainAbility",
    },
    name: "ets/pages/plugin2.js",
    data: {
      "js": "ets/pages/plugin.js",
      "key_1": 1111, 
    },
    extraData: {
      "extra_str": "this is push event"
    },
    jsonPath: "",
  },
  (err, data) => {
    console.log("push_callback:err: ", JSON.stringify(err));
    console.log("push_callback:data: ", JSON.stringify(data));
    console.log("push_callback: push ok!");
  }
)

请求

request（param： RequestParameters， callback： AsyncCallback<RequestCallbackParameters>）： void

组件使用者向组件提供者主动请求组件。

模型约束： 此接口仅适用于FA模型。

参数：

参数名类型必填说明
参数RequestParameters是组件模板的详细请求信息。
回调AsyncCallback<RequestCallbackParameters |无效>是此次请求的异步回调， 通过回调接口的参数返回接受请求的数据。

示例：

import pluginComponentManager from '@ohos.pluginComponent'
pluginComponentManager.request(
  {
    want: {
      bundleName: "com.example.provider",
      abilityName: "com.example.provider.MainAbility",
    },
    name: "plugintemplate",
    data: {
      "key_1": "plugin component test",
      "key_2": 1111111
    },
    jsonPath: "",
  },
  (err, data) => {
    console.log("request_callback: componentTemplate.ability=" + data.componentTemplate.ability)
    console.log("request_callback: componentTemplate.source=" + data.componentTemplate.source)
    console.log("request_callback: data=" + JSON.stringify(data.data))
    console.log("request_callback: extraData=" + JSON.stringify(data.extraData))
  }
)

请求

request（param： RequestParameterForStage， callback： AsyncCallback<RequestCallbackParameters>）： void

组件使用者向组件提供者主动请求组件。

系统接口： 此接口为系统接口。

模型约束： 此接口仅适用于Stage模型。

参数：

参数名类型必填说明
参数RequestParameterForStage是组件模板的详细请求信息。
回调AsyncCallback<RequestCallbackParameters |无效>是此次请求的异步回调， 通过回调接口的参数返回接受请求的数据。

示例：

import pluginComponentManager from '@ohos.pluginComponent'
pluginComponentManager.request(
  {
    owner: {
      bundleName: "com.example.provider",
      abilityName: "com.example.provider.MainAbility"
    },
    target: {
      bundleName: "com.example.provider",
      abilityName: "ets/pages/plugin2.js",
    },
    name: "plugintemplate",
    data: {
      "key_1": " myapplication plugin component test",
    },
    jsonPath: "",
  },
  (err, data) => {
    console.log("request_callback: componentTemplate.ability=" + data.componentTemplate.ability)
    console.log("request_callback: componentTemplate.source=" + data.componentTemplate.source)
  }
)

on

on(eventType: string, callback: OnPushEventCallback | OnRequestEventCallback ): void

提供者监听"request"类型的事件，给使用者返回通过request接口主动请求的数据；使用者监听"push"类型的事件，接收提供者通过push接口主动推送的数据。

参数：

参数名类型必填说明
eventTypestring是监听的事件类型， 可选值为："push" 、"request"。
"push”：指组件提供者向使用者主动推送数据。
"request”：指组件使用者向提供者主动请求数据。
callbackOnPushEventCallback | OnRequestEventCallback是对应监听回调，push事件对应回调类型为OnPushEventCallback，request事件对应回调类型为OnRequestEventCallback 。

示例：

import pluginComponentManager from '@ohos.pluginComponent'
import Want from '@ohos.app.ability.Want';
function onPushListener(source:Want, template:PluginComponentTemplate, data:pluginComponentManager.KVObject, extraData:pluginComponentManager.KVObject) {
  console.log("onPushListener template.source=" + template.source)
  console.log("onPushListener source=" + JSON.stringify(source))
  console.log("onPushListener template=" + JSON.stringify(template))
  console.log("onPushListener data=" + JSON.stringify(data))
  console.log("onPushListener extraData=" + JSON.stringify(extraData))
}
function onRequestListener(source:Want, name:string, data:pluginComponentManager.KVObject) {
  console.error("onRequestListener");
  console.log("onRequestListener source=" + JSON.stringify(source));
  console.log("onRequestListener name=" + name);
  console.log("onRequestListener data=" + JSON.stringify(data));
  let RtnData:Record<string,string|pluginComponentManager.KVObject> = { 'template': "ets/pages/plugin.js", 'data': data }
  return RtnData;
}
pluginComponentManager.on("push", onPushListener)
pluginComponentManager.on("request", onRequestListener)

external.json文件说明

external.json文件由开发者创建。external.json中以键值对形式存放组件名称以及对应模板路径。以组件名称name作为关键字，对应模板路径作为值。

示例

{
  "PluginProviderExample": "ets/pages/PluginProviderExample.js",
  "plugintemplate2": "ets/pages/plugintemplate2.js"
}

最后

有很多小伙伴不知道学习哪些鸿蒙开发技术？不知道需要重点掌握哪些鸿蒙应用开发知识点？而且学习时频繁踩坑，最终浪费大量时间。所以有一份实用的鸿蒙（HarmonyOS NEXT）资料用来跟着学习是非常有必要的。 

这份鸿蒙（HarmonyOS NEXT）资料包含了鸿蒙开发必掌握的核心知识要点，内容包含了（ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、Harmony南向开发、鸿蒙项目实战等等）鸿蒙（HarmonyOS NEXT）技术知识点。

希望这一份鸿蒙学习资料能够给大家带来帮助，有需要的小伙伴自行领取，限时开源，先到先得~无套路领取！！

获取这份完整版高清学习路线，请点击→纯血版全套鸿蒙HarmonyOS学习资料

鸿蒙（HarmonyOS NEXT）最新学习路线

  •  HarmonOS基础技能

  • HarmonOS就业必备技能 
  •  HarmonOS多媒体技术

  • 鸿蒙NaPi组件进阶

  • HarmonOS高级技能

  • 初识HarmonOS内核 
  • 实战就业级设备开发

有了路线图，怎么能没有学习资料呢，小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙（OpenHarmony ）学习手册（共计1236页）与鸿蒙（OpenHarmony ）开发入门教学视频，内容包含：ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。

获取以上完整版高清学习路线，请点击→纯血版全套鸿蒙HarmonyOS学习资料

《鸿蒙 (OpenHarmony)开发入门教学视频》

《鸿蒙生态应用开发V2.0白皮书》

图片

《鸿蒙 (OpenHarmony)开发基础到实战手册》

OpenHarmony北向、南向开发环境搭建

图片

 《鸿蒙开发基础》

  • ArkTS语言
  • 安装DevEco Studio
  • 运用你的第一个ArkTS应用
  • ArkUI声明式UI开发
  • .……

图片

 《鸿蒙开发进阶》

  • Stage模型入门
  • 网络管理
  • 数据管理
  • 电话服务
  • 分布式应用开发
  • 通知与窗口管理
  • 多媒体技术
  • 安全技能
  • 任务管理
  • WebGL
  • 国际化开发
  • 应用测试
  • DFX面向未来设计
  • 鸿蒙系统移植和裁剪定制
  • ……

图片

《鸿蒙进阶实战》

  • ArkTS实践
  • UIAbility应用
  • 网络案例
  • ……

图片

 获取以上完整鸿蒙HarmonyOS学习资料，请点击→纯血版全套鸿蒙HarmonyOS学习资料

总结

总的来说，华为鸿蒙不再兼容安卓，对中年程序员来说是一个挑战，也是一个机会。只有积极应对变化，不断学习和提升自己，他们才能在这个变革的时代中立于不败之地。

标签：插件,管理器,log,KVObject,HarmonyOS,鸿蒙,组件,console,data
From： https://blog.csdn.net/2401_84194030/article/details/139278911

相关文章

  • HarmonyOS实战开发：@ohos.router （页面路由）
    本模块提供通过不同的url访问不同的页面，包括跳转到应用内的指定页面、同应用内的某个页面替换当前页面、返回上一页面或指定的页面等。说明本模块首批接口从APIversion8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。页面路由需要在页面渲染完成之后......
  • HarmonyOS实战开发：@ohos.promptAction （弹窗）
    创建并显示文本提示框、对话框和操作菜单。说明：本模块首批接口从APIversion9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。该模块不支持在UIAbility的文件声明处使用，即不能在UIAbility的生命周期中调用，需要在创建组件实例后使用。本模块功能依赖UI的......
  • HarmonyOS SDK助力中国建设银行探索金融领域创新场景
    今年年初，中国建设银行（以下简称建行）手机银行首批适配HarmonyOSNEXT，并高效实现其应用的核心功能迁移。同时，建行手机银行在HarmonyOSSDK的加持下，充分发挥鸿蒙原生应用在原生智能方面的优势，让用户尽享更高效便捷的线上金融服务。HarmonyOSSDK场景化控件助力建行高效开发自建行加......
  • 鸿蒙HarmonyOS实战-Web组件（前端函数和应用侧函数相互调用）
    ......
  • vue3项目使用pinia状态管理器----通俗易懂
    1、首先安装piniayarnaddpinia#或使用npmnpminstallpinia2、在项目的src目录下新建store文件夹，然后store目录下新建index.js/index.ts：我这里是index,jsimport{createPinia}from"pinia"//创建Pinia实例constpinia=createPinia()//导出Pinia......
  • @PostConstruct 注解方法 mybatis-plus分页插件 PageHelper失效
    需求：启动项目把某些高频搜索的数据，放入到缓存中；现象：利用@PostConstruct项目启动加载，但是并没有做到分页，而是降所有数据放入的redis中，出现问题 @PostConstruct注解方法mybatis-plus分页插件PageHelper失效@PostConstructpublicvoidinit(){longkeyStartTime......
  • 【HarmonyOS】JSON格式化解析Map数据
    将数组转换成Map对象，然后调用letstr=JSON.stringify(newMap)，将Map转换成字符串，转换出来的结果是{}Api11以上Object.fromEntries不可用【解决方案】exportclassJsonUtil{//json字符串转为mapstaticjsonParseMap(jsonStr:string){letjsonObj:Record<......
  • Python轻量级的插件框架库之pluginbase使用详解
    概要在软件开发中，插件系统是一个常见的需求。插件系统允许开发者动态加载和卸载功能模块，从而提高应用程序的灵活性和可扩展性。Python的pluginbase库是一个轻量级的插件框架，旨在简化插件系统的构建过程。pluginbase库提供了一套简单易用的API，使开发者能够快速集成插件功能。......
  • 【HarmonyOS Next】游戏对接鸿蒙系统
    一、开发环境要求Unityversions：需要更新到Unity2022LTS然后使用最新团结引擎：https://unity.cn/tuanjie/releasesDevEcoStudioBuildVersion:4.1.3.600及以上版本TargetAPI:11orlaterhvigor版本:4.1.1hvigor-ohos-plugin版本:4.1.1hvigor-ohos-arkui-x-......
  • 2024年流行效果插件，助你打造非凡设计！
    设计图片太普通了？加班挑细节？你不能达到你想要的效果吗？作为一名设计师，你总是无法逃脱这样的噩梦！如何改变工作中的类似困境？除了提高自我设计技能外，选择一些辅助效果插件“插件”也非常重要。所谓的“软件不够，效果插件”，设计工具本身没有功能，可以通过安装效果插件来弥补。如今，市......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99