Java
Naming Guide
package 包名
根据组织名建立基础包名
e.g:
- https://github.com:
com.github
- waynecommand.com:
com.wayne
根据不同的功能创建包
e.g:
- com.wayne.service
- com.github.api
推荐的常用包名
- 配置项:
configuration
,config
- 业务模型:
model
,model.po
,model.dto
- 业务逻辑:
service
- 数据库交互:
repository
,mapper
- 工具组合:
util
- 过滤器:
filter
- 系列处理器:
handler
- REST API:
api
,rest
,controller
类名和方法名
类名
类名和抽象的业务相关
高层级,需要聚合的 业务层级,以fusion
为前缀。
方法名
指出具体做什么事情,动作命名清晰.
e.g:
- save
- update
- remove
- get / list
- isXxx
- canXxx
- sendXxx
数据库操作
- insert / save
- delete
- update
- select / find