Java开发之命名规范

一、Java中的命名规范

类型(名)	约束	例
项目	全部小写	多个单词用中划线分隔‘-’ spring-cloud
包	全部小写	com.alibaba.fastjson
类	单词首字母大写	Feature,FieldDeserializer
变量	首字母小写多个单词组成时，除首个单词其他单词首字母都要大写	password, userName
常量	全部大写，多个单词，用'_‘分隔	CACHEEXPIREDTIME
方法	同变量	read(), getById(Long id)

二、包命名

前缀	例	含义
indi或onem	indi.发起者名.项目名.模块名.……	个体项目个人发起，但非自己独自完成可公开或私有项目，copyright主要属于发起者。
pers	pers.个人名.项目名.模块名.……	个人项目指个人发起，独自完成，可分享的项目,copyright主要属于个人
priv	priv.个人名.项目名.模块名.……	私有项目，指个人发起，独自完成非公开的私人使用的项目，copyright属于个人。
team	team.团队名.项目名.模块名.……	团队项目，指由团队发起并由该团队开发的项目,copyright属于该团队所有
顶级域名	com.公司名.项目名.模块名.……	公司项目，copyright由项目发起的公司所有

三、类命名

属性	约束	例
抽象	Abstract 或 Base 开头	BaseUserService
枚举	Enum 作为后缀	OSType
工具	Utils作为后缀	StringUtils
异常	Exception结尾	RuntimeException
接口实现	接口名+ Impl	UserServiceImpl
领域模型相	/DO/DTO/VO/DAO	正例：UserDAO 反例：UserDao
设计模式相关	Builder，Factory等	当使用到设计模式时要使用对应的设计模式作为后缀，如ThreadFactory
处理特定功能	Handler，Predicate，Validator	表示处理器，校验器，断言这些类工厂还有配套的方法名，如handle，predicate，validate
测试	Test后缀	UserServiceTest，表示用来测试UserService类的
MVC分层	Controller，Service，ServiceImpl，DAO后缀	UserManageController，UserManageDAO

四、方法

注：pre- prefix前缀，suf- suffix后缀，alo-alone 单独使用

4.1 返回真伪值的方法（pre）

单词	意义	例
is	对象是否符合期待的状态	isValid
can	对象能否执行所期待的动作	canRemove
should	调用方执行某个命令或方法是好还是不好、应不应该，或者说推荐还是不推荐	shouldMigrate
has	对象是否持有所期待的数据和属性	hasObservers
needs	调用方是否需要执行某个命令或方法	needsMigrate

4.2 用来检查的方法

单词	意义	例
ensure	检查是否为期待的状态，不是则抛出异常或返回error code	ensureCapacity
validate	检查是否为正确的状态，不是则抛出异常或返回error code	validateInputs

4.3 按需求才执行的方法

位置	单词	意义	例
suf	IfNeeded	需要的时候执行，不需要则什么都不做	drawIfNeeded
pre	might	同上	mightCreate
pre	try	尝试执行，失败时抛出异常，或是返回errorcode	tryCreate
suf	OrDefault	尝试执行，失败时返回默认值	getOrDefault
suf	OrElse	尝试执行，失败时返回，实际参数中指定的值	getOrElse
pre	force	强制尝试执行，error抛出异常或是返回值	forceCreate, forceStop

4.4 异步相关方法

位置	单词	意义	例
pre	blocking	线程阻塞方法	blockingGetUser
suf	InBackground	执行在后台线程	doInBackground
suf	Async	异步方法	sendAsync
suf	Sync	同步方法	sendSync
pre/alo	schedule	Job和Task放入队列	schedule, scheduleJob
pre/alo	post	同上	postJob
pre/alo	execute	执行异步或同步方法	execute,executeTask
pre/alo	start	同上	star,startJob
pre/alo	cancel	停止异步方法	cancel,cancelJob
pre/alo	stop	同上	stop,stopJob

4.5 回调方法

位置	单词	意义	例
pre	on	事件发生时执行	onCompleted
pre	before	事件发生前执行	beforeUpdate
pre	pre	同上	preUpdate
pre	will	同上	willUpdate
pre	after	事件发生后执行	afterUpdate
pre	post	同上	postUpdate
pre	did	同上	didUpdate
pre	should	确认事件是否可以执行	shouldUpdate

4.6 操作对象生命周期的方法

单词	意义	例
initialize	初始化或延迟初始化使用	initialize
pause	暂停	onPause,pause
stop	停止	onStop,stop
abandon	销毁的替代	abandon
destroy	同上	destroy
dispose	同上	dispose

4.7 与集合操作相关的方法

单词	意义	例
contains	是包含指定对象相同的对象	contains
add	添加	addJob
append	添加	appendJob
insert	插入到下标n	insertJob
put	添加与key对应的元素	putJob
remove	移除元素	removeJob
enqueue	添加到队列的最末位	enqueueJob
dequeue	从队列中头部取出并移除	dequeueJob
push	添加到栈头	pushJob
pop	从栈头取出并移除	popJob
peek	从栈头取出但不移除	peekJob
find	寻找符合条件的某物	findById

4.8 与数据相关的方法

单词	意义	例
create	新创建	createAccount
new	新创建	newAccount
from	从既有的某物新建或是从其他的数据新建	fromConfig
to	转换	toString
update	更新既有某物	updateAccount
load	读取	loadAccount
fetch	远程读取	fetchAccount
delete	删除	deleteAccount
remove	删除	removeAccount
save	保存	saveAccount
store	保存	storeAccount
commit	保存	commitChange
apply	保存或应用	applyChange
clear	清除或是恢复到初始状态	clearAll
reset	清除或是恢复到初始状态	resetAll

4.9 成对出现的动词

单词/意义	单词/意义
get获取	set 设置
add 增加	remove 删除
create 创建	destory 移除
start 启动	stop 停止
open 打开	close 关闭
read 读取	write 写入
load 载入	save 保存
create 创建	destroy 销毁
begin 开始	end 结束
backup 备份	restore 恢复
import 导入	export 导出
split 分割	merge 合并
inject 注入	extract 提取
attach 附着	detach 脱离
bind 绑定	separate 分离
view 查看	browse 浏览
edit 编辑	modify 修改
select 选取	mark 标记
copy 复制	paste 粘贴
undo 撤销	redo 重做
insert 插入	delete 移除
add 加入	append 添加
clean 清理	clear 清除
index 索引	sort 排序
find 查找	search 搜索
increase 增加	decrease 减少
play 播放	pause 暂停
launch 启动	run 运行
compile 编译	execute 执行
debug 调试	trace 跟踪
observe 观察	listen 监听
build 构建	publish 发布
input 输入	output 输出
encode 编码	decode 解码
encrypt 加密	decrypt 解密
compress 压缩	decompress 解压缩
pack 打包	unpack 解包
parse 解析	emit 生成
connect 连接	disconnect 断开
send 发送	receive 接收
download 下载	upload 上传
refresh 刷新	synchronize 同步
update 更新	revert 复原
lock 锁定	unlock 解锁
check out 签出	check in 签入
submit 提交	commit 交付
push 推	pull 拉
expand 展开	collapse 折叠
begin 起始	end 结束
start 开始	finish 完成
enter 进入	exit 退出
abort 放弃	quit 离开
obsolete 废弃	depreciate 废旧
collect 收集	aggregate 聚集

五，变量&常量命名

5.1 变量命名

变量是指在程序运行中可以改变其值的量，包括成员变量和局部变量。变量名由多单词组成时，第一个单词的首字母小写，其后单词的首字母大写，俗称骆驼式命名法（也称驼峰命名法），如 computedValues，index、变量命名时，尽量简短且能清楚的表达变量的作用，命名体现具体的业务含义即可。

变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。pojo中的布尔变量，都不要加is(数据库中的布尔字段全都要加 is_ 前缀)。

5.2 常量命名

常量命名CONSTANT_CASE，一般采用全部大写（作为方法参数时除外），单词间用下划线分割。那么什么是常量呢？

常量是在作用域内保持不变的值，一般使用final进行修饰。一般分为三种，全局常量（public static final修饰），类内常量（private static final 修饰）以及局部常量（方法内，或者参数中的常量），局部常量比较特殊，通常采用小驼峰命名即可。

常量一般都有自己的业务含义,不要害怕长度过长而进行省略或者缩写。如，用户消息缓存过期时间的表示，那种方式更佳清晰，交给你来评判。

通用命名规则

尽量不要使用拼音；杜绝拼音和英文混用。对于一些通用的表示或者难以用英文描述的可以采用拼音，一旦采用拼音就坚决不能和英文混用。正例：BeiJing， HangZhou 反例：validateCanShu

命名过程中尽量不要出现特殊的字符，常量除外。

尽量不要和jdk或者框架中已存在的类重名，也不能使用java中的关键字命名。

妙用介词，如for(可以用同音的4代替), to(可用同音的2代替), from, with，of等。如类名采用User4RedisDO，方法名getUserInfoFromRedis，convertJson2Map等。

六，代码注解

6.1 注解的原则

好的命名增加代码阅读性，代码的命名往往有严格的限制。而注解不同，程序员往往可以自由发挥，单并不意味着可以为所欲为之胡作非为。

优雅的注解通常要满足三要素。

Nothing is strange 没有注解的代码对于阅读者非常不友好，哪怕代码写的在清除，阅读者至少从心理上会有抵触，更何况代码中往往有许多复杂的逻辑，所以一定要写注解，不仅要记录代码的逻辑，还有说清楚修改的逻辑。
Less is more 从代码维护角度来讲，代码中的注解一定是精华中的精华。合理清晰的命名能让代码易于理解，对于逻辑简单且命名规范，能够清楚表达代码功能的代码不需要注解。滥用注解会增加额外的负担，更何况大部分都是废话。
```
// 根据id获取信息【废话注解】
getMessageById(id)
```
Advance with the time 注解应该随着代码的变动而改变，注解表达的信息要与代码中完全一致。通常情况下修改代码后一定要修改注解。

6.2 注解格式

注解大体上可以分为两种，一种是javadoc注解，另一种是简单注解。

javadoc注解可以生成JavaAPI为外部用户提供有效的支持javadoc注解通常在使用IDEA或者Eclipse等开发工具时都可以自动生成，也支持自定义的注解模板，仅需要对对应的字段进行解释。参与同一项目开发的同学，尽量设置成相同的注解模板。

a. 包注解
包注解在工作中往往比较特殊，通过包注解可以快速知悉当前包下代码是用来实现哪些功能，强烈建议工作中加上，尤其是对于一些比较复杂的包，包注解一般在包的根目录下，名称统一为package-info.java。

/**
 * 落地也质量检测
 * 1. 用来解决什么问题
 * 对广告主投放的广告落地页进行性能检测，模拟不同的系统，如Android，IOS等; 模拟不同的网络：2G，3G，4G，wifi等
 *
 * 2. 如何实现
 * 基于chrome浏览器，用chromedriver驱动浏览器，设置对应的网络，OS参数，获取到浏览器返回结果。
 *
 * 注意：网络环境配置信息{@link cn.mycookies.landingpagecheck.meta.NetWorkSpeedEnum}目前使用是常规速度，可以根据实际情况进行调整
 *
 * @author cruder
 * @time 2019/12/7 20:3 下午
 */
package.cn.mycookies.landingpagecheck;

b. 类注接
javadoc注解中，每个类都必须有注解。

/**
* Copyright (C), 2019-2020, Jann  balabala...
*
* 类的介绍：这是一个用来做什么事情的类，有哪些功能，用到的技术.....
*
* @author   类创建者姓名 保持对齐
* @date     创建日期 保持对齐
* @version  版本号 保持对齐
*/

c. 属性注解
在每个属性前面必须加上属性注释，通常有一下两种形式，至于怎么选择，你高兴就好，不过一个项目中要保持统一。

/** 提示信息 */
private String userName;
/**
 * 密码
 */
private String password;

d. 方法注释
在每个方法前面必须加上方法注释，对于方法中的每个参数，以及返回值都要有说明。

/**
  * 方法的详细说明，能干嘛，怎么实现的，注意事项...
  *
  * @param xxx      参数1的使用说明， 能否为null
  * @return 返回结果的说明， 不同情况下会返回怎样的结果
  * @throws 异常类型   注明从此类方法中抛出异常的说明
  */

e. 构造方法注释
在每个构造方法前面必须加上注释

/**
  * 构造方法的详细说明
  *
  * @param xxx      参数1的使用说明， 能否为null
  * @throws 异常类型   注明从此类方法中抛出异常的说明
  */

而简单注解往往是需要工程师字节定义，在使用注解时应该注意一下几点：

枚举类的各个属性值都要使用注解，枚举可以理解为是常量，通常不会发生改变，通常会被在多个地方引用，对枚举的修改和添加属性通常会带来很大的影响。

保持排版整洁，不要使用行尾注释；双斜杠和星号之后要用1个空格分隔。

对于不同的逻辑说明，可以用空行分隔

总结

无论是命名和注解，他们的目的都是为了让代码和工程师进行对话，增强代码的可读性，可维护性。优秀的代码往往能够见名知意，注解往往是对命名的补充和完善。命名太南了！

参考文献：
《码出高效》
https://www.cnblogs.com/wangcp-2014/p/10215620.html https://qiita.com/KeithYokoma/items/2193cf79ba76563e3db6 https://google.github.io/styleguide/javaguide.html#s2.1-file-name