静态代码扫描-Alibaba Code Guidelines

代码规范是每个合理性公司需要遵循的规则,我们可以使用Alibaba Code Guidelines的静态代码扫描。

Idea中集成Alibaba Code Guidelines

以Intellij IDEA2019为例,

  1. File->setting

静态代码扫描-Alibaba Code Guidelines_第1张图片

静态代码扫描

静态代码扫描-Alibaba Code Guidelines_第2张图片

3个级别的问题

扫描之后有3个级别的问题:

1、Blocker:最严重的问题,要求是必须修复,不允许带着Blocker问题的代码上线,跟绩效挂钩。

2、Critical:是比较严重的问题,要求是必须修复,不允许带着Critical问题的代码上线,跟绩效挂钩

3、Major:问题,可以不修复,也可以修复。主要是看项目的排期和进度,如果说进度不是特别紧张的话,建议全部修复。如果说项目进度很紧张的话,Major问题可以先放着,下次有时间了再修复。

编码规范

1、所有类必须有创建者信息

2、继承自父类或者是实现接口的方法,必须加@Override注解

3、所有的POJO必须实现toString()方法

4、如果POJO需要实现equals()方法,在用eclipse自动生成的时候,必须让if后面跟上括号

5、所有的注释必须写完整、清晰而且详细

6、所有的@Transactional注解必须加上rollbackFor参数,指定哪些异常发生的时候回滚事务

7、所有的类命名必须按照驼峰形式来,尤其是DAO单元测试类,必须是类似于XxxDaoTest的格式

8、所有集合初始化的时候,都必须给一个初始值,可以用常量类定义一个默认的集合初始值是100

9、所有代码不能出现任何一个magic number,必须对数字、字符串等值进行变量或者是常量的定义

你可能感兴趣的:(代码质量)