Android 代码检查工具SonarQube

http://blog.csdn.net/rain_butterfly/article/details/42170601

代码检查工具能帮我们检查一些隐藏的bug,代码检查工具中sonar是比较好的一个。官网

Sonar 概述

Sonar 是一个用于代码质量管理的开放平台。通过插件机制,Sonar
可以集成不同的测试工具,代码分析工具,以及持续集成工具。与持续集成工具(例如 Hudson/Jenkins 等)不同,Sonar
并不是简单地把不同的代码检查工具结果(例如 FindBugs,PMD 等)直接显示在 Web
页面上,而是通过不同的插件对这些结果进行再加工处理,通过量化的方式度量代码质量的变化,从而可以方便地对不同规模和种类的工程进行代码质量管理。
 
      在对其他工具的支持方面,Sonar 不仅提供了对 IDE 的支持,可以在 Eclipse 和 IntelliJ IDEA
这些工具里联机查看结果;同时 Sonar 还对大量的持续集成工具提供了接口支持,可以很方便地在持续集成中使用 Sonar。
        此外,Sonar 的插件还可以对 Java 以外的其他编程语言提供支持,对国际化以及报告文档化也有良好的支持。
主要特点
  · 代码覆盖:通过单元测试,将会显示哪行代码被选中
  · 改善编码规则
  · 搜寻编码规则:按照名字,插件,激活级别和类别进行查询
  · 项目搜寻:按照项目的名字进行查询
  · 对比数据:比较同一张表中的任何测量的趋势

Sonar 的安装


         Sonar 是 Codehaus 上面的一个开源项目,使用的是 LGPL V3 软件许可。我们可以在其官方网站上下载其源代码及安装包。其源代码需要使用分布式版本控制软件 Git 进行检出(Check Out),命令行方式如下:
git clone git://github.com/SonarSource/sonar.git
        本文主要介绍 Sonar 的使用方法和Android studio插件安装方法,只需要到 Sonar 网站
载最近的发行包即可,本文写作时最新的版本为4.5.1,下载 zip 包后,直接解压到任意目录,由于 Sonar 自带了 Jetty 6
的应用服务器环境,所以不需要额外的安装就可以使用,值得一提的是 Sonar 也支持部署在 Apache Tomcat 应用服务器中。在
windows 环境中,直接启动 Soanr 的 bin 目录下 windows-x86-64\StartSonar.bat
即可。然后在浏览器中访问:http://localhost:9000/ 如图(汉化需要额外下载汉化包):

文档和一些jar包和插件安装点击run analysis:

首先登录配置项目:

默认是:admin,admin。

登录后如图:

点击Provisioning,点击创建 如图,输入关键字和项目名称(最好和检查代码的项目名称一致):

其他的设置不是必须的,可以略过。

如果不用集成插件比较麻烦且不容易使用,下面介绍下在Android studio中安装使用sonar插件(intellij idea类似)。如图:

点击安装后重启一下就安装好了。

下面说一下配置如下:

安装完后点击sonarqube选项,添加一个server,输入默认地址和用户名密码,测试连接,ok。

右击项目关联后台server项目:

输入配置的项目名称,ok:

右击analyze--》inspect code(还可以选择run inspection by name 输入 sonarqube issue),控制台就能看到结果了。

分析结果:

以上是插件形式,但是没有图形化的展示,下面介绍另一种实现方式:

效果图:

这种是不是就清楚多了,下面是详细步骤:

运行分析有好几种方法,这里使用官方建议的方法,下载SonarQube Runner

地址:http://repo1.maven.org/maven2/org/codehaus/sonar/runner/sonar-runner-dist/2.4/sonar-runner-dist-2.4.zip

解压到任意目录,最好不要包含中文路径。

设置环境变量SONAR_RUNNER_HOME,值设置为你的解压目录。

把解压目录/bin 添加到path环境变量。打开命令行输入sonar-runner -h

如果配置成功输出:

usage: sonar-runner [options]

 

Options:

 -D,--define <arg>     Define property

 -e,--errors           Produce execution error messages

 -h,--help             Display help information

 -v,--version          Display version information

 -X,--debug            Produce execution debug output

在需要调试的项目根目录下添加文件:sonar-project.properties

输入以下内容:

# Required metadata

# key 和 name 就是创建项目时输入的字段,这里填写自己的项目name和key,其他不用管。

sonar.projectKey=my:project

sonar.projectName=My project

sonar.projectVersion=1.0

# Path to the parent source code directory.

# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.

# Since SonarQube 4.2, this property is optional if sonar.modules is set. 

# If not set, SonarQube starts looking for source code from the directory containing 

# the sonar-project.properties file.

sonar.sources=src

# Encoding of the source code

sonar.sourceEncoding=UTF-8

# Additional parameters

sonar.my.property=value

然后命令行进入自己的项目跟目录,执行sonar-runner

例:D:\AndroidStudioWork\wodou> sonar-runner 打开控制台就能看到可视化数据了。

如有问题请留言,转载注明出处。

时间: 2025-01-06 15:10:33

Android 代码检查工具SonarQube的相关文章

《Android Studio有用指南》7.1 AndroidStudio代码检查工具概述

本文节选自<Android Studio有用指南> 作者: 毕小朋 博客: http://blog.csdn.net/wirelessqa 眼下本书已上传到百度阅读, 在百度中搜索[Anroid Studio有用指南]便能够找到本书. Android Studio提供了功能强大.高速.灵活的代码检查工具, 它能够检測出编译器和执行时的错误,在你编译之前建议你修正和攺进. Android Studio代码检查不仅仅能检查出编译错误, 还会检查出一些效率低下的代码,它支持一些代码规范.编程指南.最

静态代码检查工具 cppcheck 的使用(可分别集成到VS和QT Creator里)

CppCheck是一个C/C++代码缺陷静态检查工具.不同于C/C++编译器及其它分析工具,CppCheck只检查编译器检查不出来的bug,不检查语法错误.所谓静态代码检查就是使用一个工具检查我们写的代码是否安全和健壮,是否有隐藏的问题. 比如无意间写了这样的代码: [cpp] view plain copy int n = 10; char* buffer = new char[n]; buffer[n] = 0; 这完全是符合语法规范的,但是静态代码检查工具会提示此处会溢出.也就是说,它是一

代码检查工具jshint和csslint

前面的话 Douglas Crockford大神根据自己的理念用JavaScript写了一个JavaScript代码规范检查工具,这就是JSLint.后来非常流行,也的确帮助了广大的JavaScript程序员.但是,大神对于自己的代码规范不做丝毫的妥协,对开源社区的反馈的回应也不礼貌.于是,JSLint从一个帮助程序员规范代码,避免Bug的工具,变成了一个让代码像Crockford的工具.在最不信神的IT界,这当然不能忍了 2011年,一个叫Anton Kovalyov的前端程序员借助开源社区的

推荐一款华为最新的自动化代码检查工具

作为一枚软件攻城狮,你是不是总觉得自己撸代码的能力还有待提高却又无从下手?你是不是看到过XX大神美轮美奂的代码,然后佩服的五(ren)体(yang)投(ma)地(fan),然后躲在暗房里哭.然后你下定决心要痛改前非,然后发现无处下手,然后--又回到了以前的不归路? 如果你没有以上症状,请你关上浏览器,悄悄离开,千万别回头! 如果你有以上症状,但觉得自己已经病入膏肓,无法医治,让我拍拍你的肩,对你说"下辈子重新来过吧!". 如果你觉得自己还有救,就留下来继续观看,我给你开导开导. 要想修

PMD-Java 代码检查工具对 error 和 warning 的配置

PMD是一款优秀的Java程序代码检查工具.该它可以检查Java代码中是否含有未使用的变量.是否含有空的抓取块.是否含有不必要的对象等. 但在使用过程中,你会项目中发现存在大量的 PMD 插件报出的 error 和 warning,尽管 PMD 鼓励程序员去改进它们并写出干净的代码,但也产生了很多让人烦躁的感觉.更重要的是,你可能忽略了 Java 代码中真正的错误和问题.下面我们就通过在 Eclipse 中配置只有在选中的资源中才去对代码检查. 第一步,在 Eclipse 中选择Problems

静态代码检查工具 cppcheck 的使用

CppCheck是一个C/C++代码缺陷静态检查工具.不同于C/C++编译器及其它分析工具,CppCheck只检查编译器检查不出来的bug,不检查语法错误.所谓静态代码检查就是使用一个工具检查我们写的代码是否安全和健壮,是否有隐藏的问题. 比如无意间写了这样的代码: [cpp] view plaincopy int n = 10; char* buffer = new char[n]; buffer[n] = 0; 这完全是符合语法规范的,但是静态代码检查工具会提示此处会溢出.也就是说,它是一个

PMD 5.7.0 发布,Java 程序代码检查工具

PMD 5.7.0 发布了.PMD 是一款采用 BSD 协议发布的 Java 程序代码检查工具.该工具可以做到检查 Java 代码中是否含有未使用的变量.是否含有空的抓取块.是否含有不必要的对象等.该软件功能强大,扫描效率高,是 Java 程序员 debug 的好帮手.  值得注意的变化有:  Modified Rules   java-design 规则集中的 "FieldDeclarationsShouldBeAtStartOfClass" 规则具有一个新的 ignoreInter

最近开始研究PMD(一款采用BSD协议发布的Java程序代码检查工具)

PMD是一款采用BSD协议发布的Java程序代码检查工具.该工具可以做到检查Java代码中是否含有未使用的变量.是否含有空的抓取块.是否含有不必要的对象等.该软件功能强大,扫描效率高,是Java程序员debug的好帮手. PMD支持的编辑器包括: JDeveloper.Eclipse.JEdit.JBuilder.BlueJ.CodeGuide.NetBeans/Sun Java Studio Enterprise/Creator.IntelliJ IDEA.TextPad.Maven.Ant,

CSS代码检查工具stylelint

前面的话 CSS不能算是严格意义的编程语言,但是在前端体系中却不能小觑. CSS 是以描述为主的样式表,如果描述得混乱.没有规则,对于其他开发者一定是一个定时炸弹,特别是有强迫症的人群.CSS 看似简单,想要写出漂亮的 CSS 还是相当困难.所以校验 CSS 规则的行动迫在眉睫.stylelint是一个强大的现代 CSS 检测器,可以让开发者在样式表中遵循一致的约定和避免错误.本文将详细介绍CSS代码检查工具stylelint 概述 stylelint拥有超过150条的规则,包括捕捉错误.最佳实