天天看点

JavaWeb - CRUD 命名规范

优雅的命名规范,可以提高开发者的 CRUD 效率~

个人版

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