# Java命名规范：先学习再超越
# Mapper（持久层）
# 分页&列表(2合1)
# 命名规则 query{TableSimpleName}By{ParamName} # 示例 queryUserByArgs queryHostByArgs代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 分页查询
# 命名规则 query{TableSimpleName}PageBy{ParamName} # 示例 queryUserPageByArgs queryUserPageByUserId代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 查询列表
# 命名规则 query{TableSimpleName}ListBy{ParamName} # 示例 queryUserListByArgs queryUserListByUserId代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 查询一个
# 命名规则 get{TableSimpleName}By{ParamName} # 示例 getUserByUserId getUserByArgs代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 新增
# 命名规则 insert{TableSimpleName}With{ParamName} # 示例 insertUser代码已复制
1
2
3
4
5
2
3
4
5
# 批量新增
# 命名规则 insert{Batch}{TableSimpleName}With{ParamName} # 示例 insertBatchUser insertBatchUserWithDeptId代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 更新
# 命名规则 update{ParamName}ById # 示例 updateHostNameById updateUserNameById代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 批量更新
# 命名规则 update{ParamName}ByIds # 示例 updateHostNameByIds updateHostIpByIds代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 删除
# 命名规则 delete{TableSimpleName}ById # 示例 deleteHostById deleteUserById代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 批量删除
# 命名规则 delete{TableSimpleName}ByIds # 示例 deleteHostByIds deleteUserByIds代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 统计数量
# 命名规则 get{具体语义}CountBy{ParamName} # 示例 getUserOnlineCount getUserTotalCountBySex代码已复制
1
2
3
4
5
6
2
3
4
5
6
# Service（业务层）
# 分页&列表(2合1)
# 命名规则 describe{TableSimpleName} # 示例 describeUserArgs describeHostArgs代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 分页查询
# 命名规则 describe{TableSimpleName}Page # 示例 describeUserPage describeHostPage代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 查询列表
# 命名规则 describe{TableSimpleName}List # 示例 describeUserList describeHostList代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 查询元数据
# 命名规则 describe{TableSimpleName}{AttributeName}MetadataOptions # 示例 describeHostIpMetadataOptions describeUserSexMetadataOptions代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 保存
# 命名规则 save{TableSimpleName} # 示例 saveHost saveUser代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 修改
# 命名规则 modify{TableSimpleName}{AttributeName} # 示例 modifyHost modifyUser modifyHostIp modifyUserSex代码已复制
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
# 删除
# 命名规则 remove{TableSimpleName}ById # 示例 removeHostById removeUserById代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 批量删除
# 命名规则 remove{TableSimpleName}ByIds # 示例 removeHostByIds removeUserByIds代码已复制
1
2
3
4
5
6
2
3
4
5
6
# 执行业务
# 命名规则 {action}{TableSimpleName}{s} # 示例 createInstance 创建实例 createInstances 批量创建实例 startInstance 启动实例 stopInstance 停止实例 rebootInstance 重启实例 renewInstance 续费实例 reActiveInstance 激活实例 # 业务动词（参考） create 创建 delete 删除 modify 修改 scale 扩容 attach 追加 remove 移除 upgrade 升级 sync 同步 install 安装 unInstall 卸载 grant 授权 pause 暂停 cancel 取消 resume 重新开始 check 检查 deploy 部署代码已复制
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Controller（用户层）
# 命名规则 与Service层的命名规则对齐代码已复制
1
2
2
# 参数模型
- 内部静态类 (不推荐，swagger识别不了)
- Controller请求参数，XXXXRequest，返回值XXXXRequest 或 XXXXResponse
- 三方服务返回的数据，XXXXModel
- Mapper接收的一定是entity，TableName标识的类