项目代码规范要求
1 命名一定要规范
2 javadoc注释一定要规范,尤其是接口部分,类对说明,类里面的私有方法
3 方法内部的思路,一定要先写
4 业务流程方法(组合方法),功能方法,一定要拆开
5 所有的后端方法,一定要提供junit测试
6 author必须写,声明作者使用@author
7 request,response不能出现在service层
8 常量优先放置到自己模块的vo,如果没有vo,放interface
9 日志记录:
取日志对象的时候,用自己的类
记录error的时候,使用log.error(message, e);
要求message里面记录:类+方法+参数
10 不允许有system.out ,调试信息用https://www.doczj.com/doc/db18836742.html,();
11 参数、变量等能够通过配置来调整的,尽量不要写死;分析常量是内部使用还是外部的,外部的都应该放到参数配置里面
12 方法粒度的拆分:功能方法和组合方法
13 实现里面不允许有常量字符串
14 声明字符串常量:命名不不可以英文和拼音混合使用
15 业务方法不可使用基础方法名称,业务方法要另外命名
16 Controller 只负责组织参数,组织返回数据,返回前端;
Service 负责业务逻辑处理,;
DAO负责持久化数据,查询数据
17 方法命名要贴合业务
18 Service 接口里面提供业务方法,少出现基础CRUD 方法
19 不要在基础CRUD 方法中写业务逻辑相关的代码
20 重构时只copy有用的需要的代码,不要全部复制。
21 不要在循环中操作数据库
22 所有未做的,需要掉其他人接口的地方,需要注释:// TODO
23 接口提供要专用,内部使用接口可以通用
24 genAppendHql 方法覆盖时,确认所有条件都是需要的,尽量不要覆盖该方法
25 写代码先写注释,写完代码一定要写JUnit测试,测试完成后,保证代码没有问题,提交SVN
26 Model 中定义变量,不要和数据库原来字段名字一样
27 接口传参不要太多,不超过5个
28 拆公共方法时拆彻底
30 Update 如果是按业务修改的一定要按照业务Update,自己写Hql 和参数(按需Update)
31 一个类的所有的private 方法,统一放到类下边,使用////////////////////////隔开
逻辑层测试要求
1 先写测试用例,后写代码
2 功能级别的,主干功能;分支测试--if,for;其他--校验,例外(看时间);