SonarQube介绍及部署
SonarQube介绍及部署
编写人:罗旭成
编写时间:2014-5-28
SonarQube简介
SonarQube是一个用于代码质量管理的开源平台(Java开发),用于管理源代码的质量,可以从七个维度检测代码质量,通过插件形式,可以支持包括Java,C#,C/C++,PHP,PL/SQL,Cobol,Web,XML,JavaScrip,Groovy等等二十几种编程语言的代码质量管理与检测。
SonarQube能带来什么?
1.糟糕的复杂度分布
文件、类、方法等,如果复杂度过高将难以改变,这会使得开发人员难以理解它们,且如果没有自动化的单元测试,对于程序中的任何组件的改变都将可能导致需要全面的回归测试。
2.重复
显然程序中包含大量复制粘贴的代码是质量低下的, SonarQube可以展示源码中重复严重程度。
3.缺乏单元测试
SonarQube可以很方便地统计并展示单元测试覆盖率。
4.没有代码标准
SonarQube可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具规范代码编写。
5.没有足够的或者过多的注释
没有注释将使代码可读性变差,特别是当不可避免地出现人员变动时,程序的可读性将大幅下降,而过多的注释又会使得开发人员将精力过多地花费在阅读注释上,亦违背初衷。
6.潜在的bug
SonarQube可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具检测出潜在的Bug。
7.糟糕的设计(原文Spaghetti Design,意大利面式设计)
通过SonarQube可以找出循环,展示包与包、类与类之间的相互依赖关系,可以检测自定义的架构规则,通过SonarQube可以管理第三方的Jar包,可以利用LCOM4检测单个任务规则的应用情况,检测耦合。
SonarQube部署说明
(以C#源码为例)
第一步:安装SonarQube
1. 准备好JAVA环境(Java6.0)。
2. 准备好MySQL环境(可用默认的数据库derby,配置文件全部不用做修改)。
3. 下载最新的SonarQube,(下载网址为:http://www.sonarqube.org/)解压到目录C:\app\sonarqube-4.3(当前为最新版)。
4. 修改配置文件C:\app\ sonarqube-4.3\conf\sonar.properties:
#数据库用户名 sonar.jdbc.username=root #数据库密码 sonar.jdbc.password=root #数据库地址 sonar.jdbc.url:jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true #数据库驱动 sonar.jdbc.driverClassName:com.mysql.jdbc.Driver #数据库相关配置 sonar.jdbc.maxActive=20 sonar.jdbc.maxIdle=5 sonar.jdbc.minIdle=2 sonar.jdbc.maxWait=5000 sonar.jdbc.minEvictableIdleTimeMillis=600000 sonar.jdbc.timeBetweenEvictionRunsMillis=30000
5. 执行C:\app\sonar-3.6\bin\windows-x86-64\StartSonar.bat(操作系统为windows xp),启动自带的JETTY服务器。打开http://localhost:9000,如果显示SonarQube主页,则SonarQube安装成功.
安装成功后的效果:
6. 安装中文插件和其它语言插件:将插件JAR包放到目录C:\app\ sonarqube-4.3\extensions\plugins,重启服务即安装成功。
7. 数据库会自动创建表结构(MySQL):
注:默认的配置可以不作修改,直接可连接上,连的默认数据库为derby。
第二步:安装SONAR-RUNNER
1. 下载sonar-runner,解压到目录C:\app\sonar-runner-2.4
2. 修改配置文件C:\app\sonar-runner-2.4\conf\sonar-runner.properties:
#sonar访问地址 sonar.host.url=http://localhost:9000 #连接数据库地址 sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8 #数据库的用户名 sonar.jdbc.username=root #数据库的密码 sonar.jdbc.password=root #sonar的字符集 sonar.sourceEncoding=zh_CN #sonar的登录用户 sonar.login=admin #sonar的登录密码 sonar.password=admin
3. 添加系统环境变量:SONAR_RUNNER_HOME 值为 C:\app\sonar-runner-2.4。
4. 修改环境变量Path,在变量值末尾添加:“;%SONAR_RUNNER_HOME%\bin”。
5. 命令行里执行 sonar-runner -h 如果显示如下内容,则安装成功。
C:\app\sonar-runner-2.4 INFO: INFO: usage: sonar-runner [options] INFO: INFO: Options: INFO: -D,--define <arg> Define property INFO: -e,--errors Produce execution error messages INFO: -h,--help Display help information INFO: -v,--version Display version information INFO: -X,--debug Produce execution debug output
第三步:分析代码
1. 拷贝代码到C:\app\project
代码目录结构如图:
2. 添加C:\app\project\sonar-project.properties 内容如下 :
#项目主键 需要唯一 sonar.projectKey=DataCollectionSolution #项目版本 sonar.projectVersion=1.0 #项目名称 sonar.projectName=C# Project #sonar的语言 sonar.language=cs sonar.dotnet.key.generation.strategy=safe sonar.sourceEncoding=UTF-8 #项目访问目录 sonar.sources=C:\\app\\project\\ sonar.fxcop.mode=skip sonar.gendarme.mode=skip sonar.gallio.mode=skip sonar.ndeps.mode=skip sonar.stylecop.mode=skip
3 命令行里执行 cd C:\app\project 到项目根目录。
然后执行命令:sonar-runner,控制台会打印分析过程。当出现SUCCESS时,则分析成功。
INFO: -------------------- INFO: EXECUTION SUCCESS INFO: -------------------- Total time: 2:37.891s Final Memory: 14M/449M INFO: --------------------
刷新网站,显示如下:
完成以上操作及配置成功。
官网:http://www.sonarqube.org/
示例:http://nemo.sonarsource.org/
文档&插件:http://docs.codehaus.org/
SonarQube介绍及部署的更多相关文章
- Redis介绍及部署在CentOS7上(一)
0.Redis目录结构 1)Redis介绍及部署在CentOS7上(一) 2)Redis指令与数据结构(二) 3)Redis客户端连接以及持久化数据(三) 4)Redis高可用之主从复制实践(四) 5 ...
- ceph-csi组件源码分析(1)-组件介绍与部署yaml分析
更多ceph-csi其他源码分析,请查看下面这篇博文:kubernetes ceph-csi分析目录导航 ceph-csi组件源码分析(1)-组件介绍与部署yaml分析 基于tag v3.0.0 ht ...
- Spark入门实战系列--5.Hive(上)--Hive介绍及部署
[注]该系列文章以及使用到安装包/测试数据 可以在<倾情大奉送--Spark入门实战系列>获取 .Hive介绍 1.1 Hive介绍 月开源的一个数据仓库框架,提供了类似于SQL语法的HQ ...
- 服务发现 - consul 的介绍、部署和使用
什么是服务发现 相关源码: spring cloud demo 微服务的框架体系中,服务发现是不能不提的一个模块.我相信了解或者熟悉微服务的童鞋应该都知道它的重要性.这里我只是简单的提一下,毕竟这不是 ...
- 服务发现之consul的介绍、部署和使用
什么是服务发现 微服务的框架体系中,服务发现是不能不提的一个模块.我相信了解或者熟悉微服务的童鞋应该都知道它的重要性.这里我只是简单的提一下,毕竟这不是我们的重点.我们看下面的一幅图片: 图中 ...
- Azkaban介绍+安装部署+实战案例
Azkaban介绍 什么是azkaban?1.工作流的作业调度系统2.通过k.v指令写法描述工作流节点3.可以通过web界面去管理工作流 Azkaban安装部署 2.3.1 准备工作 Azkaban ...
- 服务发现 - consul 的介绍、部署和使用(转)
什么是服务发现 相关源码: spring cloud demo 微服务的框架体系中,服务发现是不能不提的一个模块.我相信了解或者熟悉微服务的童鞋应该都知道它的重要性.这里我只是简单的提一下,毕竟这不是 ...
- Python多版本管理器-pyenv 介绍及部署记录
一. pyenv简单介绍 在日常运维中, 经常遇到这样的情况: 系统自带的Python是2.x,而业务部署需要Python 3.x 环境, 此时需要在系统中安装多个Python版本,但又不能影响系统自 ...
- Apache Ignite 学习笔记(一): Ignite介绍、部署安装和REST/SQL客户端使用
Apache Ignite 介绍 Ignite是什么呢?先引用一段官网关于Ignite的描述: Ignite is memory-centric distributed database, cachi ...
随机推荐
- 004-Shell 基本运算符、算术运算符、关系运算符、布尔运算符、辑运算符、字符串运算符、文件测试运算符
一.概述 Shell 和其他编程语言一样,支持多种运算符,包括: 算数运算符 关系运算符 布尔运算符 字符串运算符 文件测试运算符 二.算术运算符 原生bash不支持简单的数学运算,但是可以通过其他命 ...
- python yield的终极解释
(译)Python关键字yield的解释(stackoverflow): http://stackoverflow.com/questions/231767/the-python-yield-keyw ...
- 产品固件(系统)升级——curl/wget
1.文件下载指令应用 支持断点续传 curl -C - -O "https://curl.haxx.se/download/archeology/curl-7.58.0.tar.gz&quo ...
- Spark2.0机器学习系列之2:基于Pipeline、交叉验证、ParamMap的模型选择和超参数调优
Spark中的CrossValidation Spark中采用是k折交叉验证 (k-fold cross validation).举个例子,例如10折交叉验证(10-fold cross valida ...
- 在MFC中使用一个单独的类实现数据在各个类之间的传递
第一步:使用VS2010创建一个基于MFC的单文档程序,然后 编译 运行 确定没有问题. 第二步:添加一个名叫CGszCommonData 类. 第三步:在应用程序类的头文件里 添加#includ ...
- boost enable_shared_from_this
关于shared_ptr和weak_ptr看以前的:http://www.cnblogs.com/youxin/p/4275289.html The header <boost/enable_s ...
- Leetcode 357
没用过Leetcode刷题,只能按照自己的想法随便写写了 思路:1.第一位数有9种(除了0)可能,第二位数有9种(除了第一位)可能,第三位数有8种(除了前两位)可能,以此类推...9*8*7*...( ...
- Restful风格API
一:协议 API与用户的通信协议,总是使用HTTPS协议. 二:域名 应该尽量将API部署在专用域名之下. https://api.example.com 如果确定API很简单,不会有进一步扩展,可以 ...
- Android4.0 Surface机制分析
1. java层面的Surface 对于Surface我们的认识主要是android的类Surface, android的文档描述Surface是"Handle onto a raw ...
- AJAX跨域问题解决方法(4)——调用方解决跨域
调用方解决跨域的方法只有一种,那就是隐藏跨域. 何为隐藏跨域? 隐藏跨域的核心思路是通过反向代理隐藏跨域以欺骗浏览器 什么是反向代理?反向代理是指通过中间服务器使得访问同一个域名的两个不同url最终会 ...