静态代码分析工具

afox123

　　代码的质量越来越受到重视，静态代码分析工具(static analysis tool for source code) 能够发现一定的代码错误，公司可以使用这些工具来提高代码的质量。
　　收费工具（commercial tool）有clocwork等,免费的工具也有很多
　　我们公司的项目是c/c++与java混合的项目，因此既需要c/c++分析工具，也需要java分析工具
　　总体上来说，java的分析工具还是比较多，且与jenkins,maven结合紧密，界面友好。c/c++代码能够使用的工具比较少
　　下面我讲解一下这些工具如何与jenkins配合，搭建自动集成环境，实现自动代码质量检查
　　一. 环境
　　ubuntu10.04, Jenkins1.451,JDK 1.6.0_26
　　二. tools for java
　　1. checkstyle
　　这个工具主要检查java代码的格式，可以对代码格式进行配置，然后使用该工具进行检查。
　　该工具与jenkins集成比较好，易用。
　　使用方法：
　　(1). 在工程pom.xml文件中配置maven-checkstyle-plugin的版本 和 在<build>...</build>中设定
　　<sourceDirectory>.</sourceDirectory>  源文件路径,checkstyle从哪里去找需要检查的代码
　　<testSourceDirectory>test</testSourceDirectory>
　　<outputDirectory>target/classes</outputDirectory>
　　<testOutputDirectory>target/test-classes</testOutputDirectory>
　　//checkstyle很好用，它会检查sourceDirectory文件夹及其子文件夹中的所有java文件，并生成一个报告
　　//使用该工具时，不需要对java代码进行编译
　　(2). 在Jenkins的对应的job->configure->post-build中设定checkstyle报告的目录，让jenkins识别该报告，这样就可以在jenkins中查看该报告。
　　2. Findbugs
　　该工具检查代码中的错误，如null pointer之类
　　该工具不是很好用，和checkstyle比起来。它检查java编译后的.class字节代码，并生成报告。它也可以检查.class字节代码打成的jar包。
　　但是当项目比较大时，会出现许多的jar包，许多的.class文件，并且他们不同在一个文件夹，这个时候， <sourceDirectory>xxxx</sourceDirectory>        源文件路径就必须定义在顶层，这样的话，Findbugs就会死掉。(这也太菜了，一旦项目复杂了，就死翘翘。还是一个被广泛使用的工具呢!!!鄙视      一下)。所以在jenkins中采用shell脚本的方式对Findbugs进行调用，不使用maven调用Findbugs. 使用jenkins的findbugs-plugin来识别findbugs生成的findbugs-     result.xml,将结果呈现在jenkins中。
　　使用方法：
　　(1)  安装findbugs软件，并设置环境变量
　　(2) 利用findbugs软件包中的rejarForAnalysis的工具，将所有的分布的jar文件进行重新打包进入一个analyze.jar包
　　实例：find sourceDir -name '*.jar' | xargs rejarForAnalysis
　　(3) 利用findbugs工具对analyze.jar进行分析
　　实例:findbugs -textui -xml -outputFile target/findbugs-result.xml analyze.jar
　　(4) 在jenkins的post-build的设置生成findbugs报告，设定findbugs-result的所在目录
　　三. tools for c/c++
　　1. cppcheck
　　这个工具可以检查c/c++代码中的错误，如null pointer空指针之类
　　maven中没有调用cppcheck的插件，所以要在在jenkins中使用cppcheck就必须通过jenkins 调用shell脚本来实现
　　这个工具比较好用，只需制定源文件目录，就可以对该目录下和其子目录中的所有c/c++文件进行分析了。而且工程比较大时，也可以直接使用，不容易崩掉,但是可能会花掉比较长的时间.
　　使用方法：
　　（1）.下载cppcheck，并安装
　　（2）. 将cppcheck目录添加到环境变量path中
　　（3）. 安装jenkins, cppcheck-plugin
　　（4）. 在jenkins的project的配置build中，添加shell执行，cppcheck --xml file.c 2> cppcheck-result.xml
　　（5）. 在jenkins的project的配置postbuild中,添加cppcheck reports
　　// 这个工具可以直接检查文件夹
　　2. cccc
　　这个工具是检查c/c++代码复杂度的工具
　　版本好像已经停止更新了，我使用的为最新3.14版本。
　　这个工具不太好用，可以直接对某个文件夹及其子文件夹进行分析，但是有时候莫名的死掉。所以，还是不要对整个工程所有文件进行分析，只分析有用的部分就好了。与jenkins结合后，在jenkins中查看结果，界面不是很友好，不如cccc工具本身生成的html查看方便。
　　还有就是3.14版本在linux下使用时，有个bug。源文件中,ccccmain.cc文件中，Main::AddFileArgument(const string& file_arg)中，if(file_arg=="-")语句中，while(!std::cin.eof())会多引入一个无用的文件名添加到file_list中，造成程序崩溃。只需在while语句结束后，添加file_list.pop_back();语句，删除最后一个添加的文件名就好了.(这个可是费了我两天的功夫才搞定的，汗!!!)
　　使用方法：
　　(1) 修改源代码(在windows下，不用修改)
　　(2) 编译安装
　　(3) 设置环境变量
　　(4) 在jenkins的job的配置build中，添加shell执行
　　例如：find sourceDir -type f | grep -E '^(sourcedir1|sourceDir2|xxxxx).*(\.cpp|\.c)$' | cccc --outdir=target/cccc --xml_outfile=target/cccc-result.xml -
　　//最后那个-别丢掉
　　//grep 正则表达式会用吧？不会的赶快补习!!!这里的grep是选择出要检查的代码的所在文件的名称
　　(5) 在jenkins的post build中，指定cccc-result.xml的目录
　　四. 总结
　　这几个工具还是有点用处的，使用后，可以检查出一些代码的错误。希望能给看到这篇文章的人一点帮助。剖砖引玉，轻拍!