Bootstrap

学习嵩山版《Java 开发手册》:编程规约 - 命名风格(P19)

概述

  1. 《Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结,他旨在提升开发效率和代码质量

  2. 《Java 开发手册》是一本极具价值的 Java 开发规范指南,对于提升开发者的综合素质和代码质量具有重要意义

  3. 学习《Java 开发手册》是一个提升 Java 编程技能、了解行业最佳实践和规范的好方法


编程规约 - 命名风格 P19

1、基本介绍
  • Service / DAO 层方法命名规约
  1. 获取单个对象的方法用 get 做前缀。

  2. 获取多个对象的方法用 list 做前缀,复数结尾,例如,listObjects。

  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。

2、学习补充
(1)Service / DAO 层方法命名规约
  1. 获取单个对象的方法用 get 做前缀
User getUserById(Long id);

// 我个人更加倾向于使用 query 做前缀
User queryUserById(Long id);
  1. 获取多个对象的方法用 list 做前缀,复数结尾
List<User> listUsers();
 
// 我个人更加倾向于使用 query 做前缀
List<User> queryUsers();
  1. 获取统计值的方法用 count 做前缀
int countUsers();

int countActiveUsers();
  1. 插入的方法用 save / insert 做前缀
void saveUser(User user);
 
// 我个人更加倾向于使用 insert 做前缀
void insertUser(User user);
  1. 删除的方法用 remove / delete 做前缀
void removeUserById(Long id);
 
// 我个人更加倾向于使用 delete 做前缀
void deleteUserById(Long id);
  1. 修改的方法用 update 做前缀
void updateUser(User user);

void updateUserStatusById(Long id, String status);
(2)领域模型命名规约
  1. 数据对象:xxxDO
public class UserDO {
    private Long id;
    private String name;
}
  1. 数据传输对象:xxxDTO
public class UserDTO {
    private Long id;
    private String name;
}
  1. 展示对象:xxxVO
public class UserVO {
    private Long id;
    private String name;
}
  1. POJO 是 DO / DTO / BO / VO 的统称,禁止命名成 xxxPOJO
// 不推荐这样命名
public class UserPOJO {
}
// 应该这样命名
public class UserDO {
}
;