# 开发进行中
# 项目相关约束
项目文件
项目所有资料文件统一放在【代码根目录/doc】文件夹，包括但不限于基础 sql（包含基础 权限、管理员账号等必要数据，清除所有业务数据）、对接文件、流程图、其他说明文件等， 如有多个相同文件使用【yyyyMMdd_文件名】格式进行命名
配置要求
第三方账号、外部接口等自定义信息须写在 yaml 文件中并通过注释的方式标记是否可以修改、在什么时候需要修改以及相关详细说明，且使用 project 作为 yaml 根节点，代码中通过 @ConfigurationProperties 注解进行映射使用
# 开发相关约束
代码注释
项目代码须包含必要注释，且注释代码量不低于 30%，不得包含无效注释，注释须符合 javadoc 标准和注释规范
MVC
开发时统一按照 MVC 三层架构进行开发
Controller层
- 根据端、页面进行设定包名与类名
- 一律禁止编写业务代码，通过注入不同
Service接口进行数据操作 - 响应统一采用
VO形式进行返回
Service层
- 根据业务进行设定包名与类名
- 统一编写业务逻辑代码，合理封装业务逻辑，增强同一业务复用
- 同一方法中多次进行增删改操作必须加上事务
Mapper层
- 根据业务进行设定包名与类名
- 统一使用
Mybatis注解或者Xml形式进行编写相关Sql语句 - 禁止将
Sql语句在代码中使用字符串进行拼接
编译器警告
原则上禁止项目中任何地方存在编译器警告与 阿里巴巴开发规范插件 警告
# 数据库相关约束
表注释/字段注释
所有表/字段必须写明注释，如字段为标识符必须注释每个标识符所代表的含义
表命名/字段命名
数据库表名与字段名必须用全小写下划线分割，基础表使用 sys_ 开头进行标识，其他表统一使用类似于 biz_业务模型_ 开头进行命名
外键
数据库一律不使用外键，统一使用代码维护逻辑