1、合理组织代码层次,分层清晰:controller、logic、dao、对第三方接口(包括公司接口)的调用;各层要继承基类或实现接口
2、先定义方法原型,再实现方法体
3、理想的方法,是不可拆分的、原子的一个逻辑实现,具有一个明确的职责
4、方法体不超过70行,类体不超过500行
5、类名称、变量名称、方法名称,遵循简单明确,知名见义原则。建议不带数字,下划线等特殊字符(类常量除外),采用有意义的名词或者名称组合、动宾结构(反对使用拼音命名)
6、常量名大写
7、代码逻辑块之间留有空行;等号、运算符号、变量两边留有空格
8、循环、条件语句嵌套不超过2层 (最好的避免嵌套的方法就是尽早return、合并条件、利用子方法)
9、类注释描述职责;变量要有明确的注释;方法注释描述职责,输入、输出要有说明;复杂逻辑片断,要有说明;注释要简洁明了
10、关键点要有日志;记住生产环境为info级;debug日志要先判断设置级别;日志不允许打印用户的密码,账户等敏感信息;禁止使用System.out
11、方法参数不超过4个
12、boolean变量使用is前缀;返回boolean类型的方法名使用is前缀
13、最大程度复用,相同的代码片断只出现一次,相同语义的变量只定义一个
14、if判断逻辑过于复杂的,必须单独提练为方法
15、必须对边界条件做处理
16、异常处理,建议try..catch,反对throw;对于捕获的异常信息,必须将异常堆栈打印出;尽可能减小try的代码范围
17、禁止对测试用的数据硬编码
18、禁止存放注释掉的代码
19、配置项编写配置文件,反对硬编码
20、不能修改的变量要加final,不能被重写的方法要加final
21、数据库连接,必须使用连接池
22、IO操作(文件、URL、DB等),牢记finally语句中close
23、反对似懂非懂,反对没掌握使用即引入新技术
24、自动化测试case符合下单要求
25、鼓励使用设计模式