优雅的命名规范,可以提高开发者的 CRUD 效率~
个人版
- 原则:尽可能不影响见名知意的前提下缩短方法名
- C(add)R(get)U(upd)D(del):统一前缀 3 个字母来代表,并且类里写方法的排序也习惯性这样
- 单数情况:addXXX / getXXX / updXXX / delXXX,XXX 后面不带有复数形式,其他资料里也许会看到说加啥 “One”,个人感觉大部分情况没必要,因为不加复数其实就代表是单数了
- 复数情况:addXXXs / getXXXs / updXXXs / delXXXs,因为加 “List” 太长,而且万一是 “Set” 集合的话,难道还要做复数之间的区分?XXXs 一般情况就够用了,但是遇到单复数同词时根据英文语法来表示该单词本有的复数形式
- By 后缀省略:“ById” 代表是该实体类的主键Id,除此之外,遇到其他非原生属性 Id 单词一律都使用 “ByXXXId”;类似这种情况还有 “实体类_属性” 都可以采用这个省略原则
- By 后缀拼接:“By” 后缀单词一旦超过 3 个,则采用 “ByAttr”,否则 3 个以内(包含 3 个)直接拼接 “ByXxxYyyZzz”,其实 3 个的情况已经解决了大部分的接口命名情况了
- 待更新……
Ps1:“非原生属性”:非 “实体类_属性” 的结构。