ERPTurbo_Admin/.lingma/rules/biz.md
shenyifei cc15943d44 feat(biz): 添加Biz组件库设计规则和技术文档
- 创建.biz.md文件定义Biz组件库设计规则
- 创建design.md文件编写ERPTurbo_Admin项目技术文档
- 定义组件架构模式、类型系统和统一属性模式
- 添加权限控制机制和数据交互模式说明
- 完善项目核心技术栈和架构说明
2025-11-10 15:52:34 +08:00

3.6 KiB
Raw Permalink Blame History

trigger
manual

Biz组件库设计规则

1. 组件架构模式

Biz组件库采用统一的业务组件架构主要包含以下几类组件

  1. 核心容器组件

  2. 业务功能组件

  3. 操作型组件

2. 类型系统设计

所有组件都采用泛型设计,主要泛型参数包括:

  • Func: API函数类型
  • BizVO: 视图对象类型
  • BizPageQry: 查询参数类型
  • BizCreateCmd: 创建命令类型
  • BizUpdateCmd: 更新命令类型

3. 统一属性模式

所有Biz组件都遵循统一的属性设计模式

  1. API相关属性

    • func: API函数集合
    • method: 方法名前缀
    • methodUpper: 首字母大写的方法名前缀
    • rowKey: 主键字段名
  2. 权限与国际化

    • permission: 权限标识
    • intlPrefix: 国际化前缀
  3. 表单类型

    • formType: 表单类型modal/drawer/step

4. 响应式设计

组件通过isMobile属性自动适配移动端,主要体现在:

  • 表单宽度自动调整
  • 操作按钮布局优化
  • 操作栏按钮数量自适应

5. 权限控制机制

使用ButtonAccess组件实现细粒度权限控制,权限标识通过permission属性自动拼接操作类型(如-create、-update、-delete、-view

6. 数据交互模式

  1. 数据获取:通过func中的方法调用API方法名由methodUpper和操作类型组合而成
  2. 数据提交:表单提交时自动移除包含"VO"的字段
  3. 状态管理:使用actionRef进行组件间状态同步