小组开发中规范和建议节选部分

大部分java开发规范参考《alibaba java开发规范》

1、写代码之前建议看一下已有代码, 保持风格和使用方式一致

2、变量命名要有意义

3、循环中使用each或e命名循环变量, map循环中使用entry

4、嵌套循环尽量提成方法。

5、优先使用卫语句。

6、配置文件使用驼峰命名, 文件名首字母小写。

7、类和方法的访问权限控制为最小, 例如: 可以设为包私有的就不用public

8、方法所用到的私有方法应紧跟着该方法, 如果有多个私有方法, 书写私有方法应与私有方法在原方法的出现顺序相同。

9、优先使用lombok代替构造器, get, set, log方法。

10、使用linux换行符。

11、不应有无意义的空行。

12、方法入参和返回值不允许为null，否则必须注释说明

13、需要注释解释的代码尽量提成小方法，用方法名称解释，注释应只包含javadoc和todo，fixme等。

14、禁止使用static import。

15、不需要公开的类放入internal包，包中类尽量包私有。

16、日志一律使用英文。

17、如果模块中有公用的切入点，应在模块一级路径创建pointcut包。

单元测试规范

1、如无特殊理由, 测试需全覆盖。

2、准备环境的代码和测试代码分离。

3、单数据断言, 应使用assertTrue, assertFalse, assertNull, assertNotNull。

4、多数据断言, 应使用assertThat。

5、调用业务方法的变量, 应命名为actualXXX, 期望值应命名为expectedXXX。