当前位置：首页 > news >正文

鸿蒙Harmony应用开发—ArkTS声明式开发（基础手势：PluginComponent）

news 2025/12/20 10:23:56

提供外部应用组件嵌入式显示功能，即外部应用提供的UI可在本应用内显示。

说明：

该组件从API Version 9开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
本组件为系统接口。

子组件

无

接口

PluginComponent(value: { template: PluginComponentTemplate, data: KVObject})

创建插件组件，用于显示外部应用提供的UI。

参数：

参数名	参数类型	必填	参数描述
value	{ template: PluginComponentTemplate, data: KVObject }	是	template: 组件模板，用于跟提供者定义的组件绑定。 data: 传给插件组件提供者使用的数据。

PluginComponentTemplate类型说明

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

属性

必须显式设置组件宽高为非0有效值。

说明：

模板支持两种提供方式：

1.使用绝对路径进行资源提供：source字段填写模板绝对路径，bundleName不需要填写。仅适用于不需要加载资源的单独模板页面，不建议使用。
2.通过应用包进行资源提供：bundleName字段需要填写应用包名；source字段填写相对hap包的模板相对路径，对于多hap场景，通过相对路径&模块名称的方式进行hap包的确认。

例如：{source：'pages/PluginProviderExample.ets&entry', bundleName:'com.example.provider'}

仅对FA模型支持source字段填写AbilityName进行模板提供。

例如：{source：'plugin', bundleName:'com.example.provider'}

事件

仅支持绑定手势方法，并分发给提供方页面，在提供方页面内部处理。

除支持通用事件，还支持以下事件：

名称	功能描述
onComplete(callback: () => void)	组件加载完成回调。
onError(callback: (info: { errcode: number, msg: string }) => void)	组件加载错误回调。 errcode: 错误码。 msg: 错误信息。

示例

组件使用方

//PluginUserExample.ets
import plugin from "./plugin_component"
interface Info{errcode:number,msg:string
}
@Entry
@Component
struct PluginUserExample {build() {Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {Text('Hello World').fontSize(50).fontWeight(FontWeight.Bold)Button('Register Request Listener').fontSize(30).width(400).height(100).margin({top:20}).onClick(()=>{plugin.onListener()console.log("Button('Register Request Listener')")})Button('Request').fontSize(50).width(400).height(100).margin({ top: 20 }).onClick(() => {plugin.Request()console.log("Button('Request')")})PluginComponent({template: { source: 'pages/PluginProviderExample.ets&entry', bundleName: 'com.example.plugin' },data: { 'countDownStartValue': 'new countDownStartValue' }}).size({ width: 500, height: 350 }).onComplete(() => {console.log("onComplete")}).onError((info:Info) => {console.log("onComplete" + info.errcode + ":" + info.msg)})}.width('100%').height('100%')}
}

组件提供方

//PluginProviderExample.ets
import plugin from "./plugin_component"@Entry
@Component
struct PluginProviderExample {@State message: string = 'no click!'build() {Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {Button('Register Push Listener').fontSize(30).width(400).height(100).margin({top:20}).onClick(()=>{plugin.onListener()console.log("Button('Register Push Listener')")})Button('Push').fontSize(30).width(400).height(100).margin({top:20}).onClick(()=>{plugin.Push()this.message = "Button('Push')"console.log("Button('Push')")})Text(this.message).height(150).fontSize(30).padding(5).margin(5)}.width('100%').height('100%').backgroundColor(0xDCDCDC).padding({ top: 5 })}
}

Plugin组件工具

FA模型

//当前示例代码仅适用于js源文件
//plugin_component.js
import pluginComponentManager from '@ohos.pluginComponent'function onPushListener(source, template, data, extraData) {console.log("onPushListener template.source=" + template.source)console.log("onPushListener template.ability=" + template.ability)console.log("onPushListener data=" + JSON.stringify(data))console.log("onPushListener extraData=" + JSON.stringify(extraData))
}function onRequestListener(source, name, data)
{console.log("onRequestListener name=" + name);console.log("onRequestListener data=" + JSON.stringify(data));return {template:"plugintemplate", data:data};
}export default {//register listeneronListener() {pluginComponentManager.on("push", onPushListener)pluginComponentManager.on("request", onRequestListener)},Push() {// 组件提供方主动发送事件pluginComponentManager.push({want: {bundleName: "com.example.plugin",abilityName: "com.example.myapplication.PluginProviderExample",},name: "PluginProviderExample",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() {// 组件使用方主动发送事件pluginComponentManager.request({want: {bundleName: "com.example.plugin",abilityName: "com.example.myapplication.PluginProviderExample",},name: "PluginProviderExample",data: {"key_1": "plugin component test","key_2": 34234},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))})}
}

Stage模型

//当前示例代码仅适用于js源文件
//plugin_component.js
import pluginComponentManager from '@ohos.pluginComponent'function onPushListener(source, template, data, extraData) {console.log("onPushListener template.source=" + template.source)console.log("onPushListener template.ability=" + template.ability)console.log("onPushListener data=" + JSON.stringify(data))console.log("onPushListener extraData=" + JSON.stringify(extraData))
}function onRequestListener(source, name, data)
{console.log("onRequestListener name=" + name);console.log("onRequestListener data=" + JSON.stringify(data));return {template:"plugintemplate", data:data};
}export default {//register listeneronListener() {pluginComponentManager.on("push", onPushListener)pluginComponentManager.on("request", onRequestListener)},Push() {// 组件提供方主动发送事件pluginComponentManager.push({owner: {bundleName: "com.example.myapplication",abilityName: "com.example.myapplication.MainAbility",},target: {bundleName: "com.example.plugin",abilityName: "com.example.myapplication.PluginProviderExample",},name: "PluginProviderExample",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() {// 组件使用方主动发送事件pluginComponentManager.request({owner: {bundleName: "com.example.myapplication",abilityName: "com.example.myapplication.MainAbility",},target: {bundleName: "com.example.plugin",abilityName: "com.example.myapplication.PluginProviderExample",},name: "PluginProviderExample",data: {"key_1": "plugin component test","key_2": 34234},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))})}
}

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

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

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

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

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

HarmonOS基础技能

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

鸿蒙NaPi组件进阶

HarmonOS高级技能

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

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

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