美文网首页Swartz动物园程序员自动化测试
利用SonarQube构建代码质量管理平台

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

作者: 余鹏飞 | 来源:发表于2016-12-11 20:43 被阅读1398次

    先来一堆废话

    在创业初期有着两个“经验丰富的前后端”,可以说那个时候代码质量管理呈野蛮生长状态,彼此都非常信任,在追求速度的同时更看重的是最终的结果,至于代码的坏味道也只能闻一闻就罢了。而今(还是创业初期),团队成员在不断的壮大,每个人的代码质量参差不齐,代码质量管理势在必行。由于时间关系,最初考虑通过人工的方式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,只有两者很好的配合才能带来更大的提高和飞跃。

    相关文章

      网友评论

        本文标题:利用SonarQube构建代码质量管理平台

        本文链接:https://www.haomeiwen.com/subject/sfpumttx.html