1 数据库的命名规则

1.1 一些英文词的标准缩写

Word(s)	Abbreviation	Description
Password	Pwd	密码
Display	Disp	显示
Organization	Org	组织
Register	Reg	注册
Description	Desc	描述
Dictionary	Dict	字典
Random	Rnd	随机
Account	Act	帐户
Basic	Bas	基础
System	Sys	系统
Examination	Exm	考试管理
Template	Tpl	模板
Scan	Scn	扫描
Recognition	Rcg	识别
Absent&Cheat	Ac	缺考&作弊
Optical Mark Recognition	Omr	光学标记识别
Different	Diff	有差异的
Subitem	Sub	子项
Mark	Mrk	给…打分;在…留下痕迹
Report	Rpt	报表
Final	Fnl	最终的
Count	Cnt	计数
Assistant	Ast	助手，系统工具
SerialNumber	Sn	序号
Check	Chk	检查
Mall	Mal	商城
Parameters	Parm	参数

1.2 通用字段命名约定

命名	类型	说明
IsActive	bit	是否使用，默认为1
TenantId	int	租户Id
DispOrder	int	显示顺序，默认为0
IsDeleted	int	是否删除，默认为0
DeleterUserId	bigint	删除用户Id
LastModifierUserId	bigint	最后修改用户Id
LastModificationTime	datetime	最后修改时间
CreatorUserId	bigint	创建用户Id
CreationTime	datetime	创建时间
IsStatic	bit	是否静态（不允许删除），默认为0
IsDefault	bit	是否默认值，默认为0
IssuedUtc	datetime	发布时间
ExpiresUtc	datetime	到期时间
ProtectedTicket	nvarchar(1024)	受保护的票
Pinyin	nvarchar(16)	拼音
ExamId	bigint	考试Id
ExamCourseId	bigint	考试科目Id
SplitCourseId	bigint	拆分科目Id
BatchId	bigint	批次Id
PaperId	bigint	题卡Id
PageId	bigint	题卡页面Id
OrgId	bigint	组织机构Id
ClassId	bigint	班级Id
StudentId	bigint	学生Id

1.3 数据类型约定

序号	类型	说明
1	bit	bit数据类型代表0,1或NULL,就是表示true,false.占用1byte.
2	tinyint	范围为0～255，长度为1字节，其精度为3，小数位数为0，长度为1字节。
3	int	以4个字节来存储正负数.可存储范围为:-2³¹至2^31-1.
4	bigint	范围为-2⁶³ (-9223372036854775808)～2^63-1 (9223372036854775807)，其精度为19，小数位数为0，长度为8字节。
5	datetime	数据长度为8字节，日期和时间分别使用4个字节存储。
6	nvarchar	变长Unicode的字符型数据，最大长度为4000 。
7	decimal(5,2)	默认为decimal(18, 0) 。

2 数据字典

2.1 Is开关字典

序号	字典命名	字典描述
1	IsThree	是否三校生：0 否 1 是，默认为0.
2	IsBorrow	是否借读生： 0 否 1 是，默认为0.
3	IsSpecia	是否特殊学生： 0 否 1 是，默认为0.
4	IsForeign	是否外籍学生： 0 否 1 是，默认为0.
5	IsUpload	是否上传：0 未上传 1 已上传，默认为0.
6	IsCheck	是否人工审核：0 未审核 1 已审核，默认为0.
7	IsProblem	是否问题卷：0 否 1 是，默认为0.
8	IsAnnotation	是否有阅卷批注： 0 否 1是，默认为0，用于有痕阅卷导出.
9	IsDone	是否完成：0 否 1是，默认为0.
10	IsLeaf	是否叶子节点：0否 1是，默认为0.
11	IsAllowMarking	是否允许阅卷：0 不允许 1 允许，默认为0.
12	IsAllowScan	是否允许扫描：0 不允许 1 允许，默认为1.
13	IsComplete	是否完成：0 未完成 1 已完成，默认为0.
14	IsDeleted	是否删除：0 未删除 1 已删除，默认为0.
15	IsStatic	是否静态（允许删除）： 0 否 1 是，默认为0，1的情况不允许删除.
16	IsDefault	是否默认值：0 否 1 是，默认为0.
17	IsActive	是否激活（正在使用） 0 停止使用 1 正在使用，默认为1.
18	IsRound	是否四舍五入：0 否 1是，默认为1.
19	IsPass	是否及格、通过：0 否 1 是，默认为0.
20	IsGeneralPass	是否全科通过，0 否 1 是，默认为0.
21	IsEmailConfirmed	是否邮件确认，0 否 1是，默认为0.
22	IsMachineRcg	是否机器自动识别，0 否 1是，默认为1.
23	IsSplit	是否拆分科目，0 否 1是，默认为0.
24	IsFrame	是否已画区域，0 未画 1已画，默认为0.
25	IsVertical	Omr区域的横竖标志，0 横 1竖，默认为0.
26	IsCheat	是否违纪（作弊） 0 正常 1 违纪，默认为0.
27	IsAbsent	是否缺考，0 正常 1缺考，默认为0.
28	IsMobile	是否手机在线，0 否 1 是，默认为0.
29	IsSingle	是否单科，0 否 1 是，默认为0.

2.2 Type类别字典

序号	字典命名	字典描述
1	GenderType	性别类型： 0 不区分 1 男 2 女，默认为0.
2	ScienceType	文理类型： 0 不区分（普通） 1 文科 2 理科，默认为0.
3	ClassType	班级类型：0 不区分 1 普通班 2 重点班 3 火箭班，默认为0.
4	UserType	用户类型：0 内部帐户 1 教师，默认为0.
5	RuleType	考场座位编排规则类型：0 不区分 1 按以往成绩 2 按班级混排 3 按年级混排 4 按班级座位 5 延用上次考号，默认为0.
6	ExamStatusType	考试状态类型：0 正常 1 缺考 2 作弊 3 免计成绩，默认为0.
7	OrgType	组织机构类型：0 不区分 1 教育厅 2 教育局 3 教办/中心校 4 完小 5 教学点 6 初中 7 高中 8 完中 9 九年一贯制，默认为0.
8	QuestionType	选择题类型：1 单选、2 多选，默认为1.
9	ValueType	选择题选项值类型：0 字母A~J 1 数字0~9 2 字母T、F 3 自定义自定义序列，默认为0
10	ScoreRuleType	出分规则类型：0 平均 1 取高 2 取低，默认为0.
11	RcgType	识别类型：0 考号正确、OMR正确完全正确；1 考号正确、OMR不正确； 2 考号不正确、OMR不正确； 3 考号不正确、 OMR正确默认为0；.
12	TaskType	任务类型：0 正常卷 1仲裁卷 2问题卷 3 抽捡卷，默认为0
13	ExamType	考试类型：0 不区分 1 校内统考、2 县区统考 3测验，默认为0.
14	HashType	哈希类型，考虑到加密，略；.
15	ConvertType	折算类型： 1 单一条件 2 多条件，默认为1
16	FrameType	模块区域类型：1 定位器 2 缺考 3 作弊 4 考号区（条码）8 考号区（Omr）5 选择题6 切割区、主观题 7 选做题 10 保密区 17 选做题题号区 11 角点定位（左上） 12 角点定位（右上） 13 角点定位（左下） 14 角点定位（右下）15 直线定位（水平）16 直线定位（垂直）18 特征区域定位，无默认值
17	RoleType	角色类型：默认为0，预留字段
18	MarkTimesType	评次类型： 1单评 2双评 x多评，默认为1，x>=3
19	TestNoErrorType	考号错误类型类型： 1 考号未识别 2 考号不存在 3 考号已存在，无默认值
20	TaskFetchType	任务分配模式： 1 动态分配 2 固定分配，默认为1

3 业务逻辑

3.1 Api接口

序号	模块	接口数
1	Tpl	41
2	Scn	16
小计		57
3	Mrk	39
4	Fnl	2
5	Exm	21
6	Act	36
7	Rpt	8
8	Bas	12
小计		118
合计		175

3.2 Api接口设计

如何设计一个优秀的API

团队开发规范V0.7，不断更新中

团队开发规范V0.7，不断更新中

1 数据库的命名规则

1.1 一些英文词的标准缩写

1.2 通用字段命名约定

1.3 数据类型约定

2 数据字典

2.1 Is开关字典

2.2 Type类别字典

3 业务逻辑

3.1 Api接口

3.2 Api接口设计

扩展阅读