较好的方法命名规则（转）

Posted 2020-11-08 sandea

2015年11月19日 第一版

原文链接：http://qiita.com/KeithYokoma/items/2193cf79ba76563e3db6
原作者：KeithYokoma
译者：dssunxun

返回真伪值的方法

場所	单词	意义	例
Prefix	is	对象是否是所期待的状态	isChecked
Prefix	can	对象能否执行所期待的动作	canRemove
Prefix	should	调用方执行某个命令好还是不好	shouldMigrate
Prefix	has	对象是否持有所期待的数据和属性	hasObservers
Prefix	needs	调用方是否需要执行某个命令	needsMigrate

按需求才执行的方法

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

异步相关方法

場所	单词	意义	例
Prefix	blocking	线程阻塞方法	blockingGetUser
Suffix	InBackground	执行在后台的线程	doInBackground
Suffix	Async	异步方法	sendAsync
Suffix	Sync	对应已有异步方法的同步方法	sendSync
Prefix or Stem	schedule	Job和Task放入队列	schedule, scheduleJob
Prefix or Stem	post	同上	postJob
Prefix or Stem	execute	执行异步方法（注：我一般拿这个做同步方法名）	execute, executeTask
Prefix or Stem	start	同上	start, startJob
Prefix or Stem	cancel	停止异步方法	cancel, cancelJob
Prefix or Stem	stop	同上	stop, stopJob

回调方法

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

与集合操作相关的方法

单词	意义	例
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

与状态相关的方法

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

操作对象生命周期的方法

单词	意义	例
initialize	初始化。也可作为延迟初始化使用	initialize
abandon	销毁的替代	abandon
destroy	同上	destroy
dispose	同上	dispose

与数据相关的方法

单词	意义	例
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