1 业务逻辑层 CRUD 方法命名

Service 层一般用于封装业务逻辑,命名上可以更加贴近业务语义。

1.1 新增

createXXX
addXXX
saveXXX
saveBatchXXX

示例:

createUser
addUser
saveUser
saveBatchUser

1.2 查询

getXXX 查询单行
findXXX 查询全部
queryXXX 查询范围
countXXX 查询数量

示例:

getUser
findAllUsers
queryUserListByMap
queryUserPageByMap
countUser

1.3 更新

updateXXX

示例:

updateUser
updateUserById

1.4 删除

deleteXXX
removeXXX

示例:

deleteUser
deleteUserById
removeUser
removeUserByMap

1.5 其他

根据具体业务逻辑,可以命名更具业务意义的方法

lockUser 锁定用户
unlockUser 解锁用户

2 数据访问层 CRUD 方法命名

Dao 层的命名一般遵循数据库操作的语义,更接近 SQL 操作。

2.1 新增

insertXXX

示例:

insertUser

2.2 查询

selectXXX
selectList
selectPage

示例:

selectUser
selectList
selectPage

2.3 更新

updateXXX

示例:

updateUser

2.4 删除

deleteXXX

示例:

deleteUser
deleteByMap

3 通用命名规则

  • 方法名清晰易懂:命名应该明确描述方法的功能,避免使用模糊或缩写的命名。
  • 遵循动词-名词结构:通常动词表示操作类型(如 creategetupdate 等),名词表示操作对象。
  • 添加过滤条件:对于查询操作,可以在方法名中加入条件描述,如 selectUserByEmail