接口开发规范
- service层不允许传递对象值,需要明确基本参数
- service方法命名select/get/selectGroup/selectByCondation
- 工具及方法的返回值和接收参数尽量使用java级的标准接口对象,如DataSource、Properties,不要返回个性对象
- api路径格式要求:
- 路径编排: /名词/名词/…/动词
- 不允许出现getStudent(驼峰命名法)、GetStudent(帕斯卡命名法)、get_student(匈牙利命名法),只允许出现纯小写字母 student/get
【推荐】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:
1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。
2) 运算符与下文一起换行。
3) 方法调用的点符号与下文一起换行。
4) 方法调用时,多个参数,需要换行时,在逗号后进行。
5) 在括号前不要换行,见反例。
1 | 正例: |
【推荐】使用 entrySet 遍历 Map 类集合 KV,而不是 keySet 方式进行遍历。
说明:keySet 其实是遍历了 2 次,一次是转为 Iterator 对象,另一次是从 hashMap 中取出key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中,效率更高。如果是 JDK8,使用 Map.foreach 方法。
正例:values()返回的是 V 值集合,是一个 list 集合对象;keySet()返回的是 K 值集合,是一个 Set 集合对象;entrySet()返回的是 K-V 值组合集合。
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 Monster龙!