利用SonarQube构建代码质量管理平台

先来一堆废话

在创业初期有着两个“经验丰富的前后端”,可以说那个时候代码质量管理呈野蛮生长状态,彼此都非常信任,在追求速度的同时更看重的是最终的结果,至于代码的坏味道也只能闻一闻就罢了。而今(还是创业初期),团队成员在不断的壮大,每个人的代码质量参差不齐,代码质量管理势在必行。由于时间关系,最初考虑通过人工的方式Review核心代码,对于非核心代码就不用花太多时间去check,直到发现了Ta,完全符合我的想象气质高贵宁静,自动帮我解决以上问题。

简介

Sonar是一个代码质量管理的开源工具,它通过插件的形式能够识别常见的20+种(C#,Javascript等)编程语言代码质量问题。而Sonar可以帮你分析出以下代码质量问题:

1.不遵循代码标准

2.潜在的缺陷

3.代码重复

4.注释率不足或过高

5.糟糕的复杂度分布

6.缺乏单元测试

7.糟糕的设计

准备工作

操作系统windows x64

下载JDK(JAVA的开发工具包)

下载SonarQube(很重要滴~~~)

下载SonarQube Scanner(执行代码分析的工具)

MySQL数据库

安装

1.下载后解压,并进入D:\setup\sonarqube-6.1\bin\windows-x86-64(对应操作系统)\。注意D:\setup是我的安装目录


2.双击“StartSonar.bat”就可以启动SonarQube服务了。

3.打开浏览器输入:http://localhost:9000/,出现下图则表明安装成功!

配置

1.在MySQL中新建数据库sonar(名字可以随便取),我是通过小猫咪Navicat连接。

2.打开对应目录文件sonar.properties(注:D:\setup是我的安装目录)

3.将你自己的MySQL信息替换

4.这个时候重启SonarQube服务,就可以正常登录,同时你可以在数据库中看到以下数据表被自动创建。

5.插件安装。SonarQube后台提供了丰富的插件支持,英语不好的我就需要安装Chinese Pack,这个是汉化后的效果,安装完插件后重启服务即可看到汉化后的效果。

6.打开刚刚下载的SonarQube Scanner文件夹,打开D:\setup\sonar-scanner-2.5\conf\sonar-runner.properties,将对应的信息修改。

7.配置环境变量

8.将SONAR_RUNNER_HOME配置到PATH,在末尾加上%SONAR_RUNNER_HOME%\bin;

9.打开cmd,输入sonar-runner -version则表明配置成功。

让它跑起来

1.在项目根目录新建文件sonar-project.properties,打开文件将以下内容复制到文件中,并修改projectName和sources(修改成你的根目录并将“\”转换成“/”)。

# must be unique in a given SonarQube instance

sonar.projectKey=my:project

# this is the name displayed in the SonarQube UI

sonar.projectName=fachan

sonar.projectVersion=1.0

# 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=E:/01fachan

# Encoding of the source code. Default is default system encoding

#sonar.sourceEncoding=UTF-8

2.打开cmd进入项目根目录,输入:sonar-runner就开始进行代码分析,跑完之后则会显示成功信息。

3.最后我们进入SonarQube可以看到下图:bug、漏洞、坏味道、重复代码等数据都很清晰的展示出来。

4.这是检查出来的问题,大家可以看看。是不是很方便啊~~~

补充

其实这些所谓的自动化工具和现在很火的人工智能领域一样,都没有达到通过机器完全替代人的盛景。自动化工具更多的是在辅助我们提高工作效率,减少人为的失误,而产品中的核心功能和业务逻辑还得需要项目管理者用心的Review,只有两者很好的配合才能带来更大的提高和飞跃。

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

推荐阅读更多精彩内容