网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

在线开发AstroZero高级页面自定义组件

更新时间:2024-12-12 GMT+08:00
分享

操作场景

当AstroZero低代码平台提供的预置高级组件无法满足您的开发需求时,开发者可以自定义组件包,并上传到AstroZero中。自定义组件包上传到AstroZero中后,可在高级页面中使用。自定义组件的开发流程如下:

  1. 下载组件模板

    将AstroZero系统预置的模板到本地。

  2. 开发自定义组件

    基于下载的模板,在本地根据自身业务需求开发组件。

  3. 上传组件到组件库并使用组件

    将开发完的自定义组件上传到组件库,并在高级页面中使用。

本章节以开发网站中常用的标签切换页面为例,向您介绍如何基于组件模板在线开发组件。参考消费者业务网站(如图1所示),页面中主要包含标签栏详情展示模块两部分,可以通过切换标签来控制详情展示模块中的展示内容。

图1 消费者业务网站示例

本章节主要在高级页面中,通过两个组件(标签页组件信息展示组件)复现上述场景。其中,标签页组件包含产品类别(手机、笔记本、平板等),信息展示组件用于展示不同产品类别的图片信息。两个组件通过事件-动作机制实现交互,在标签页组件中注册标签切换事件,此事件绑定信息展示组件中切换产品图片的动作。

说明:

本章节使用的示例组件开发过程中,使用了前端开发框架Vue及组件库Element事件-动作机制的详细介绍,请参见添加事件或宏实现AstroZero高级页面组件交互

下载组件模板

  1. 进入AstroZero服务控制台
  2. 在主页中,单击“进入首页”,进入AstroZero应用开发页面。
  3. 在应用开发页面,单击,选择环境管理 > 环境配置,进入环境配置。
  4. 在顶部主菜单中,选择“维护”。
  5. 在左侧导航栏中,选择“全局元素 > 页面资产管理 > 组件模板”。

    在组件模板页面,您可以查看到系统预置的几种Widget模板。

    表1 组件模板列表

    组件模板名称

    功能

    widgetVue3Template

    自定义组件需要使用Vue库时,请选用该模板。

    widgetPropertyTemplate

    自定义组件需要通过自定义属性栏配置属性时,请选用该模板。

    widgetActionTemplate

    自定义组件需要添加动作属性时,请选用该模板。该类型组件开发过程,请参考添加事件或宏实现AstroZero高级页面组件交互

    widgetEventTemplate

    自定义组件需要添加事件属性时,请选用该模板。该类型组件开发过程,请参考在线开发AstroZero高级页面自定义组件

    widgetBridgeTemplate

    自定义组件需要通过桥接器调用后台数据时,请选用该模板。该类型组件开发过程,请参考使用桥接器为AstroZero高级页面组件绑定数据

    widgetPageMacroTemplate

    需要使用页面宏来存储变量时,请选用该模板。

  6. 下载组件模板。

    根据需求选择模板,在组件模板详情页中单击“下载”按钮,在“下载组件模板”弹窗中输入组件名称,单击“保存”按钮即可。

    本章节示例中同时开发标签页组件信息展示组件,由于本例中组件基于Vue框架实现,所以优先选择widgetVue3Template模板,标签页组件取名为TabsWidget,信息展示组件取名为DisplayWidget。模板组件下载方法如下图所示(以下载TabsWidget为例):

    图2 下载组件模板示例
    图3 保存模板
    须知:

    如果选择“下载原始模板”,下载到本地的组件包中,组件名称不会被修改。

开发自定义组件

  1. 初识组件文件结构。

    将下载到本地的组件包进行解压,使用您熟悉的开发工具进行开发。本章节以下载组件模板中下载的TabsWidget组件为例,介绍组件包的文件结构以及各文件的功能。

    表2 组件文件结构

    文件名

    文件说明

    TabsWidget.js

    组件逻辑文件,整个Widget的渲染核心JS,在组件编辑状态和页面最终的发布运行态都会被加载执行。主要包含的预置API说明,请参见高级页面组件中预置的API

    TabsWidget.editor.js

    组件属性定义文件,负责组件在编辑状态时,需要渲染的界面和逻辑。“*.editor.js”只在组件编辑状态被加载,主要包含:

    • propertiesConfig:主要负责组件配置页面中,右侧的属性配置逻辑。
    • create方法仅在组件首次被创建时,调用一次。

    TabsWidget.css

    组件的样式文件,在该文件中编写组件的CSS样式。

    TabsWidget.ftl

    组件DOM结构文件,需要在服务端提前渲染的部分可以写在此文件中,相当于HTML文件,负责样式展示。

    packageinfo.json

    组件的元数据描述文件,定义了如下内容。

    • widegtApi name:组件的名称。
    • widgetDescription:组件的描述信息。
    • authorName: :组件的作者信息。
    • localFileBasePath:组件本地调测路径。
    • i18n:指定组件的国际化资源文件(本例模板中未体现)。
    • requires:依赖的库名称和版本号。
    • width:在绝对布局高级页面中,添加该组件时的默认宽度,单位为px,不填写默认为200px(本例模板中未体现)。
    • height:在绝对布局高级页面中,添加该组件时的默认高度,单位为px,不填写默认为200px(本例模板中未体现)。

    messages-zh/messages-en.json

    组件的国际化资源文件,用于配置多语言(本例模板中未体现)。

  2. 组件DOM结构及逻辑编写。

    • TabsWidget组件
      1. 在TabsWidget组件包TabsWidget.js文件中的render函数下,修改注册的Vue实例。
                    const app = Vue.createApp({
                        data() {
                          return {
                            activeName: "phone",
                            //定义页签栏中的所含项目
                            tabs: [
                              {label:"手机",name:"phone"},
                              {label:"笔记本",name:"PC"},
                              {label:"平板",name:"pad"},
                              {label:"智慧屏",name:"HiSilicon"},
                              {label:"穿戴",name:"wearableDevice"}
                            ]
                          }
                        },
                        methods:{
                          //此函数在切换页签时触发,用于触发后续步骤中TabsWidget组件注册的切换页签事件
                          handleClick: function () {
                            thisObj.triggerEvent("switchingTab", {param: this.activeName});
                          }
                        }
                    });
                    app.use(ElementPlus);
                    thisObj.vm = app.mount($("#Tabswidget", elem)[0]);
                }
      2. 在TabsWidget组件包TabsWidget.ftl文件中,修改DOM结构。
        <div id="TabsWidget">
           <!-- 此处用到了Element提供的el-tabs组件  -->
           <el-tabs v-model="activeName" @tab-change="handleClick">
              <el-tab-pane
                      v-for="(tab, index) in tabs"
                      :key="index"
                      :label="tab.label"
                      :name="tab.name"
              ></el-tab-pane>
           </el-tabs>
        </div>
    • DisplayWidget组件
      1. 在DisplayWidget组件包DisplayWidget.js文件中的render函数下,修改注册的Vue实例。
                    const app = Vue.createApp({
                        data() {
                            return {
                                imgSrc: widgetBasePath + "img/phone.jpg",
                                //定义信息展示组件中展示的图片路径信息
                                sources: {
                                    phone: widgetBasePath + "img/phone.jpg",
                                    PC: widgetBasePath + "img/PC.jpg",
                                    pad: widgetBasePath + "img/pad.jpg",
                                    HiSilicon: widgetBasePath + "img/hisilicon.jpg",
                                    wearableDevice: widgetBasePath + "img/wearableDevice.jpg"
                                }
                            }
                        },
                        methods:{
                            //此方法将在后续步骤中DisplayWidget组件注册的切换展示信息的动作中调用
                            switchPic: function (param) {
                                this.imgSrc = this.sources[param];
                            }
                        }
                    });
                    thisObj.vm = app.mount($("#showtabs", elem)[0]);
                }
        须知:
        • 上述代码中定义的展示图片文件可使用其他图片代替,将图片放到DisplayWidget目录中即可正常使用。
        • 本示例代码中,widgetBasePath变量为组件包上传后的路径,在组件模板中已包含获取此变量的逻辑,在此直接使用即可(此例也展示了组件中如何引入本地图片的基本方法)。
      2. 在DisplayWidget组件包DisplayWidget.ftl文件中,实现DOM结构。
        <div id="showTabs">
           <img :src="imgSrc">
        </div>

  3. 注册、实现事件和动作。

    1. TabsWidget组件包TabsWidget.js文件中的init函数中,注册页签切换的事件
      if((typeof(Studio) != "undefined") && Studio)
      {
          var sendEventConfig = [{
              "name": "param"
          }];
          Studio.registerEvents(
              thisObj,
              "switchingTab",
              {"zh_CN": "切换标签", "en_US": "Switching Tab"},
              sendEventConfig
          );
      }
    2. DisplayWidget组件包DisplayWidget.js文件中的init函数中,注册切换展示图片的动作
          init: function()
          {
              var thisObj = this;
              thisObj._super.apply(thisObj, arguments);
              thisObj.render();
              if ((typeof(Studio) != "undefined") && Studio)
              {	
                  Studio.registerAction(
                      thisObj,
                      "switchingPicture",
                      "switchingPicture",
                      [],
                      $.proxy(thisObj.switchingPicture, thisObj),
                      []
                  );
              }
          },

      DisplayWidget组件包DisplayWidget.js文件中的组件示例中(即与init和render方法在同级作用域)实现上述注册的动作,示例代码如下所示:

      switchingPicture: function (event) {
          if (event && event.eventParam) {
              this.vm.switchPic(event.eventParam.param);
          }
      }
      说明:

      “DisplayWidget.js”文件中第一行代码“var DisplayWidget = StudioWidgetWrapper.extend();”,其含义为新建的自定义组件继承于AstroZero平台定义的StudioWidgetWrapper类,此为开发规范,基于此类开发的自定义组件可以使用平台提供的如下方法:

      • “var widgetProperties = thisObj.getProperties(); ”用于获取组件的自定义属性配置值。
      • “var elem = thisObj.getContainer();” 用于获取组件的DOM元素。
      • “var connectorProperties = thisObj.getConnectorProperties();” 用于获取组件的桥接器属性配置值。

  4. 定义组件依赖库及组件在绝对布局中默认尺寸。

    本节开发的示例组件TabsWidget依赖Vue和Element库,DisplayWidget依赖Vue库。所依赖的Vue库已在之前选择的组件模板“widgetVueTemplate”中定义,这里只需要在TabsWidget组件包的packageinfo.json文件中定义所依赖的Element库即可。

    1. 在新版环境配置中,查看库ID和版本号。

      以查询ElementPlus库为例,在AstroZero环境配置的“维护 > 全局元素 > 页面资产管理 > 库”,搜索库,查看库ID和版本号信息。

      图4 查询库信息
      图5 查看库版本和ID

      本例中查询的ElementPlus库ID为:global_ElementPlus,库最新版本号为:2.6.0

    2. 在TabsWidget组件包的packageinfo.json中,修改requires、width、height属性。
      示例代码如下所示:
      "requires": [
          {
            "name": "global_Vue3",
            "version": "3.3.4"
          },
          {
            "name": "global_ElementPlus",
            "version": "2.6.0"
          }
      ],
      "width": "900",
      "height": "55",
    3. DisplayWidget组件只依赖Vue库,且在下载时选择的widgetVue3Template组件模板,所依赖的Vue库已在模板中定义,本例无需修改,只需修改width、height属性。
      示例代码如下所示:
      "width": "900",
      "height": "560",

上传组件到组件库并使用组件

  1. 上传自定义组件。

    1. 将开发好的组件代码压缩到后缀为.zip的压缩文件中,如TabsWidget.zip、DisplayWidget.zip。
    2. 在AstroZero环境配置页面的“维护 > 全局元素 > 页面资产管理 > 组件”,单击“提交新组件”。
    3. 在提交新组件页面,设置组件基本信息,并上传压缩文件,单击“提交”。
      图6 上传自定义组件示例
      表3 上传组件参数说明

      参数

      说明

      名字

      新提交组件的名称,系统会根据组件包名称自动填充。

      示例:TabsWidget

      上传图标

      组件的显示图标。

      上传源文件

      组件源文件包,单击“请选择源文件(.zip)”,可选择源文件上传。

      组件ID

      资产ID,前缀不可编辑,上传组件包后会自动填写。

      分类

      组件所属分类,上传组件后,该组件将会在页面的该分类下进行展示。

      领域

      组件包应用的领域,一般保持默认“通用”。

      场景

      组件包的应用场景。

      • 高级页面:组件适用于高级页面开发场景。
      • 标准页面:组件适用于标准页面开发场景。
      • 业务大屏:组件适用于Astro Canvas大屏页面开发场景。
      • 业务小屏:组件适用于Astro Canvas小屏页面开发场景。

      可同时勾选多项,勾选后,在相应类型页面开发中,才可使用该组件,本示例选择“高级页面”

      发行说明

      组件的描述信息,需要配置不同语种下的描述信息。

      此处配置的信息,将会在组件详情页的“概况”页签中进行展示。

  2. 组件功能测试。

    1. 在高级页面中,分别拖入上传的示例组件TabsWidget和DisplayWidget,并调整布局。
      图7 拖入组件调整布局
    2. 选中TabsWidget组件,在右侧“事件”页签,单击“切换标签”后的
    3. 在“编辑事件 ”页面,单击“新建动作”,选择“DisplayWidget > 切换图片”。
    4. 单击“确定”,完成组件间交互设置。
    5. 在页面上方,单击,保存高级页面。
    6. 单击,发布页面,打开发布的页面网址测试效果。

      单击TabsWidget组件上的标签栏,会在DisplayWidget组件详情页进行相应的切换展示。

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容