SonarQube

8.0

8.1

8.2

8.3

8.4

8.5

sonar-l10n-zh

8.0

8.1

8.2

8.3

8.4

8.5

SonarQube

7.0

7.1

7.2

7.3

7.4

7.5

7.6

7.7

7.8

7.9

sonar-l10n-zh

1.20

1.21

1.22

1.23

1.24

1.25

1.26

1.27

1.28

1.29

SonarQube

6.0

6.1

6.2

6.3

6.4

6.5

6.6

6.7

sonar-l10n-zh

1.12

1.13

1.14

1.15

1.16

1.17

1.18

1.19

SonarQube

5.4

5.5

5.6

sonar-l10n-zh

1.9

1.10

1.11

SonarQube

4.0

4.1

sonar-l10n-zh

1.7

1.8

SonarQube

3.1

3.2

3.3

3.4

3.5

3.6

3.7

sonar-l10n-zh

[p3c]'L' instead of 'l' should be used for long or Long variable.

Java异味

对于long或Long变量，应该使用“L”而不是“l”。

[p3c]A meaningful thread name is helpful to trace the error information,so assign a name when creating threads or thread pools.

Java异味

创建线程或线程池时请指定有意义的线程名称，方便出错时回溯

[p3c]Abstract class names must start with Abstract or Base.

Java异味

抽象类命名使用Abstract或Base开头

[p3c]Abstract methods (including methods in interface) should be commented by Javadoc.

Java异味

抽象方法和接口必须使用javadoc注释

[p3c]All enumeration type fields should be commented as Javadoc style.

Java异味

[p3c]All names should not start or end with an underline or a dollar sign.

Java异味

代码中的命名均不能以下划线或美元符号开始

[p3c]All Service and DAO classes must be interface based on SOA principle. Implementation class names.

Java异味

对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别

[p3c]Attribute rollbackFor of annotation Transactional must be set.

Java异味

[p3c]Avoid using *Apache Beanutils* to copy attributes.

Java异味

避免使用*Apache Beanutils* 拷贝对象

[p3c]Avoid using [Math.random()] by multiple threads.

Java异味

避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed 导致的性能下降。

[p3c]Avoid using the negation operator '!'.

Java异味

避免使用否定运算符“！”

[p3c]Braces are used with if, else, for, do and while statements, even if the body contains only a single statement.

Java异味

在if/else/for/while/do语句中必须使用大括号。即使只有一行代码

[p3c]Brackets are a part of an Array type. The definition could be: String[] args

Java异味

中括号是数组类型的一部分，数组定义如下：String[] args;

[p3c]Class names should be nouns in UpperCamelCase except domain models: DO, BO, DTO, VO, etc.

Java异味

类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：DO / BO / DTO / VO / AO

[p3c]Codes or configuration that is noticed to be obsoleted should be resolutely removed from projects.

Java异味

及时清理不再使用的代码段或配置信息

[p3c]Constant variable names should be written in upper characters separated by underscores.

Java异味

对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别

[p3c]Constant variable names should be written in upper characters separated by underscores.

Java异味

常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长

[p3c]Date format string is error,When doing date formatting, 'y' should be written in lowercase for 'year'..

Java异味

时间格式化的时， 字符年应该使用小写y

[p3c]Do not add 'is' as prefix while defining Boolean variable.

Java异味

POJO类中布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误

[p3c]Do not cast subList in class ArrayList, otherwise ClassCastException will be thrown.

Java异味

ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException异常

[p3c]Do not remove or add elements to a collection in a foreach loop.

Java异味

不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator方式，如果并发操作，需要对Iterator对象加锁

[p3c]Do not use complicated statements in conditional statements.

Java异味

不要在条件语句中使用复杂语句

[p3c]Do not use methods which will modify the list after using Arrays.asList to convert array to list.

Java异味

使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear方法会抛出UnsupportedOperationException异常

[p3c]Do not use toArray method without arguments.

Java异味

使用toArray带参方法

[p3c]Equals should be invoked by a constant or an object that is definitely not null.

Java异味

Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals

[p3c]Every class should include information of author(s) and date.

Java异味

每一个类都必须有作者和时间注释

[p3c]HashMap should set a size when initializing.

Java异味

集合初始化时，指定集合初始值大小。即：HashMap使用HashMap(int initialCapacity) 初始化，initialCapacity (需要存储的元素个数 / 负载因子) + 1。 注意 负载因子（即loader factor 默认为 0.75，如果 暂时无法 确定 初始值大小，请设置为 16（即默认值

[p3c]Magic values, except for predefined, are forbidden in coding.

Java异味

不允许任何魔法值（即未经定义的常量）直接出现在代码中

[p3c]Manually create thread pool is better.

Java异味

.....

[p3c]Method names, parameter names, member variable names, and local variable names should be written in lowerCamelCase.

Java异味

方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。

[p3c]Must be ended with Exception.

Java异味

异常类命名使用Exception结尾

[p3c]Never use return within a finally block.

Java异味

不能在finally块中使用return，finally块中的return返回后方法结束执行，不会再执行try块中的return语句

[p3c]Rules for using primitive data types and wrapper classes.

Java异味

[p3c]should be called in finally block.

Java异味

finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch

[p3c]SimpleDataFormat is unsafe, do not define it as a static variable. If have to, lock or DateUtils class must be used.

Java异味

SimpleDateFormat 是线程不安全的类，一般不要定义为static变量，如果定义为static，必须加锁，或者使用DateUtils工具类

[p3c]Single line comments in a method should be put above the code to be commented, by using // and multiple lines by using /* */.

Java异味

方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐

不能使用行尾注释

[p3c]Test cases should be ended with Test.

Java异味

[p3c]The return type of Math.random() is double, value range is 0<=x<1 (0 is possible).

Java异味

注意 Math.random() 这个方法返回是double类型，注意取值的范围 0≤x<1（能够取到零值，注意除零异常）

[p3c]The total number of lines for a method should not be more than 80.

Java异味

一个方法最多不能超过80行

[p3c]The wrapper classes should be compared by equals method rather than by symbol of '==' directly.

Java异味

所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较，比使用==比较更好

[p3c]type 'ThreadLocal' must call remove() method at least one times.

Java异味

[p3c]Use ScheduledExecutorService instead.

Java异味

多线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorService则没有这个问题，同场景建议使用ScheduledExecutorService 替换

[p3c]Use System.currentTimeMillis() to get the current millisecond. Do not use new Date().getTime().

Java异味

获取当前毫秒数System.currentTimeMillis(); 而不是new Date().getTime();

[p3c]Use the append method in StringBuilder inside a loop body when concatenating multiple strings.

Java异味

循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展

[p3c]We can call the toString method in a POJO directly to print property values.

Java异味

POJO类必须写toString方法。使用IDE的中工具：source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。

[p3c]When using regex, precompile needs to be done in order to increase the matching performance.

Java异味

[p3c]When using subList, be careful to modify the size of original list.

Java异味

在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均会产生ConcurrentModificationException 异常

[p3c]While defining POJO classes like DO, DTO, VO, etc., do not assign any default values to the members.

Java异味

定义POJO类时，不能定义成员变量有默认属性

数项

说明

sonar.projectKey

项目Key，需要唯一，建议使用GroupId+ArtifactId

sonar.projectName

项目名称，跟ArtifactId保持一致即可

sonar.projectVersion

项目版本，跟pom.xml保持一致即可

sonar.sources

源码目录，Java项目默认就是src，如果项目有多个module，那就需要配置为{moduleDirectory}/src

sonar.java.binaries

编译产出的classes目录，如果项目有多个module，那就需要配置为{moduleDirectory}/target/classes