写代码时取名字真的是痛苦。
方法命名
1、阿里命名规范
Service/Dao 层命名规约
1) 获取单个对象的方法用 get 做前缀。
2) 获取多个对象的方法用 list 做前缀。
3) 获取统计值的方法用 count 做前缀。
4) 插入的方法用 save(推荐)或 insert 做前缀。
5) 删除的方法用 remove(推荐)或 delete 做前缀。
6) 修改的方法用 update 做前缀。
领域模型命名规约
1) 数据对象:xxxDO,xxx 即为数据表名。
2) 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
3) 展示对象:xxxVO,xxx 一般为网页名称。
4) POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。
————————————————
Dao 接口命名
- insert
- batchInsert
- selectOne
- selectById
- count
- selectList
- update
- deleteById
Service 接口命名
- add
- findById
- findByXXX
- findXXXList
- modify
- remove
⽅法名
更新⽅法使⽤ update 前缀
删除⽅法使⽤ remove 或者 delete 前缀
插⼊⽅法使⽤ save 或者 insert 前缀
获取单个数据⽅法使⽤ get 前缀
获取多个数据⽅法使⽤ list 前缀
统计⽅法使⽤ count 前缀
判断⽅法使⽤ is 前缀
查询⽅法使⽤ find 或者 query 前缀
抽象类使⽤ Abstract 前缀
异常类使⽤ Exception 后缀
测试类使⽤要 测试类的类名 + Test后缀
抽象类使⽤ Abstract 前缀
异常类使⽤ Exception 后缀
测试类使⽤要 测试类的类名 + Test后缀
controller层做什么
Controller层的方法并不仅仅用于组合Service层的方法。在MVC(Model-View-Controller)架构中,Controller层扮演着至关重要的角色。它主要负责接收用户的请求,并根据请求调用相应的Service层方法来处理业务逻辑。处理完成后,Controller层再将结果返回给用户。
Controller层的主要职责包括:
- 接收请求:Controller层接收来自前端的HTTP请求,包括GET、POST、PUT、DELETE等不同类型的请求。
- 调用Service层:根据请求的类型和内容,Controller层会调用相应的Service层方法来执行具体的业务逻辑。Service层通常包含与业务相关的数据处理逻辑,如数据的增删改查等。
- 返回响应:Service层处理完数据后,Controller层会将结果封装成HTTP响应,并返回给前端。这可以包括JSON、XML或其他格式的数据。