文章      动态     相关文章     最新文章     手机版动态     相关动态     |   首页|会员中心|保存桌面|手机浏览

i3y5wf

http://fabua.ksxb.net/comi3y5wf/

相关列表
文章列表
  • 暂无文章
推荐文章
联系方式
  • 联系人:李女士
  • 电话:13377793959
【C++】SonarQube C++ 静态代码检视规则
发布时间:2025-01-03        浏览次数:1        返回列表

此部分为可能产生问题或容易产生问题的代码,或者冗余代码等。

【C++】So<em></em>narQube C++ 静态代码检视规则


C 风格的指针转换
代码示例

 

应使用

 

应尽量使用 C++ 提供的四种转换,C 风格的转换缺少严谨性与识别度,C++ 在转换错误时会有错误提醒。

  • static_cast 用于层次结构内的指针和引用向上转换,即 派生类到基类的转换,和其他数据类型以及指针的相互转换。
  • dynamic_cast 用于层次结构内的指针和引用的向下转换,在转换时有运行时类型检查,转换错误会返回 。
  • const_cast 用于去除指针、引用、对象的常属性,转换为非常量的指针、引用、对象。
  • reinterpret_cast 可以把指针转为为数据,也可以把数据转换为指针,注:非必要时避免使用。

举例:Clarify calculation precedence for '&' and '?',明确运算符 '&' 和 '?' 的优先级

 

具有相同优先级的操作符应使用小括号明确优先级,修改为:

 
 

举例:Class 'HttpServer' does not have an operator= which is recommended since it has dynamic memory/resource allocation(s).
类 'HttpServer' 包含动态分配的内存/资源,但是没有赋值操作符重载

 

需要显式实现拷贝构造和赋值操作符重载,避免浅拷贝和双释放造成的错误。举例修改如下:

 

未使用拷贝构造和赋值操作符重载的情况下可以禁用。


举例:Class 'Widget' has a constructor with 1 argument that is not explicit.
类 'Widget' 有一个单实参数的构造函数,但是未标识 explicit 。

单实参的构造函数,未标识 explicit 会发生隐式转换,如参数非 int 但可以使用 int 类型隐式转换并且构造,可能出现构造错误。

 

因为包含默认参数,因此可以使用一个实参去构造,需要添加 explicit 关键字

 
 

举例: Condition '' is always true.
条件判断 '-1 != str.find(',')' 恒为真。

 

虽然不规范,但目前还没遇到错误, 的 函数在查找不到时返回 为 类型,非负数,与 -1 比较时,会向上转换成一种公共类型。建议修改 -1 为 。

 
 

举例:Condition 'checkFlag' is always true.
条件 'checkFlag' 恒为真

 

在 中的 checkFlag 应恒为真,由于 分支已经判断的不为真的情况。应将冗余的判断删除

 
 

举例:Function 'CheckRemoteConnection' argument 3 names different: declaration 'remoteType' definition 'type'.
函数 ‘CheckRemoteConnection’ 第三个参数名称在函数声明与定义中不一致

 

应修改为相同名称,避免差异较大时实现代码与声明中的注释不一致或其他的情况。

 
 

局部变量与外部作用域函数同名。
应修改局部变量名称,避免出错。


举例:Local variable 'pRemote' shadows outer variable.
局部变量 ‘pRemote’ 覆盖外作用域同名变量。

 

应避免局部变量覆盖外部作用域同名变量,或可能出现操作错误

 
 

举例:Member variable 'm_hDevice' is in the wrong place in the initializer list.
类成员变量 ‘m_hDevice’ 声明的顺序与构造函数初始化列表中定义的顺序不一致。
示例代码:

 

顺序达成一致即可,调整构造函数初始化列表或者调整声明中的顺序

 

类成员的初始化顺序是按照类内数据成员的声明顺序进行初始化的,这样可以减少不必要的开销,类不必为每一个对象进行跟踪初始化数据成员,只需要按照类中的声明顺序初始化即可。(析构函数也会出现类似的情况)


举例:Memer variable 'CRemote::m_id' is not initialized in the constructor.
成员变量 'CRemote::m_id' 未在构造函数中初始化。

 

可能存在多个构造函数,而在开发中某个构造函数疏漏了一个或几个成员变量的初始化,最好在声明处赋上默认值,避免成员变量未初始化,造成未知的错误。

 
 

函数第一个参数为 std::string,调用时传递 c_str(),低效且冗余

 

可能为编写时的疏忽,或接口后期更新。需要删除冗余的 c_str()

 
 

if 判断条件与前一个 if 相同

 

if 条件重复,检查是否可以合并


举例:The statement '' is logically equivalent to ''
语句 '' 与 '' 逻辑等价

 

示例修改

 
 

未使用的函数,若为弃用的函数,则可删除废弃代码,如果为备用函数则可忽略掉本条检视问题。


未使用的变量,可以删除。


举例:Variable 'index' is assigned value that is never used.
变量 index 被赋值,但此值从未使用。

 

变量定义与赋值可在同一处。

 
 

与前一条类似。

此部分为明确的代码错误。


检查无符号的表达式小于 0 ,举例
Checking if unsigned expression 'vec.size()' less than zero

 

的 方法的返回值为 类型,x64 的定义为

 

无符号类型恒为非负数,应修改为

 

建议修改为后者,由于 一般为常数时间复杂度。


访问了移动后的变量。举例
Acess of moved variable 'graph'.

 

变量在 std::move 之后资源的权限已转移,内存已不可使用,不能再次使用被移动后的变量,应去除使用

 
 

举例: Class 'Strategy' is not safe, destructor throws exception.
类 Strategy 在析构函数中抛出异常不安全。

应尽量在问题处抛出异常,而不是在析构处。


举例: Class 'HttpSocket' is unsafe, 'HttpSocket:m_socket' can leak by wrong usage.
类 'HttpSocket' 不安全,成员变量 'HttpSocket:m_socket' 在使用错误时会造成内存泄漏

 

m_socket 为动态分配的指针,但未对其进行释放。

 
 

不必要的连续跳转语句 return, break, continue, gotothrow
示例代码

 

连续的跳转语句只会执行第一个,return true 永远执行不到,需要删除

 
 

跳转语句 return, break, continue, gotothrow 后边的多个语句永远不会执行
代码示例:

 

应检查删除 return true 后不会执行的代码

 

初级错误,无用代码,删除前需要找对应的开发确认。


举例:Either the condition '!arr' is redundant or there is possible null pointer dereference: arr.
指针非空条件判断 '!arr' 冗余或存在空指针解引用的可能。
代码示例:

 

操作符分配失败,会抛出异常,无法使用指针非空来判断,修改示例:

 

删除指针非空的检查


异常捕获应使用引用
代码示例:

 
  1. 拷贝构造会产生额外开销
  2. 以基类值捕获会产生对象切割,派生对象只能保留基类部分数据
    应修改为引用,示例修改
     

举例:Found duplicate branches for 'if' and 'else'.
if 和 else 分支中代码重复,代码示例:

 

应删除冗余的代码,示例修改:

 
 

举例:Oppsite expression on both side of '&&'.
在逻辑与两侧的表达式相反,彼此互补。
代码示例:

 

需要检查修改,此处为逻辑错误,if 分支总是不会执行。


举例:Possible null pointer derefence : p.
指针变量 'p' ,可能的空指针解引用。

 

指针在使用前需要判断是否为空

 
 

举例:Resource leak : fp.
fp 资源泄漏

 

fp 文件指针未释放,需要关闭文件描述符

 
 

举例:The comparison '' is always true because '' and '' represent the same value.
比较 '' 恒为真, 由于 '' 与 '' 表示相同的值。

 

若非有意设置固定值,应为代码错误。


未初始化的变量,变量最好在声明时初始化。


举例:Virtual function 'UpdateStatus' is called from constructor 'Remote' at line '42'. Dynamic binding is not used.
虚函数 UpdateStatus 在 42 行,构造函数 Remote 中调用。动态绑定未使用。

 

构造函数中调用虚函数无法使用动态多态,析构函数中同样。
可以将实现提到一个函数中,构造函数中调用此函数,原虚函数为此函数的封装,也调用这个接口。示例修改:

 

此种修改不影响动态多态

此部分为可优化的代码,去除冗余的判断,提高代码执行效率等。


考虑使用标准库 算法替代使用原生循环
示例代码:

 

参考修改

 

这种实现避免第一个字符为分隔字符的情况。
为了使用 std::accumulate , 包含的头文件不是 而是 。


考虑使用 算法替代原生的循环
示例代码:

 

修改示例

 

lambda 表达式 可省略,通过返回值编译器可以自行推断。 std::any_of 集合中只要有一个元素符合条件即返回 true,集合为空或者全部元素为 false 则返回 false。声明为:

 
 

考虑使用 算法替代原生的循环
示例代码:

 

修改示例:

 

标准库算法通常比原生循环有更好的可读性,执行效率和安全性。


考虑使用标准库算法 替代原生循环
代码示例:

 

修改示例:

 

标准库算法通常比原生循环有更好的可读性,执行效率和安全性。


考虑使用标准库算法 替代原生循环
代码示例:

 

修改示例

 
 

考虑使用标准库算法 替代原生循环
代码示例:

 

修改示例

 
 

考虑使用标准库 算法替代原生循环
代码示例:

 

示例修改:

 
 

举例:Function parameter 'ip' should be passed by const reference.
函数参数 'ip' 应该传递常量引用

 
  • 传递引用为避免在函数体中额外的拷贝构造和析构函数的开销,提高执行效率。
  • 常量引用可以匹配左值和右值,此处为可以匹配字符串字面值。
  • 若参数在函数体中不修改,标识 const 在意外修改时编译器会生成错误。

示例修改:

 
 

'substr' 函数调用低效,字符串首开始的子串赋值给自身,可使用 resize() 或 pop_back() 替代
代码示例:

 

示例修改

 
 

对于非基础类型建议使用前置 / ,前置自增自减,效率更高。


举例:Redundant condition: p, '' is equivalent to ''。
冗余的条件判断 p , '' 可等价修改为 ''。

 

在第一个条件成立的情况下会短路,第二个条件不会执行。只有前者不成立时后者才会执行。
换而言之, p 为空,会跳过第二个判断。只有第一个条件为假时,才会执行第二个,也就是 p 为非空时才会执行第二部分的 , p 非空已经判断过了,不需要重复判断。

 
 

举例:Technically the member function 'Remote::GetStatus()' can be const.
未改变成员变量的函数应声明未常函数

 

const 修饰函数时写在参数和函数体之间,可以避免类属性被意外修改。

 

注:常量对象无法调用非 const 修饰的函数。


技术上来说未访问非静态成员变量的函数可以声明为 static

静态成员函数调用时可以不必构造对象。


举例:The function 'TellPosition' overrides a function in a base class but is not marked with 'override' specifer.
函数 ‘TellPosition’ 重写基类中的虚函数但未标识 'override' 关键字

 

为保证编译器检查,防止编码错误导致与基类方法不一致,以至于无法正确实现多态。另外,标注 override 关键字,还可以在基类方法修改后,能够借助编译器及时且全面的在派生类中进行更新。

 
 

举例:The scope of the variable 'prefix' can be reduced.
变量 prefix 的作用域可以缩减

 

当前变量作用域过大,缩小作用域可以在程序不运行到特定分支时,不为变量分配内存。

 
 

举例:Variable 'm_suffixlist' is assigned in constructor body. Consider performing initialisation in initializer list.
变量 m_suffixlist 在构造函数中赋值,考虑在构造函数初始化列表中初始化

 

类类型的变量,或者叫聚合类型变量,初始化建议放在构造函数初始化列表,这种情况下 只调用一次构造。而放置在构造函数中,则会首先调用默认构造,再调用一次赋值。前者效率更高