优化：基于阿里巴巴 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（根据用户名查询用户）

continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/common/CommonController.java

@@ -81,8 +81,8 @@ public class CommonController {
     @GetMapping("/dict/role")
     public R<List<LabelValueVO<Long>>> listRoleDict(@Validated RoleQuery query, @Validated SortQuery sortQuery) {
         List<RoleVO> list = roleService.list(query, sortQuery);
-        List<LabelValueVO<Long>> dictList = roleService.buildDict(list);
-        return R.ok(dictList);
+        List<LabelValueVO<Long>> labelValueVOList = roleService.buildDict(list);
+        return R.ok(labelValueVOList);
     }
 
     @Operation(summary = "查询枚举字典", description = "查询枚举字典列表")
@@ -98,10 +98,10 @@ public class CommonController {
         // 转换枚举为字典列表
         Class<?> enumClass = first.get();
         Object[] enumConstants = enumClass.getEnumConstants();
-        List<LabelValueVO> dictList = Arrays.stream(enumConstants).map(e -> {
+        List<LabelValueVO> labelValueVOList = Arrays.stream(enumConstants).map(e -> {
             BaseEnum<Integer, String> baseEnum = (BaseEnum<Integer, String>)e;
-            return new LabelValueVO(baseEnum.getDescription(), baseEnum.getValue());
+            return new LabelValueVO<>(baseEnum.getDescription(), baseEnum.getValue());
         }).collect(Collectors.toList());
-        return R.ok(dictList);
+        return R.ok(labelValueVOList);
     }
 }

continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/monitor/LogController.java

@@ -80,9 +80,9 @@ public class LogController {
 
     @Log(module = "系统日志")
     @Operation(summary = "查看系统日志详情")
-    @GetMapping("/system/{logId}")
-    public R<SystemLogDetailVO> get(@PathVariable Long logId) {
-        SystemLogDetailVO detailVO = logService.get(logId);
+    @GetMapping("/system/{id}")
+    public R<SystemLogDetailVO> get(@PathVariable Long id) {
+        SystemLogDetailVO detailVO = logService.get(id);
         return R.ok(detailVO);
     }
 }

continew-admin-webapi/src/main/java/top/charles7c/cnadmin/webapi/controller/system/UserController.java

@@ -60,17 +60,17 @@ public class UserController extends BaseController<UserService, UserVO, UserDeta
 
     @Operation(summary = "重置密码", description = "重置用户登录密码为默认密码")
     @SaCheckPermission("system:user:password:reset")
-    @PatchMapping("/{userId}/password")
-    public R resetPassword(@PathVariable Long userId) {
-        baseService.resetPassword(userId);
+    @PatchMapping("/{id}/password")
+    public R resetPassword(@PathVariable Long id) {
+        baseService.resetPassword(id);
         return R.ok(String.format("重置密码成功，请牢记默认密码：%s", SysConsts.DEFAULT_PASSWORD));
     }
 
     @Operation(summary = "分配角色", description = "为用户新增或移除角色")
     @SaCheckPermission("system:user:role:update")
-    @PatchMapping("/{userId}/role")
-    public R updateUserRole(@PathVariable Long userId, @Validated @RequestBody UpdateUserRoleRequest request) {
-        baseService.updateUserRole(request, userId);
+    @PatchMapping("/{id}/role")
+    public R updateRole(@PathVariable Long id, @Validated @RequestBody UpdateUserRoleRequest request) {
+        baseService.updateRole(request, id);
         return R.ok("分配成功");
     }
 }

continew-admin-webapi/src/main/resources/application.yml

@@ -41,7 +41,7 @@ logging:
     #excludeMethods:
     #  - GET
     # 脱敏字段
-    desensitize:
+    desensitizeFields:
       - password
       - Authorization