构件规范
构件规范文档。
构件分类主要是为了实现业务分离，方便产品的定制、开发、扩展和维护。
根据需求可分类为以下构件:
| 业务分类 | 强制 | 命名规范 | 作用 |
|---|---|---|---|
| 表构件 | 必须 | XXXX_ XXXX _ db | ① 定义数据表 ② 初始化基础数据 ③ 输出数据表更新、删除方法 |
| 业务pc | 必须 | XXXX_ XXXX _ pc | ①日常业务表单 |
| 业务移动 | 可选 | XXXX_ XXXX _ mb | ① 移动端业务申请、审批 ② 移动端业务查询、统计分析 ③ 输出移动端消息推送 |
| 查询&统计构件 | 必须 | XXXX_ XXXX _qry | ① 业务单据查询 ② 常用统计查询 |
| 数据看板 | 必须 | XXXX_ XXXX _dbboard | |
| 工作流构件 | 必须 | XXXX_ XXXX _wf | ① 业务表单提交、退回、加签、转办…. |
| 业务基础设置 | 可选 | XXXX_ XXXX _initset | ①初始化基础数据 |
| API构件 | 可选 | XXXX_ XXXX _api | ① 输出API接口，主要用于系统/业务集成 |
| EP构件 | 可选 | XXXX_ XXXX _ep | ① API扩展点实现 |
| 打印 | 可选 | XXXX_ XXXX _print | |
| 报表 | 可选 | XXXX_ XXXX _report | |
| 权限定义 | 可选 | XXXX_ XXXX _limit |
tip
- 表构件中需要有各个业务表保存、删除、修改（视情况而定，如修改的字段少且字段编码是固定的（例如修改单据的审批状态），可单独提供修改数据的接口，如修改的字段个数不固定，可用保存方法修改数据）接口。
- 业务表不直接输出，新建查询查询表的所有字段。
info命名规范:
- 构件编码：
公司/产品/项目（编码）_功能模块（编码）_构件用途（可参考构件粒度）
- 分为三块（如第三块业务功能过多需要再细分，在此基础上再添加一块功能描述，但前三块编码必须要一致，最多分四块；如超过新建一个构件）。
- 构件名称：
公司/产品/项目（名称）_功能模块（名称）_构件用途（可参考构件粒度）
- 分为二块（从项目名称开始做为第一块：如业务功能需要再细分，命名规则同编码一致）。
- 每块编码/名称之间用下划线
_连接。- 每个构件必须同时确定一个英文编码和中文名，且该名称必须全系统唯一。
- 构件必须定义对应的中文名称。
示例:
| 构件 | 命名方式 | 表构件(例子) |
|---|---|---|
| 构件编码 | 公司/产品/项目（编码）_功能模块（编码）_构件用途（可参考构件粒度） | toone_contract_customer_db |
| 构件名称 | 公司/产品/项目（名称）_功能模块（名称）_构件用途（可参考构件粒度） | 同望_合同管理_客户信息_表 |
tip
- 针对业务功能/菜单，拆分业务构件，即：一个业务活动一个业务构件。
- 如果是项目名，取项目或者客户名简拼，并与vbase顶级机构编码保持一致。
更多示例:
| 构件粒度 | 表构件(例子) | 业务pc(例子) | 业务移动(例子) | 报表(例子) |
|---|---|---|---|---|
| 构件编码 | toone_contract_customer_db | toone_contract_login_pc | toone_contract_im_mb | toone_contract_customer_report |
| 构件名称 | 同望_合同管理_客户信息_表 | 同望_合同管理_登陆_PC | 同望_合同管理_即时沟通_mb | 同望_合同管理_客户信息_报表 |