写入项目规则:
方法名命名规则:
1.添加前缀新增save,更新edit,删除delete,单查询get,多查询list,分页查询page,导出export,导入import,
2.批量添加前缀batch,新增batchSave,更新batchEdit,删除batchDelete
controller层接口规则:
1. 接口方式:新增post,更新put,查询get,删除delete
2. api前缀:新增save/**,更新edit/**,删除delete/**,单查询get/**,多查询list/**,分页查询page/**,
导出export/**,导入import/**
批量添加batch/**,如新增batch/save/**,更新batch/edit/**,删除batch/delete/**
3. api不使用@PathVariable方法,使用@RequestParam
4. 查询接口返回view包的实体对象,传入query包对象。新增编辑接口使用dto包对象。
5. 新增、编辑、删除、提交、修改等操作service层返回boolean类型,controller层根据结果返回对应的
6.对新增、更新接口在Controller层需要做数据校验,添加javax.validation.Valid
service层规则:
1.代码中不可以出现魔法值,涉及类型、状态等,统一定义常量或枚举
2.新增、更新、删除Service层返回boolan,Controller层根据service层返回结果,返回SaResult成功或失败
3.业务异常,创建BusinessException异常类,Service层出现业务逻辑问题返回BusinessException
entity包规则:
entity实体类 implements Serializable ,
并添加字段
@Serial
private static final long serialVersionUID
entity包对应mapper接口查询数据,与数据库表一一对应,类名与表名对应
view 包对应list,page等查询接口返回的数据
query 包对应list,page等查询接口传入的参数,
分页查询参数,创建独立的PageBean
public class PageBean {
// 页码 pages;
// 每页大小 size ;
}
所有的实体类使用注解
@Getter
@Setter
不使用@Data
根据规则,重新调整代码