后端开发基本规范

1. restful风格API：使用名词而不是动词

2. 常量尽量用final表示

3. 数据交互规范：前端有Android、web、ios、WeChat等众多数据可视化技术，因此大多时候应该以后端为标准接口

4. 三层实现规范：

   • controller层

     • 单条操作controller使用get、add、update、delete命名
     • controller层只是起到转发的作用，代码中要避免出现业务上的逻辑
     • 每个controller的方法尽量控制在20行内
     • controller中的成员变量要标记为private
     • controller中的request，response，session等数据，要避免传递到service层
     • 为风格统一，controller中注入bean统一使用@Autowired注解，避免使用@Resource

   • service层

     • service是业务逻辑层，主写逻辑
     • 每个service的方法尽量控制在50行内，业务复杂导致代码较多，可按业务拆分成多个函数
     • 为风格统一，service中注入bean统一使用@Autowired注解，避免使用@Resource
     • 如果是接口开发，在函数前要加上@Override注解
     • 函数内有超过一个insert、update、delete操作，考虑是否需要事物，如需要在函数前加@Transactional注解

   • dao层

     • 每个接口函数都要有对应的函数注释，用来标明函数的作用
     • 方法命名需要带有find、delete、update、insert等标签
     • 取值严禁使用${key}，会造成sql注入，必须使用#{key}来取值