- 🏠 简介
- 🔌 api接口
-
🔧 插件开发
- 介绍
- 插件优势
- 新建插件
- 技术栈
- 插件开发规范
- 插件目录结构
- model 层开发
- service 层开发
- api 接口开发
- menu 菜单开发
-
event 事件钩子开发
- 开发指南
- 常用事件
- SiteInit 站点初始化事件
- AddSiteAfter 站点创建后事件
- MemberRegister 会员注册后事件
- MemberLogin 会员登录后事件
- PayCreate 支付创建事件
- PaySuccess 支付成功事件
- RefundSuccess 退款成功事件
- TransferSuccess 转账成功事件
- BottomNavigation 底部导航事件
- NoticeData 消息模板数据内容事件
- GetQrcodeOfChannel 创建二维码事件
- ExportDataType 导出数据类型事件
- ExportData 导出数据源事件
- GetPosterType 海报类型事件
- GetPosterData 海报数据事件
- ShowCustomer 应用管理加载事件
- GetWechatTransferTradeScene 微信支付转账场景事件
- ThemeColor 主题风格事件
- initWap 手机端初始化加载事件
- dict 数据字典开发
- layout 自定义布局开发
- job 消息队列和计划任务开发
- notice 消息发送开发
- printer 小票打印模板开发
- export 数据导出开发
- diy 自定义组件/页面装修开发
- diy 自定义表单组件开发
- poster 自定义海报开发
- icon 引入图标
- 支付方式开发
- upgrade 插件版本升级
- 打包插件
- 授权信息变更回调通知
- 官网上架
- 📝 二次开发须知
- 👨💻 二次开发指导
-
🎬 二次开发应用插件视频教程
- 二次开发安装视频教程
- 准备工作与创建插件
- 插件目录整体说明
- 插件admin目录
- 插件app目录说明(adminapi、api、验证器)
- 插件app目录(dict、job)
- 插件app目录说明(lang、listener)
- 插件app目录说明(model、service)
- 插件uniapp目录说明
- 插件开发之后台功能开发(代码生成器)
- 插件开发之uniapp功能开发(api)第一节
- 插件开发之uniapp功能开发(api)第二节
- 插件开发之uniapp功能开发(api)第三节
- 插件安装与打包原理
- 消息队列开发
- 计划任务开发
- DIY组件和自定义页面装修开发
- 支付接口开发
- 插件升级包打包流程以及云编译功能
uni-app 端开发规范
页面配置规范
pages.json 作为 uni-app 的核心配置文件,承载着整个应用的页面路由、导航栏样式、底部TabBar等重要配置。在配置过程中需要严格遵循以下原则:
-
路径规范 :页面路径必须以"app/pages/"开头,确保与目录结构保持一致
-
国际化支持 :所有导航栏标题必须使用语言包键名,格式为"%pages.xxx.xxx%",严禁硬编码文本
-
平台差异化处理 :合理使用条件编译,针对不同平台设置差异化样式
-
登录权限控制 :需要登录的页面必须显式声明"needLogin": true
页面组件开发标准
每个页面组件都应该遵循统一的结构和命名规范,确保代码的可读性和可维护性
组件设计原则
组件是构建用户界面的基本单元,良好的组件设计能够提高代码复用性和可维护性。在开发过程中需要遵循以下原则:
-
单一职责原则 :每个组件应该只负责一个功能,避免组件过于复杂
-
props向下传递 :数据通过props自上而下传递,避免逆向数据流
-
事件向上传递 :子组件通过emit向父组件传递事件
-
样式隔离 :组件样式必须使用scoped,避免样式污染
Pinia Store设计原则
状态管理是大型应用的核心,良好的状态设计能够确保数据流的清晰和可预测性:
-
状态单一化 :避免在多个地方存储相同的状态
-
状态最小化 :只存储必要的状态,派生状态通过计算属性获取
-
异步操作集中化 :所有的异步操作都放到actions中处理
-
状态持久化 :重要状态需要持久化到本地存储
WindiCSS使用规范
WindiCSS作为原子化CSS框架,能够极大提高样式开发效率,但需要遵循一定的使用规范:
-
优先使用原子类 :能用原子类实现的样式不要使用自定义CSS
-
响应式设计 :使用断点前缀实现响应式布局
-
主题色彩 :使用CSS变量确保主题一致性
-
性能优化 :避免过度嵌套,控制样式复杂度