SonarLint检测出的bug、漏洞修复总结

目录

1、Introduce a new variable instead of reusing the parameter "prefixKey"

2、Remove the boxing to "Double"; The argument is already of the same type.

3、A “NullPointerException” could be thrown; “document” is nullable here.

4、Remove this conditional structure or edit its code blocks so that they’re not all the same.

5、Change this condition so that it does not always evaluate to “false”

6、Cast one of the operands of this multiplication operation to a "long"

7、Use a “double” or “BigDecimal” instead.

8、Close this “XXX”.

9、Correct this “&” to “&&”.

10、This branch can not be reached because the condition duplicates a previous condition in the same sequence of “if/else if” statements

11、Make this “XXX” field final.

12、Remove this call to “equals”; comparisons between unrelated types always return false.

13、Remove this return statement from this finally block.

14、Remove this continue statement from this finally block.

15、Equality tests should not be made with floating point values.

16、Add a type test to this method.

17、Add an end condition to this loop.

18、Make “XXX” an instance variable.

19、Save and re-use this "Random"

20、The return value of “replace” must be used.

21、Unlock this lock along all executions paths of this method

22、Do something with the “boolean” value retyrbed by "xxx"

23、Either re-interrupt this method or rethrow the “InterruptedException” thar4t can be caught here.

24、Use the original value instead

25、Update this method so that its implementation is not identical to "delete" on line 71

26、Define and throw a dedicated exception instead of using a generic one.

 27、Complete the task associated to this TODO comment.

28、immediately return this expression instead of assigning it to the temporary variable "swapStream"

29、remove the declaration of thrown exception 'org.hibernate.exception.DataException' which is a runtime exception

30、Rename this local variable name to match the regular expression '^[a-z][a-zA-Z0-9]*$'

31、Define a constant instead of duplicating this literal “XXXX” 4 times.

32、Refactor this method to reduce its Cognitive Complexity from 55 to the 15 allowed.

1、Introduce a new variable instead of reusing the parameter "prefixKey"

不要用传递过来的参数去重新赋值做判断等

可以新建一个参数 等于传递过来的参数 用新的参数去操作

private String getBatchSaveKey(Map<String, String> map, String prefixKey, String... keys) {undefined
        //创建一个newPrefixKey
        String newPrefixKey;
        newPrefixKey = prefixKey.endsWith(RedisKeys.DELIMITER) ? prefixKey.substring(0, prefixKey.length() - 1) : prefixKey;
        if (keys.length == 0) {undefined
            return newPrefixKey;
        }

不直接用prefixKey = prefixKey.endsWith(RedisKeys.DELIMITER) ? prefi。。。
也不直接用return prefixKey;而是去创建newPrefixKey

2、Remove the boxing to "Double"; The argument is already of the same type.

移除装箱转换Double类型，这个参数已经是一样的类型了。

Boolean.valueOf //装箱
(Boolean) //装箱
Boolean.valueOf((Boolean) val) //两次装箱，多此一举

重复转换，删除即可。

3、A “NullPointerException” could be thrown; “document” is nullable here.

 这种提示是指可能存在空指针异常，需要增加空值检测。

说明：未做非空校验，可能产生空指针
解决方案：加上非空校验

解决方式：先判断或者先实例化，再访问里面的属性或者成员。

4、Remove this conditional structure or edit its code blocks so that they’re not all the same.

 写if else的时候，卡条件卡得离散了一点，本身可以合成一个的，结果写成了多级if，增加了程序的复杂度。

例子：

if(i > 0){

​	return i;

}else{

#### return i;

}
删除此条件结构或编辑其代码块，使它们不完全相同。
因为返回的结果都一样，需要去掉筛选分支。

5、Change this condition so that it does not always evaluate to “false”

条件判断后一直返回的结果为false。需要改条件判断。

6、Cast one of the operands of this multiplication operation to a "long"

需要强转类型
例如转成long
(long)Integer.MaxValue;

说明：int数运算最终再把结果转为long将有可能产生溢出
解决方案：转换为long型预算
举例：

long bigNum = Integer.MAX_VALUE + 2; // Noncompliant. Yields -2147483647
换为

long bigNum = Integer.MAX_VALUE + 2L;

7、Use a “double” or “BigDecimal” instead.

说明：两个float计算会产生不精确的结果
解决方案：将float换为double或者BigDecimal计算
举例：
float a = 16777216.0f;
float b = 1.0f;
float c = a + b; // Noncompliant; yields 1.6777216E7 not 1.6777217E7
double d = a + b; // Noncompliant; addition is still between 2 floats
换为

float a = 16777216.0f;
float b = 1.0f;
BigDecimal c = BigDecimal.valueOf(a).add(BigDecimal.valueOf(b));
double d = (double)a + (double)b;

8、Close this “XXX”.

说明：流没有显示的关闭。
解决方案：在fianlly语句块内关闭。
Remove or correct this useless self-assignment.
说明：缺少this
解决方案：用this.xxx=xxx来替代
举例：
public void setName(String name) {undefined
name = name;
}
换为

public void setName(String name) {undefined
this.name = name;
}

9、Correct this “&” to “&&”.

说明：错误的使用&和&&
解决方案：根据情况使用&和&&

10、This branch can not be reached because the condition duplicates a previous condition in the same sequence of “if/else if” statements

说明:if else if 语句判断条件重复
解决方案：去掉多余的判断条件

11、Make this “XXX” field final.

说明：将某个字段置为final，常见在Exception的参数
解决方案：将字段置为final

12、Remove this call to “equals”; comparisons between unrelated types always return false.

说明：去掉equals判断语句，因为总为false
解决方案：去掉equals语句

13、Remove this return statement from this finally block.

说明：在finally语句块中有return语句
解决方案：去掉finally语句块的return语句或者放在finally语句块之外

14、Remove this continue statement from this finally block.

说明：在finally语句块中有continue语句
解决方案：去掉finally语句块中的continue语句或者放在finally语句块之外

15、Equality tests should not be made with floating point values.

说明：浮点数之间用 == 来比较大小不准确
解决方案：用Number或者BigDecimal来比较
举例：
float myNumber = 3.146;
if ( myNumber == 3.146f ) { //Noncompliant. Because of floating point imprecision, this will be false
// …
}
if ( myNumber != 3.146f ) { //Noncompliant. Because of floating point imprecision, this will be true
// …
}

16、Add a type test to this method.

说明：强转前未判断类型
解决方案：强转前先判断类型
举例：
ErpVO ev = (ErpVO) obj;
return this.userCode.equals(ev.getUserCode());

换为

if (obj == null) {undefined

return false;

}

if (obj.getClass() != this.getClass()) {undefined

return false;

}

…

17、Add an end condition to this loop.

说明：没有退出条件

解决方案：根据情况来决定方法的退出条件

18、Make “XXX” an instance variable.

说明：有些类不是线程安全的，将变量生命为静态的可能会导致线程安全问题
解决方案：将变量声明为实例的。

19、Save and re-use this "Random"

"Random" objects should be reused   创建的随机数不安全。
解决方案
1、sonar建议:
private Random rand = SecureRandom.getInstanceStrong(); // SecureRandom is preferred to Random    public void doSomethingCommon() {
  int rValue = this.rand.nextInt();    //...
}
2、SecureRandom random = new SecureRandom(); 

20、The return value of “replace” must be used.

String s = "2,2";
s.replace("2", "3");

需要代替，s字符串并未改变；
或者 直接拼接s.replace("2", "3");

21、Unlock this lock along all executions paths of this method

需要解锁 lock.unlock();

22、Do something with the “boolean” value retyrbed by "xxx"

解决:

public boolean doSome(){

}

if(!doSome){

​    ......

}

如果返回boolean ，需要判断为false的情况；用！()判断 失败情况。

23、Either re-interrupt this method or rethrow the “InterruptedException” thar4t can be caught here.

解决: 

try(){

}catch (InterruptedException e){  

​	//抛出InterruptedException   异常需要重新清除线程的中断状态,添加如下

Thread.currentThread().interrupt();

}

24、Use the original value instead

例子：

public int compare(eq22 e) {
		return -this.getCode1().compareTo(this.getCode2());
	}
用了compareTo方法，取反的话，就算是正数取反，结果将是不可靠的。
解决：
public int compare(eq22 e) {
	return   -1 * value;
}

25、Update this method so that its implementation is not identical to "delete" on line 71

更新此方法，以便其执行是不相同的"delete"71行。

 解决：

两个方法的内容完全一致，不用写两遍，在其中一个方法中调用另一个方法即可。或者删掉一个，全部使用另一个方法

26、Define and throw a dedicated exception instead of using a generic one.

定义并抛出一个专用的异常来代替一个通用的异常。

解决方法：不要直接抛Error,RuntimeException/Throwable/Exception这样的通用的异常，使用更具体的异常代替

比较常用的 IllegalArgumentException(不合法参数的异常) 。

其他的还有 IOException等

示例如下：
throw new IllegalArgumentException("invalid argument, please check argument.");

 27、Complete the task associated to this TODO comment.

问题分析： 

TODO标记通常用于标记需要更多代码但开发人员希望稍后实现的地方。
有时开发人员没有时间，或者只是忘记返回到该标记。
此规则旨在跟踪这些标记，并确保它们不会被忽略。

解决：

将TODO的内容完善、说明类、方法是干什么的。

28、immediately return this expression instead of assigning it to the temporary variable "swapStream"

立即返回此表达式而不是将其分配给临时变量"swapStream"

问题分析： 

声明一个变量只是为了立即返回或抛出它是一种不好的做法。
一些开发人员认为，这种做法提高了代码的可读性，因为它使他们能够显式地命名返回的内容。
但是，此变量是一个内部实现细节，不会向方法的调用方公开。方法名称应足以让调用方确切知道将返回什么。

解决：

直接return new ByteArrayInputStream(baos.toByteArray());，而不是定义一个swapStream接收，然后返回swapStream。

return new ByteArrayInputStream(baos.toByteArray());

29、remove the declaration of thrown exception 'org.hibernate.exception.DataException' which is a runtime exception

解决：删除抛出异常的声明，dataException是一个运行时异常

30、Rename this local variable name to match the regular expression '^[a-z][a-zA-Z0-9]*$'

方法名需要遵守命名规则 
不合规
public void doSomething(int my_param) {
int LOCAL;
...
}
合规：
public void doSomething(int myParam) {
int local;
...
}

31、Define a constant instead of duplicating this literal “XXXX” 4 times.

 类似这种，当一个不变的字符串在一个文件中多次出现，就应该给这些字符串提取成常量，
这样方便以后修改和维护。但是说实话提取常量这个异味真的很枯燥，并且代码中有大量的这种情况，
感觉每个项目或者每个模块都应该提取一个常量类，这样这个模块用到这些不变字符串，
就直接从这个类中获取，但是这个工作量有点大哈哈，我就简单的尝试了一下，把自定义报表那部分提取常量，但是进行了一部分就没有进行下去了，枯燥且工作量大

 但是我觉得这个工作还是做比较好，这样便于以后的维护，常量值改变只用改一个地方就好了，不用所有地方都修改。

32、Refactor this method to reduce its Cognitive Complexity from 55 to the 15 allowed.

关于代码圈复杂度大于15的异味，以及代码过长的异味，说实话也没有什么好的方法，只能读代码，然后抽离函数出来，当然抽离函数不可能一次就能做到代码简洁之道要求的那样，一个函数只做一件事，单一层次原则。但是我们也不能因为做不到这样就就什么都不做，还是要迈出这一步，先抽离函数，虽然没有做到单一层次原则，但是消除了异味。下面代码是对上面的进行简单的函数抽离，消除异味

=======================================