Java - 命名规范

一个好的命名应该要满足以下两个约束：

• 准确描述所做得事情

• 格式符合通用的惯例

约定俗称的惯例

场景	强约束	示例
项目名	全部小写，多个单词用中划线分隔‘-’	spring-cloud
包名	全部小写	com.alibaba.fastjson
类名/接口名	单词首字母大写	ParserConfig,DefaultFieldDeserializer
变量名	首字母小写，多个单词组成时，除首个单词，其他单词首字母都要大写	password, userName
常量名	全部大写，多个单词，用'_'分隔	CACHE_EXPIRED_TIME
方法	同变量	read(), readObject(), getById()

类命名

类名使用大驼峰命名形式，类命通常使用名词或名词短语。接口名除了用名词和名词短语以外，还可以使用形容词或形容词短语，如 Cloneable，Callable 等，表示实现该接口的类有某种功能或能力。

场景	约束	示例
抽象类	Abstract 或者 Base 开头	BaseUserService
枚举类	Enum 作为后缀	GenderEnum
工具类	Utils 作为后缀	StringUtils
异常类	Exception 结尾	RuntimeException
接口实现类	接口名+ Impl	UserServiceImpl
设计模式相关类	Builder，Factory 等	当使用到设计模式时，需要使用对应的设计模式作为后缀，如 ThreadFactory
处理特定功能的类	Handler，Predicate, Validator	表示处理器，校验器，断言，这些类工厂还有配套的方法名如 handle，predicate，validate
特定层级的类	Controller，Service，ServiceImpl，Dao 后缀	UserController, UserServiceImpl，UserDao
特定层级的值对象	Ao, Param, Vo，Config, Message	Param调用入参；Ao为thrift返回结果；Vo通用值对象；Config配置类；Message为MQ消息
测试类	Test 结尾	UserServiceTest， 表示用来测试 UserService 类的

 方法命名

方法命名采用小驼峰的形式，首字小写，往后的每个单词首字母都要大写。和类名不同的是，方法命名一般为动词或动词短语，与参数或参数名共同组成动宾短语，即动词 + 名词。一个好的函数名一般能通过名字直接获知该函数实现什么样的功能。

场景	约束	示例
返回真伪值	is/can/has/needs/should	isValid/canRemove
用于检查	ensure/validate	ensureCapacity/validateInputs
按需执行	IfNeeded/try/OrDefault/OrElse	drawIfNeeded/tryCreate/getOrDefault
数据相关	get/search/save/update/batchSave/ batchUpdate/saveOrUpdateselect /insert/update/delete	getUserById/searchUsersByCreateTime
生命周期	initialize/pause/stop/destroy	initialize/pause/onPause/stop/onStop
常用动词对	split/join、inject/extract、bind/seperate、 increase/decrease、lanch/run、observe/listen、build/publish、 encode/decode、submit/commit、push/pull、enter/exit、 expand/collapse、encode/decode

参考： 重构代码