表、实体和字段

表、实体和字段规范文档。

1. 表命名

命名规范：

命名原则：
- 必须包含明确含义；
- 编码使用全小写英文单词，禁止使用汉语拼音及简拼；
- 总长度小于30个字符。
建议：
- 过长的命名，可以去掉公司/产品/项目名称（可选）;
- 表命名后缀参照表.。

示例:

表	命名方式	例子1	例子2	例子3
编码方式	`公司/产品/项目编码（可选）_模块编码（必须）_XXXXX（功能修饰）`	`ydg_contract_info`	`reimburse_main`	`reimburse_detail`
名称方式	`公司/产品/项目名称（可选）_模块名（必须）_XXXXX（功能修饰）`	`银弹谷_合同信息`	`报销申请主表`	`报销申请从表`

后缀参照表:

业务动作	编码后缀
基础数据表	info
业务主表	main
业务明细表	detail
附件表	file
清单\台账	list

tip

在创建表时需要创建对应的固定字段，直接下载固定表字段文件，在创建时导入即可。

固定字段下载：

2. 查询命名

命名规范：

命名原则：
- 使用驼峰命名；
- 必须包含明确含义，编码使用全英文单词，禁止使用汉语拼音及简拼；
- 总长度小于30个字符。
查询编码：get+功能修饰。
查询名称：功能修饰。

示例:

查询	命名方式	例子1	例子2
编码方式	`get+功能修饰`	`getCustomeInfo`	`getIncomeApply`
名称方式	获取+`功能修饰`	`获取客户信息`	`获取发票申请`

tip

注意：查询变量，参考变量命名的规则即可（例如：userName（用户名称））。

3. 实体命名

info

命名规范：

命名原则：
- 使用驼峰命名；
- 必须包含明确含义，编码使用全英文单词，禁止使用汉语拼音及简拼；
- 总长度小于30个字符。
实体编码：功能修饰。
实体名称：功能修饰。
应用范围：窗体实体、构件变量实体、构件常量实体、窗体输入实体、窗体输出实体、方法输入实体、方法输出实体、方法变量实体等。

示例:

界面实体	命名方式	例子1
编码方式	`功能修饰`	`customerInfo`	`incomeApply`
名称方式	功能修饰	`客户信息`	`发票申请`

【特殊要求】为了处理业务表单公共的代码或者业务逻辑界面控件显示实体，可按以下命名：

业务窗体界面实体	命名方式	描述
主表	main	新增表单：当前录入人、录入部门、录入时间、单号等等
从表	detail	新增明细行统计处理
界面编辑属性	`uProperty`	通过数据确定修改界面控件属性
流程定义信息	`workFolwInfo`	流程定义相关信息获取
任务处理（流程审批信息）	`taskProcessInfo`	流程审批信息获取

4. 字段命名

info

命名规范：

命名原则：
- 使用驼峰命名；
- 必须包含明确含义；
- 编码使用全英文单词，禁止使用汉语拼音及简拼；
- 总长度小于30个字符。
应用范围：所有类型的实体字段、表字段。

示例:

字段	命名方式	例子1	例子2
编码方式	字段名	`fileName`	`fileCode`
名称方式	字段名	`文件名称`	`文件编码`

5. 数据类型与长度

info
类型、长度名规范：
在建字段时根据具体需求定义不同类型的字段定义不同的长度，无法确定长度就使用默认值。
类型 长度
文本 根据字段的具体需求定义长度。
长文本 根据字段的具体需求定义长度。
小数 统一长度number（20,8），也就是整数位12位（千亿），小数位8位小数（亿分之一），
其中前台显示按照金额、单价显示2位小数、数量3位小数字（仅限于前台）。
整数 根据字段的具体需求定义长度，其中用于状态位的2位，用于存储业务数值的12位（千亿）。
说明：状态位指XxxFlag、XxxState……此类字段。
日期、时间 字段类型为文本类型。
建议：日期和时间分两个字段保存，便于后续统计查询，避免函数对日期时间截取或者转换，影响查询效率和表索引使用。

类型	长度
文本	根据字段的具体需求定义长度。
长文本	根据字段的具体需求定义长度。
小数	统一长度number（20,8），也就是整数位12位（千亿），小数位8位小数（亿分之一），其中前台显示按照金额、单价显示2位小数、数量3位小数字（仅限于前台）。
整数	根据字段的具体需求定义长度，其中用于状态位的2位，用于存储业务数值的12位（千亿）。说明：状态位指XxxFlag、XxxState……此类字段。
日期、时间	字段类型为文本类型。建议：日期和时间分两个字段保存，便于后续统计查询，避免函数对日期时间截取或者转换，影响查询效率和表索引使用。

6. 附录 - 表单主表固定字段

业务主表

序号	编码	名称	字段类型	长度	缺省值	是否必填	备注
1	id		文本	128		是
2	bizCode	业务单号	文本	64		否	新增打开窗体不赋值，保存时才赋值
3	bizStatusCode	业务状态编码	文本	32		否	T\编制（未提交）、B\审批中（已提交未审批完成）、F\审批通过（审批完成）、C\已作废（流程取消/作废）
4	bizStatus	业务状态	文本	64		否
5	inputDate	录入日期	日期			否	默认当前日期，格式：yyyy-MM-dd
6	inputTime	录入时间	文本	8		否	默认当前时间，格式：hh:mm:ss
7	inputPersonId	录入人Id	文本	64		否	默认当前登录用户Id
8	inputPerson	录入人	文本	64		否	默认当前登录用户
9	inputOrgId	录入机构Id	文本	64		否	默认当前登录用户集团/公司/项目Id
10	inputOrg	录入机构	文本	128		否	默认当前登录用户集团/公司/项目
11	inputDeptId	录入部门Id	文本	64		否	默认当前登录用户部门Id
12	inputDept	录入部门	文本	128		否	默认当前登录用户部门
13	remark	备注	长文本	1024		否	默认为空
14	isDelete	是否删除	布尔		False	否	默认为false，窗体删除功能不做物理删除，修改IsDelete字段为true，注意获取业务数据及数据统计时过滤IsDelete=true的数据（不纳入统计）
15	addDateTime	新增日期时间	日期时间			否	当前日期时间，格式：yyyy-MM-dd hh:mm:ss
16	addPersonId	新增操作员Id	文本	64		否	当前登录用户Id
17	addPerson	新增操作员	文本	64		否	当前登录用户
18	modifyDateTime	修改日期时间	日期时间			否	当前日期时间，格式：yyyy-MM-dd hh:mm:ss
19	modifyPersonId	修改操作员Id	文本	64		否	当前登录用户Id
20	modifyPerson	修改操作员	文本	64		否	当前登录用户

7. 附录 - 从表固定字段

业务明细表

序号	编码	名称	字段类型	长度	缺省值	是否必填	备注
1	id		文本	128		是
2	mainId	主表Id	文本	64		否
3	remark	备注	长文本	1024		否	默认为空
4	isDelete	是否删除	布尔		False	否	默认为false，窗体删除功能不做物理删除，修改IsDelete字段为true，注意获取业务数据及数据统计时过滤IsDelete=true的数据（不纳入统计）
5	addDateTime	新增日期时间	日期时间			否	当前日期时间，格式：yyyy-MM-dd hh:mm:ss
6	addPersonId	新增操作员Id	文本	64		否	当前登录用户Id
7	addPerson	新增操作员	文本	64		否	当前登录用户
8	modifyDateTime	修改日期时间	日期时间			否	当前日期时间，格式：yyyy-MM-dd hh:mm:ss
9	modifyPersonId	修改操作员Id	文本	64		否	当前登录用户Id
10	modifyPerson	修改操作员	文本	64		否	当前登录用户