Sonar的安装与使用

SonarQube® is an automatic code review tool to detect bugs, vulnerabilities and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.

Sonar可以从7个维度检查代码质量,通过插件的形式可以支持包括java、C#、C/C++,PL/SQL,Cobol,JS等20多种编程语言的代码质量管理与检测。

7个维度是:复杂度过高、重复率过高、单元测试覆盖率、代码编写规范性、代码可读性、潜在bug、架构设计。

本文按以下顺序整理了个人在本地(win7)使用SQ的过程:

SonarQube安装——修改配置——SQ汉化——下载配置插件sonar-scanner——扫描、分析

一、SQ下载与安装

下载SonarQube

前置条件:

1、已安装JAVA环境

2、已安装支持的数据库(本文使用内置数据库,无需安装)

下载SonarQube:SQ官网

注意事项:

下载和安装SQ之前,先看各版本的环境要求(我安装7.9版本时安装失败,因为我本机的jdk是1.8,最高只能安装7.8版本的SQ)

因为我是用来本地试用的,所以下载“Community Edition”版本;

下载安装包后,解压到你喜欢的目录下,在cmd中执行 bin\windows-x86-64\StartSonar.bat

当日志末尾出现以下信息时,表示SQ启动成功:

在本地浏览器输入http://localhost:9000即可访问SQ的web页面,已经默认内置了管理员账号:admin/admin  

安装汉化包

汉化以后,SQ的web页面内容将以中文显示。有2种方式(安装后重启SQ服务即可):

方法1:在线安装插件

在浏览器登录SQ,可以在线搜索安装对应版本的chinese插件

方法2:外部下载后安装

下载汉化包:SQ汉化包下载地址

Latest version-》Releases-》选择需要下载的版本;

将下载好的jar包放到入 extensions\plugins 目录下;

注意:

汉化包和SQ版本要一一对应(如下表)

安装SonarQube Scanner

SonarQube Scanner 就是真正进行代码扫描的工具包。

SonarQube Scanner下载:在 SQ官方文档 搜索“Analyzing with SonarQube Scanner”,进入SonarScanner介绍文档 下载所需的版本

下载后,按里面的指南安装即可。大致如下:

1、将scanner包放在你喜欢的目录下($install_directory)

2、修改sonar服务的全局设置:$install_directory/conf/sonar-scanner.properties(安装在本地的话则无需修改)

3、将 $install_directory/bin 添加到环境变量PATH(一般是用户变量;若添加失败可尝试重启电脑)

4、验证是否安装成功:sonar-scanner.bat -h

二、使用SQ分析源码

1、在将要扫描分析的源码项目的根目录下创建配置文件sonar-project.properties

# 当前项目实例的唯一表示

sonar.projectKey=streamstatus_sail

# 显示在sonarqube 界面上的项目名称

sonar.projectName=streamstatus_sail 

sonar.projectVersion=1.0 

# 相对于当前配置文件目录 下的源代码目录 不管什么平台路径分隔符只能用/不能使用\ 

sonar.sources=src/test/java

# 源代码的字符集

#sonar.sourceEncoding=UTF-8

sonar.java.binaries=E:/Program Files(x86)/Java/workspace/streamstatus_sail/target/classes

注意:若配置文件中没有最后一行(即 sonar.java.binaries 的配置),扫描分析时会出错,报org.sonar.java.AnalysisException: Please provide compiled classes of your project with sonar.java.binaries property 错误

2、在cmd进入待扫描项目的目录,执行命令:sonar-scanner

3、扫描完成后,在SQ的web平台即可看到新增的项目及详细的扫描结果

至此,完成了Sonar的本地安装与使用~



参考文档:

http://www.sonar.org.cn/install/2414.html https://www.cnblogs.com/tiaoshuidenong/p/10142840.html https://blog.csdn.net/liaomin416100569/article/details/79230610 https://www.cnblogs.com/DoJavaByHeart/p/8253065.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,492评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,048评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,927评论 0 358
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,293评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,309评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,024评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,638评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,546评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,073评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,188评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,321评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,998评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,678评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,186评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,303评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,663评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,330评论 2 358

推荐阅读更多精彩内容