什么是代码圈复杂度
圈复杂度是一种度量程序复杂度的方法,由 Thomas McCabe 于 1976年定义,用来衡量一个模块判定结构的复杂程度,数量上表现为独立路径条数,即合理的预防错误所需测试的最少路径条数,圈复杂度大说明程序代码质量低且难于测试和维护,根据经验,高的圈复杂度和程序出错的可能性和有着很大关系。
代码覆盖率和代码圈复杂度有什么关系呢,下面一个例子说明100%代码覆盖率的单元测试并不表示测试了代码的全部执行路径,
下面的程序:
int foo(bool isOK) { const int ZERO = 0; int* pInt = NULL; if (isOk) { pInt = &ZERO; } return *pInt; }
上面代码的圈复杂度为2,如果仅仅测试一种情况: foo(true); 结果是,测试通过,并具有100%的代码覆盖率, 但测试foo(false)就会失败。可见圈复杂度非常重要,良好的测试应该覆盖程序的所有执行路径,即用例的个数至少应该等于方法的圈复杂度。
下面介绍一种统计代码圈复杂度的非常实用的开源工具OCLint,OCLint相比cppncss,cccc等代码圈复杂度工具,它的优点是度量项丰富,所有度量项可通过配置文件进行配置,社区活跃度很高。
安装
Oclint提供可执行文件,从这里(http://oclint.org/downloads.html)下载后解压即可。
使用方法
对于下面的代码
int main()
{
int i = 0, j = 1;
if (j)
{
if (i)
{
return 1;
j = 0;
}
}
return 0;
}
运行Oclint,得到:
oclint oclintTest.cpp -- -c
OCLint Report
Summary: TotalFiles=1 FilesWithViolations=1 P1=0 P2=1 P3=3
/home/qsun/cppLearn/oclintTest.cpp:3:5: short variable name P3 Variable name with 1 characters is shorter than the threshold of 3
/home/qsun/cppLearn/oclintTest.cpp:3:5: short variable name P3 Variable name with 1 characters is shorter than the threshold of 3
/home/qsun/cppLearn/oclintTest.cpp:4:5: collapsible if statements P3
/home/qsun/cppLearn/oclintTest.cpp:9:13: dead code P2
可以发现,有1个P2的代码违规,3个P3的代码违规。P2的代码违规是指代码中存在执行不到的死代码。当然,这只是一个简单的代码测试,oclint通过配置文件还可以测试更多。
下面介绍下Oclint的特点和注意事项
1Oclint能够运行的前提是代码必须能够通过编译,例如上面的代码用g++ -o oclintTest oclintTest.o必须可以通过编译,由于Oclint也支持clang编译器,能够通过clang编译也能够正常输出结果。Oclint通过两种方法指定编译选项
a:oclint [options] <source> -- [compiler flags]中的compiler flags指定编译选项
b:通过compile_commands.json文件指定编译选项
2Oclint的检查项目可以通过lib/oclint/rules文件指定检查项目和阀值。可以通过参数临时调整某个检查项目的域值,对于需要忽略检查的方法,可以通过类似java注解的方法进行忽略,非常灵活。
3支持工程。。。TBD