其他规范
其他规范文档。
1. 其他场景配置规范
1.1 公共方法
同个方法可在多处被使用的都可抽提为公共的方法。
例如:
1) 窗体加载事件的获取数据和点击查询/重置后的获取数据。 2) 保存和提交时的保存数据。 3) 选择窗体的点击确认和双击行。
注意:公共方法的抽提不是固定的,实际业务的不同,可抽提的方法也不一样。
1.2 批量导入
批量导入的数据如果需要二次处理,建议导入到中间表,数据处理之后再导入至业务表。
1.3 对外模块提供接口
对外提供的接口,接口内不直接做逻辑处理,可在扩展点中实现(扩展点放在单独的业务构件中),方便扩展。
例如:
项目A中 模块A、模块B 调用 模块C 的接口;
项目B中 模块A、模块B 完全复用(项目A的),模块C定制;
这种情况 模块C 只需要修改扩展点实现,模块A 和 模块B 不做修改。
1.4 流程启动结束事件
流程启动事件和流程结束事件需绑在流程而非活动节点上(绑定在活动节点上活动节点调整后需要重新绑定对应的活动集,表单绑定的流程相对来说是固定的)
1.5 服务端获取列表数据
如列表的数据通过服务端方法获取,列表需设置分页,需要配合分页控件使用,服务端的获取数据规则需设置为分页获取。(服务端获取全部数据,列表设置分页,分页不生效)。
1.6 数据库-索引
常用的查询字段添加索引。
2. 表优化(建索引)
在建表时建索引可以提高系统的性能和检索速度,但也添加了维护的难度和占物理空间;所以应根据当前项目的实际情况来确定是否建索引。
下面是建索引的一些建议:
1) 在经常需要搜索的列(主健)上,添加索引。
2) 在经常用在连接的列(外键)上,添加索引。
3) 在经常需要排序的列上创建索引。
4) 在经常使用在WHERE子句中的列上面创建索引。
5) 对于那些在查询中很少使用或者参考的列不应该创建索引。
6) 对于那些定义为text、长文本数据类型的列不应该增加索引。
7) 一个表的索引不要过多。
8) 数据量小的表,使用不频繁的不要单独另建立索引。
9) 当修改性能远远大于检索性能时,不应该创建索引。
10) 在查询条件中几个条件一起使用的,适合建立组合索引,否则不要建立组合索引,当单独引用非第一字段时将发生全表扫描。
11) 在查询的时候,where条件不要对索引的列做处理,而要对后面的条件字段做处理。否则用不上这个列上的索引。
3. API错误字典/定义
暂时定义:50X。(如501、502)
4.Vbase初始化
4.1 机构初始化
VBASE-顶级机构编码,取项目简拼,例如:中交海威-zjhw,贵州公路-gzgl,并以此作为项目定制开发构件、私库清单前缀,例如:gzgl_plan_xxx
(xxx项目_xxx模块_xxx构件
),gzgl_Plan_ComponentPrivateList
(项目_XXX模块_私库清单
)。
5.构件菜单
5.1 菜单命名
1) 菜单编码命名:Menu模块编码业务动作,例如:
业务动作 | 菜单编码后缀 | 业务动作 | 菜单编码后缀 | 业务动作 | 菜单编码后缀 |
---|---|---|---|---|---|
列表、清单 | List | 查询 | Query | 编辑 | Edit |
申请、登记 | Apply | 报表 | Report | 设置 | Setting |
打印模板 |
2) 菜单名称命名:一般设计/需求提供,根据具体项目命名即可。
5.2 菜单图标设置
在设置构件菜单时,需要根据菜单类型设置对应类型的菜单图标,对应图标如下:
菜单类型 | 图标标识 | 图标缩略图 |
---|---|---|
设置 | system system-icon-settings | |
初始化 | system system-icon-post | |
业务 | system system-icon-edit | |
统计查询 | system system-icon-searchlist | |
报表 | system system-icon-jikediancanicon04 | |
看板 | system system-icon-paixingbang |
在开发平台中,具体操作如下:
6. 模块验收需提交工件
1) 构件清单
2) 业务模块所有构件,并部署私库
3) 业务模块所有构件均需提交到对应产品、项目SVN
4) 菜单目录菜单导入文件
5) 流程目录流程导入文件
6) 权限导入文件
7) 初始化数据文件
7. 日常工作构件管理
对构件进行版本管理,并添加修改描述。每日修改过的构件修改版本号后提交到对应私库,版本号为yy.MM.dd
,如:
2019年08月01日,版本号设置为19.08.01。在构件属性中修改,如下图所示:
8. 功能模块标准svn目录