极简弹窗封装,基于 @kit.ArkUI 封装通用工具类
在日常鸿蒙开发中弹窗是最高频的交互组件之一操作反馈用 Toast、二次确认用对话框、加载状态用等待框、多选操作用底部菜单。原生kit.ArkUI虽然提供了完整的弹窗能力但每次调用都要重复写参数、统一样式麻烦页面多了之后维护成本很高。本文带你基于鸿蒙官方原生 API封装一套零依赖、可直接复用的通用弹窗工具类涵盖 Toast、确认对话框、加载框、底部操作菜单四大高频场景一行代码即可调用全局样式统一新手也能快速上手。一、为什么要做统一弹窗封装零散调用原生 API 看似简单项目迭代起来会暴露很多问题重复代码多每次调用都要手写 message、duration、回调等参数样板代码冗余样式不统一不同开发人员写的弹窗圆角、字号、颜色参差不齐视觉体验割裂容易出bug快速重复点击会弹出多层弹窗、页面销毁后未关闭弹窗导致内存泄漏维护成本高后续要改弹窗样式需要逐个页面修改工作量大且容易遗漏统一封装后所有弹窗逻辑收敛到一个工具类一处修改全项目生效调用方式极简能大幅提升开发效率。二、封装原则与依赖说明本次封装严格遵循三个原则保证实用性与兼容性纯原生实现全部基于kit.ArkUI官方 API无任何第三方依赖兼容 API 12 全版本极简调用静态方法 通用组件多数场景一行代码即可触发渐进式接入可以只单独用 Toast也可以全套接入不强制绑定防呆设计内置防抖、防重复弹出逻辑规避新手常见错误三、完整工具类实现新建文件entry/src/main/ets/utils/DialogUtils.ets以下所有代码都放在这个文件中复制即可直接使用。3.1 基础工具Toast 底部操作菜单这两类弹窗不需要额外 UI 组件直接封装为静态方法导入即可调用零配置成本。import{promptAction}fromkit.ArkUI;import{hilog}fromkit.PerformanceAnalysisKit;constTAGDialogUtils;/** * 通用弹窗工具类 * 基于kit.ArkUI原生能力封装零第三方依赖 */exportclassDialogUtils{// Toast防抖标记避免快速重复调用堆叠privatestaticlastToastTime:number0;/** * 短Toast提示显示2秒 * param message 提示文本 */staticshowToast(message:string):void{constnowDate.now();if(now-this.lastToastTime1500)return;this.lastToastTimenow;promptAction.showToast({message:message,duration:2000,bottom:120});}/** * 长Toast提示显示3.5秒 * param message 提示文本 */staticshowLongToast(message:string):void{promptAction.showToast({message:message,duration:3500,bottom:120});}/** * 底部操作菜单ActionSheet * param title 弹窗标题 * param options 选项文本数组 * param onSelect 选中回调返回选中项索引 * param onCancel 取消回调 */staticshowActionSheet(title:string,options:string[],onSelect?:(index:number)void,onCancel?:()void):void{promptAction.showActionSheet({title:title,buttons:options.map(text({text:text})),success:(res){if(res.index!undefinedonSelect){onSelect(res.index);}},cancel:(){onCancel?.();},fail:(err){hilog.error(0x0000,TAG,ActionSheet调用失败:${JSON.stringify(err)});}});}}3.2 通用确认对话框基于CustomDialog封装标准化确认框支持自定义标题、内容、按钮文字与颜色统一项目内二次确认交互样式。/** * 通用确认对话框组件 */CustomDialogexportstruct ConfirmDialog{// 弹窗标题title:string提示;// 弹窗正文内容content:string;// 取消按钮文字cancelText:string取消;// 确认按钮文字confirmText:string确定;// 确认按钮主题色confirmColor:string#0A59F7;// 取消回调onCancel?:()void;// 确认回调onConfirm?:()void;build(){Column({space:20}){Text(this.title).fontSize(18).fontWeight(FontWeight.Medium).width(100%).textAlign(TextAlign.Center);Text(this.content).fontSize(15).fontColor(#666666).width(100%).textAlign(TextAlign.Center).lineHeight(22);Row({space:12}){Button(this.cancelText).layoutWeight(1).height(44).borderRadius(22).backgroundColor(#F5F5F5).fontColor(#333333).onClick((){this.controller.close();this.onCancel?.();});Button(this.confirmText).layoutWeight(1).height(44).borderRadius(22).backgroundColor(this.confirmColor).fontColor(#FFFFFF).onClick((){this.controller.close();this.onConfirm?.();});}.width(100%);}.width(85%).padding(24).backgroundColor(#FFFFFF).borderRadius(16);}}3.3 全局加载弹窗管理器封装带状态管理的加载弹窗内置防重复弹出逻辑全局统一调用无需每个页面单独维护。/** * 加载弹窗UI组件 */CustomDialogstruct LoadingDialog{loadingText:string加载中...;build(){Column({space:16}){LoadingProgress().width(48).height(48).color(#0A59F7);Text(this.loadingText).fontSize(14).fontColor(#666666);}.padding(24).backgroundColor(#FFFFFF).borderRadius(12);}}/** * 全局加载弹窗管理器 * 单例控制防止重复弹出 */exportclassLoadingManager{privatestaticcontroller:CustomDialogController|nullnull;privatestaticisShowing:booleanfalse;/** * 显示加载弹窗 * param text 加载提示文字 */staticshowLoading(text:string加载中...):void{if(this.isShowing)return;this.isShowingtrue;this.controllernewCustomDialogController({builder:LoadingDialog({loadingText:text}),autoCancel:false,alignment:DialogAlignment.Center,customStyle:true,backgroundColor:Color.Transparent});this.controller.open();}/** * 隐藏加载弹窗 */statichideLoading():void{if(this.controllerthis.isShowing){this.controller.close();this.isShowingfalse;this.controllernull;}}}四、页面调用完整示例下面是完整的演示页面展示四种弹窗的调用方式代码复制到页面文件即可直接运行。import{DialogUtils,ConfirmDialog,LoadingManager}from../utils/DialogUtils;EntryComponentstruct DialogDemoPage{// 确认对话框控制器页面内只需实例化一次privateconfirmDialog:CustomDialogControllernewCustomDialogController({builder:ConfirmDialog({title:温馨提示,content:确定要删除这条记录吗删除后无法恢复。,confirmText:删除,confirmColor:#FF4D4F,onConfirm:(){DialogUtils.showToast(删除成功);},onCancel:(){DialogUtils.showToast(已取消操作);}}),alignment:DialogAlignment.Center,customStyle:true,backgroundColor:Color.Transparent});aboutToDisappear(){// 页面销毁时强制关闭加载弹窗避免泄漏LoadingManager.hideLoading();}build(){Column({space:20}){Text(通用弹窗工具演示).fontSize(28).fontWeight(FontWeight.Bold).width(90%).margin({top:40});// 1. Toast演示Button(普通Toast提示).width(90%).height(50).borderRadius(25).onClick((){DialogUtils.showToast(操作成功);});Button(长Toast提示).width(90%).height(50).borderRadius(25).backgroundColor(#00B578).onClick((){DialogUtils.showLongToast(这是一条较长的提示信息显示3.5秒);});// 2. 确认对话框演示Button(删除确认对话框).width(90%).height(50).borderRadius(25).backgroundColor(#FF4D4F).onClick((){this.confirmDialog.open();});// 3. 加载弹窗演示Button(显示加载弹窗).width(90%).height(50).borderRadius(25).backgroundColor(#9B59B6).onClick((){LoadingManager.showLoading(数据加载中...);// 模拟2秒网络请求后关闭setTimeout((){LoadingManager.hideLoading();DialogUtils.showToast(加载完成);},2000);});// 4. 底部操作菜单演示Button(底部操作菜单).width(90%).height(50).borderRadius(25).backgroundColor(#F39C12).onClick((){DialogUtils.showActionSheet(请选择操作,[拍照,从相册选择,保存图片],(index){DialogUtils.showToast(选中了第${index1}项);});});Blank();}.width(100%).height(100%).backgroundColor(#F8F9FA);}}五、新手高频踩坑与最佳实践1. 快速重复点击弹出多层弹窗问题连续点击按钮会弹出多个 Toast 或对话框堆叠在一起体验很差解决工具类内置防抖标记位与状态判断比如 Toast 限制 1500ms 内不能重复触发加载弹窗通过isShowing防止重复创建2. 页面销毁后弹窗未关闭报错问题网络请求过程中退出页面加载弹窗没关闭后续回调执行时报空指针异常解决在页面aboutToDisappear生命周期中强制调用LoadingManager.hideLoading()确保页面销毁时所有弹窗同步关闭3. 自定义弹窗背景不透明问题CustomDialog 默认带系统灰色遮罩无法实现完全自定义的弹窗样式解决必须同时设置customStyle: true和backgroundColor: Color.Transparent才能去掉系统默认遮罩完全自定义弹窗外观4. 每个页面重复写对话框控制器优化建议如果项目中确认框使用非常频繁可以结合全局状态管理进一步封装做成全局服务无需每个页面单独创建控制器六、进阶扩展方向这套基础工具类覆盖了 80% 的日常弹窗场景还可以根据业务需求继续扩展自定义 Toast增加成功/失败图标、顶部弹出、带动画的高级 Toast输入框对话框在确认框基础上增加 TextInput支持文本、密码输入弹窗中间选择器封装日期选择、城市选择、枚举选择等通用选择弹窗全局弹窗队列多个弹窗按优先级排队显示避免同时弹出多个互相遮挡总结通用弹窗工具类是鸿蒙项目中性价比极高的基建封装几十行代码就能收敛所有弹窗逻辑既统一了项目视觉规范又减少了重复样板代码还能规避很多新手易犯的低级错误。对于新手建议直接复用本文的基础版本先满足日常开发需求随着项目迭代再逐步扩展更多弹窗类型沉淀成团队专属的 UI 组件库。