拉取最新的小组分支,创建自己开发分支(对应实现人)
- 任务分支(小组名-功能名-执行人,如:f1-login-zhangfei)
根据业务流程整理文档梳理与书写
- 定义领域模型(包括:query、dto、vo)的定义
- 定义接口
- hr-apis模块接口定义、hr-xxx-xxx的controller书写
- controller只需产生文档,不需要具体实现
- 书写前后端交互接口文档
- Java使用Knife4j产生文档
- 交互文档需要将请求参数(需要有默认值)、响应结果(需要有示例值)呈现出来
- 代码推送要求
- 接口文档需要自测通过,如果是Apipost接口中的保证请求地址和端口使用环境变量
- 保证程序无语法错误、符合编码规范
- 代码书写需要基于小组分支构建任务分支的的方式完成
- 推荐做法
- 在定义领域模型的时候字段名尽量保持和数据库表字段名一致,这样方便领域模型之间的自动转换(Java可以使用反射)以及属性类型对应
- Java中设计接口响应数据测试值,需要通过注解标记出来
注意:在定义接口和领域模型要求做的工单不需要涵盖后续数据操作(如:service、mapper(或dao)),目标是尽快产出前后端交互文档,而不是某个接口完整的实现
# 执行`SQL`注意事项
***注意:这里存放初始的数据库结构,如果后续根据业务需要对数据库进行了修改,需要将新的数据库脚本备份到此目录下面。***
`SQL`文件说明:
- `reference-project.sql`:用于参考项目本地测试时使用的数据库,同样直接导入完成建库建表。
- `zohr-sys.sql`:是项目开发使用的数据库,直接导入完成建库建表。
在执行 `SQL` 文件的时候如果运行报错的话,检查你的 `sql_mode` 是否删除了下面的选项:
```txt
ONLY_FULL_GROUP_BY
NO_ZERO_DAT
NO_ZERO_IN_DATE
```
你可以通过下面命令行查看`sql_mode`情况
```sql
# 查看当前sql_mode
select @@sql_mode;
# 查看全局sql_mode
select @@global.sql_mode;
```
你可以通过下列指令修改(服务器重启后将会失效)
```sql
# 修改全局
set @@global.sql_mode = 'STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION';
# 修改当前
set @@sql_mode = 'STRICT_TRANS_TABLES,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION';
```
想要永久生效需要修改`my.ini`或`my.cnf`配置文件
在导入`sql`的时候还有可能因为数据库max_allowed_packet过小导致问题,通过下面命令修改
``` sql
set global max_allowed_packet=1024102416;
```
核心业务流程
# 核心业务流程图
流程图文件包括:
- 设计图设计文件:如果使用`Visio`绘制的,就要上传`.vsdx`格式的文件
- 设计图导出文件:导出类型从`PDF`或图片中任选一种
# 新增修改原型图
原型图文件包括:
- 原型图设计文件:如果使用`Axure`绘制的,就要上传`.rp`格式的文件
- 原型图导出文件:导出类型从`PDF`、图片、`html`中任选一种
目录要求
- 分功能模块的方式存放
- 首先创建功能模块目录
- 然后在功能模块目录下面存放包含的原型图文件(设计文件和导出文件)
- 注意:如果导出文件是`html`格式并且包括多个文件,那么需要再建一子目录,然后将`html`相关文件放到子目录,保证是一个整体。