鸿蒙API13开发【@ohos.pluginComponent (PluginComponentManager)】UI界面API

鸿蒙绿头鱼

999人浏览 · 2024-12-19 16:51:14

鸿蒙绿头鱼 · 2024-12-19 16:51:14 发布

用于给插件组件的使用者请求组件与数据，使用者发送组件模板和数据。

说明

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

导入模块

import { pluginComponentManager } from '@kit.ArkUI'

PluginComponentTemplate

Plugin组件模板参数。

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

参数	类型	必填	描述
source	string	是	组件模板名。
ability	string	是	提供者Ability的bundleName。

PluginComponentManager

插件组件管理器。

KVObject

type KVObject = { [key: string]: number | string | boolean | [] | KVObject }

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

取值范围	说明
[key: string]	关键字，数据类型为字符串，可取空字符串。
number	键值，表示值类型为数字。
string	键值，表示值类型为字符串，可取空字符串。
boolean	键值，表示值类型为布尔值。
[]	键值，可取值为[]。
[KVObject]	键值，表示值类型为KVObject。

PushParameters

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

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

名称	类型	必填	说明
want	[Want]	是	组件使用者Ability信息。
name	string	是	组件名称。
data	[KVObject]	是	组件数据值。
extraData	[KVObject]	是	附加数据值。
jsonPath	string	否	存放模板路径的[external.json]件的路径。

RequestParameters

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

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

名称	类型	必填	说明
want	[Want]	是	组件提供者Ability信息。
name	string	是	请求组件名称。
data	[KVObject]	是	附加数据。
jsonPath	string	否	存放模板路径的[external.json]文件的路径。jsonPath字段不为空或者未设置的时候不触发Request通信。

RequestCallbackParameters

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

名称	类型	必填	说明
componentTemplate	[PluginComponentTemplate]	是	组件模板。
data	[KVObject]	是	组件数据。
extraData	[KVObject]	是	附加数据。

RequestEventResult

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

名称	类型	必填	说明
template	string	否	组件模板。
data	[KVObject]	否	组件数据。
extraData	[KVObject]	否	附加数据。

OnPushEventCallback

type OnPushEventCallback = (source: Want, template: PluginComponentTemplate, data: KVObject,

extraData: KVObject) => void

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

参数：

参数	类型	必填	说明
source	[Want]	是	Push请求发送方相关信息。
template	[PluginComponentTemplate]	是	Push请求发送方相关信息请求组件模板名称。
data	[KVObject]	是	数据。
extraData	[KVObject]	是	附加数据。

示例：

import { pluginComponentManager, PluginComponentTemplate } from '@kit.ArkUI'
import { Want } from '@kit.AbilityKit';

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

type OnRequestEventCallback = (source: Want, name: string, data: KVObject) => RequestEventResult

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

参数：

参数	类型	必填	说明
source	[Want]	是	request请求发送方相关信息。
name	string	是	模板名称。
extraData	[KVObject]	是	附加数据。

示例：

import { pluginComponentManager } from '@kit.ArkUI'
import { Want } from '@kit.AbilityKit';

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

push(param: PushParameters , callback: AsyncCallback): void

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

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

参数：

参数名	类型	必填	说明
param	[PushParameters]	是	组件使用者的详细信息。
callback	AsyncCallback	是	此次接口调用的异步回调。

示例：

import { pluginComponentManager } from '@kit.ArkUI'
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!");
  }
)

request

request(param: RequestParameters, callback: AsyncCallback): void

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

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

示例：

import { pluginComponentManager } from '@kit.ArkUI'
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))
  }
)

on

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

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

元服务API： 从API version 12开始，该接口支持在元服务中使用。

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

参数：

参数名	类型	必填	说明
eventType	string	是	监听的事件类型，可选值为：“push” 、“request”。"push”：指组件提供者向使用者主动推送数据。"request”：指组件使用者向提供者主动请求数据。
callback	[OnPushEventCallback]	[OnRequestEventCallback]	是

示例：

import { pluginComponentManager, PluginComponentTemplate } from '@kit.ArkUI'
import { Want } from '@kit.AbilityKit';
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"
}

最后呢

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

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

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

在这里插入图片描述

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

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

在这里插入图片描述

总结

鸿蒙—作为国家主力推送的国产操作系统。部分的高校已经取消了安卓课程，从而开设鸿蒙课程；企业纷纷跟进启动了鸿蒙研发。

并且鸿蒙是完全具备无与伦比的机遇和潜力的；预计到年底将有 5,000 款的应用完成原生鸿蒙开发，未来将会支持 50 万款的应用。那么这么多的应用需要开发，也就意味着需要有更多的鸿蒙人才。鸿蒙开发工程师也将会迎来爆发式的增长，学习鸿蒙势在必行！自↓↓↓拿

HarmonyOS开发者社区

讨论HarmonyOS开发技术，专注于API与组件、DevEco Studio、测试、元服务和应用上架分发等。

更多推荐

为什么 Redux 思想可能不再适合 HarmonyOS PC？

HarmonyOS开发者社区

动图魔方技术拆解 14：ArkUI 大型单页的 Tab 路由、状态拆分与空状态设计

HarmonyOS开发者社区

HarmonyOS开发：用户中心个人中心

个人中心的核心不是"画页面"，而是数据管理和隐私合规。每个功能都涉及用户敏感数据，处理不当就是安全事故。敏感数据加密存储，Token用HUKS硬件加密，手机号脱敏显示退出登录必须清理数据，本地敏感数据全清，保留非敏感设置隐私合规不是可选项，个人信息收集清单、第三方共享清单必须有评估维度说明学习难度⭐⭐⭐ 功能多但每个都不复杂，隐私合规需要关注使用频率⭐⭐⭐⭐⭐ 所有App都有个人中心重要程度⭐⭐⭐