优化:基于阿里巴巴 Java 开发手册(黄山版)优化部分变量和方法命名

1.编程规约>命名风格>第14条:
【推荐】在常量与变量命名时,表示类型的名词放在词尾,以提升辨识度。
正例:startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例:startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD
2.编程规约>命名风格>第19条:
【参考】各层命名规约:
  A)Service / DAO 层方法命名规约:
  1)获取单个对象的方法用 get 做前缀。
  2)获取多个对象的方法用 list 做前缀,复数结尾,如:listObjects
  3)获取统计值的方法用 count 做前缀。
  4)插入的方法用 save / insert 做前缀。
  5)删除的方法用 remove / delete 做前缀。
  6)修改的方法用 update 做前缀。
个人理解及应用 🔥:
  1)在变量命名方面:
    a)方法体内局部变量,命名时表示类型的名词放在词尾,以提升辨识度;
      正例:nameList、nameArr。
    b)方法声明上参数(局部变量),命名时尽量采用复数形式,以和方法名保持一致;
      正例:List<String> listNameByIds(List<Long> ids);
    c)成员变量,命名时尽量采用复数形式。
  2)在方法命名方面:
    a)CRUD 类方法可以简化命名;
      正例:UserService:page、list、add、update、delete...;
      说明:UserService 是围绕 User 为核心的业务接口,简化命名的方法也很容易理解操作的是什么。
    b)其他方法,查询信息名词采用单数(与其纠结单数、复数,那就用单数,简单粗暴一点),以上述第2条要求为命名前缀。
      正例:RoleService:listNameByIds(根据 ID 查询名称列表)
           RoleService:listRoleCodeByUserId(根据用户 ID 查询角色编码列表)
           UserRoleService:listRoleIdByUserId(根据用户 ID 查询角色 ID 列表)
           UserService:getByUsername(根据用户名查询用户)
This commit is contained in:
2023-03-04 23:03:33 +08:00
parent 25f6e3402b
commit 47fa1422bb
29 changed files with 114 additions and 111 deletions

View File

@@ -30,15 +30,20 @@ import cn.hutool.core.text.StrPool;
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class StringConsts implements StrPool {
/**
* 空字符串
*/
public static final String EMPTY = "";
/**
* 分号
*/
public static final String SEMICOLON = ";";
/**
* 空字符串
* 中文逗号
*/
public static final String EMPTY = "";
public static final String CHINESE_COMMA = "";
/**
* 标准日期时间格式

View File

@@ -27,9 +27,9 @@ public interface CommonUserService {
/**
* 根据 ID 查询昵称
*
* @param userId
* 用户 ID
* @param id
* ID
* @return 昵称
*/
String getNicknameById(Long userId);
String getNicknameById(Long id);
}

View File

@@ -157,5 +157,4 @@ public class ExceptionUtils {
*/
T get() throws Exception;
}
}