- 创建.biz.md文件定义Biz组件库设计规则 - 创建design.md文件编写ERPTurbo_Admin项目技术文档 - 定义组件架构模式、类型系统和统一属性模式 - 添加权限控制机制和数据交互模式说明 - 完善项目核心技术栈和架构说明
3.6 KiB
3.6 KiB
| trigger |
|---|
| manual |
Biz组件库设计规则
1. 组件架构模式
Biz组件库采用统一的业务组件架构,主要包含以下几类组件:
-
核心容器组件:
- BizContainer - 主容器组件,协调其他业务组件
- PageContainer - 页面容器组件,处理权限验证
-
业务功能组件:
- BizPage - 分页表格组件
- BizTree - 树形结构组件
- BizDrag - 拖拽排序组件
- BizList - 列表展示组件
- BizCalender - 日历展示组件
-
操作型组件:
- BizCreate - 创建操作组件
- BizUpdate - 更新操作组件
- BizDetail - 详情查看组件
- BizDestroy - 删除操作组件
- BizImport - 批量导入组件
2. 类型系统设计
所有组件都采用泛型设计,主要泛型参数包括:
Func: API函数类型BizVO: 视图对象类型BizPageQry: 查询参数类型BizCreateCmd: 创建命令类型BizUpdateCmd: 更新命令类型
3. 统一属性模式
所有Biz组件都遵循统一的属性设计模式:
-
API相关属性:
func: API函数集合method: 方法名前缀methodUpper: 首字母大写的方法名前缀rowKey: 主键字段名
-
权限与国际化:
permission: 权限标识intlPrefix: 国际化前缀
-
表单类型:
formType: 表单类型(modal/drawer/step)
4. 响应式设计
组件通过isMobile属性自动适配移动端,主要体现在:
- 表单宽度自动调整
- 操作按钮布局优化
- 操作栏按钮数量自适应
5. 权限控制机制
使用ButtonAccess组件实现细粒度权限控制,权限标识通过permission属性自动拼接操作类型(如-create、-update、-delete、-view)。
6. 数据交互模式
- 数据获取:通过
func中的方法调用API,方法名由methodUpper和操作类型组合而成 - 数据提交:表单提交时自动移除包含"VO"的字段
- 状态管理:使用actionRef进行组件间状态同步