开发-开发规范
前提概要:
国庆这几天为了不偷懒,就给几个学弟组了个队,开发一下项目。然后在开发阶段发现了一些问题,大概就是开发规范一类的。所以这里做个总结,以后如果再做组长就可以把这套规范套用上去。
各种包装类
所有dto
、entity
、enums
、constants
、vo
都放到model
包下
DTO(Request)
这个是前端请求后端接口时使用的封装类。
- 首先我建议每一个前端请求的方法都有一个
XXXRequest.java
,用来表示前端传给后端的数据,如果传参是一样的,那么就可以用同一个DTO - 第二就是,DTO文件夹下有多个包,每个包都代表一个功能,一个包里有多个
XXXRequest.java
entity
这个包里专门放相对应的数据库的映射类,如果有多个数据库,就先创建多个数据库对应名字的包,然后每个包里放响应数据库表对应的包装类enums
就是枚举。这个我建议就是,每个接口中放每个表所有的枚举,公共枚举接口叫做CommonEnum
,里边定义所以公共的枚举。constants
用于存放常量vo
这个就好理解了,就是返回给前端的VO,一般如果没有特定的,就直接通过entity中映射表的封装类返回就行。特定的就写个VO,也是每个功能放到每个包里。如果预先知道VO类会很少,那么就不用再建包了。后端小技巧
代码分组(仅限IDEA工具)
在IDEA中有个好用的技巧,就是region
1
2
3// region 增删改查
这是代码
// endregion后端与前端联调
mock数据
前端如果使用的ant
可以使用ant Design Pro进行前端的接口文档 https://pro.ant.design/zh-CN/docs/openapi/