SonarQube 的简介、安装、配置

前期准备:

  • SonarQube 简介
  • 环境准备
  • 软件准备
  • 安装配置
  • 汉化插件安装

话不多说,开始

SonarQube 简介

SonarQube是一个用于管理代码质量的开放平台,可以快速的定位代码中潜在的或者明显的错误。目前支持java,C#,C/C++,Python,PL/SQL,Cobol,JavaScrip,Groovy等二十几种编程语言的代码质量管理与检测。

SonarQube特性

  • 持续检查

    • 项目整体的健康程度:项目的主页面会给出,项目整体的Bugs、Vulnerabilities、Code Smells
    • 专注于漏洞
  • 监测棘手的问题

  • 多语言支持

  • 集成DevOps(evOps 是一个完整的面向IT运维的工作流,以 IT 自动化以及持续集成(CI)、持续部署(CD)为基础,来优化程式开发、测试、系统运维等所有环节)

  • 集中质量

七个维度检测代码质量

  • 复杂度分布(complexity):代码复杂度过高将难以理解
  • 重复代码(duplications):程序中包含大量复制、粘贴的代码而导致代码臃肿,sonar可以展示源码中重复严重的地方
  • 单元测试统计(unit tests):统计并展示单元测试覆盖率
  • 代码规则检查(coding rules):通过Findbugs,PMD,CheckStyle等检查代码是否符合规范
  • 注释率(comments):若代码注释过少,特别是人员变动后,其他人接手比较难接手;若过多,又不利于阅读
  • 潜在的Bug(potential bugs):通过Findbugs,PMD,CheckStyle等检测潜在的bug
  • 结构与设计(architecture & design):找出循环,展示包与包、类与类之间的依赖、检查程序之间耦合度

SonarQube安装:

下载地址:https://www.sonarqube.org/downloads/

在这里插入图片描述
下载完成后,解压缩直接可以使用,打开bin目录下对应OS的StartSonar.bat,例如本人的电脑是windows64位
在这里插入图片描述
浏览器中打开:http://localhost:9000,可以进入web界面

至此安装成功:

SonarQube配置:
SonarQube工具需要数据库的支持,Scanner扫描项目时,会将分析结果存入数据库,web页面生成报告时会读取数据库的数据
目前支持Oracle、MySQL、PostgreSQL、MS SQL,数据库版本以及要求
具体可参考:https://docs.sonarqube.org/latest/requirements/requirements/

  1. 建立数据库:
    建立Mysql数据库sonar
    MySQL数据库必须是InnoDB存储引擎,不支持MyISAM
  2. 配置 sonar.properties
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar7?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false  #数据库连接地址
sonar.jdbc.username=root  #数据库账号
sonar.jdbc.password=123456 #数据库密码
sonar.sorceEncoding=UTF-8
sonar.login=admin #web页面注册的账号
sonar.password=admin #web页面注册的密码

配置完成后,重新启动StartSonar.bat, 如果启动不成功,可以结束Java™ Platform SE binary

启动成功:
1)cmd命令行sonarqube is up
2)localhost:9000 可以打开
3)数据库中,生成了十几张表

SonarQube使用
使用SonarQube需要插件SonarQube Scanner
下载地址:https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/

下载完成后,配置conf文件夹下的sonar-scanner.properties

sonar.host.url=http://localhost:9000
sonar.sourceEncoding=UTF-8

配置安装目录配置环境变量
新建变量:SONAR_SCANNER_HOME=G:\develop\sonarqube-7.4\sonar-scanner-3.2.0.1227-windows
编辑path:新增%SONAR_SCANNER_HOME%\bin;
命令行cd到目录执行sonar-scanner -h,可以正常返回相关信息即安装成功

SonarQube项目配置
进入待检测的项目目录中,新建sonar-project.properties,增加以下内容:

sonar.projectKey=my:project
sonar.projectName=My project
sonar.projectVersion=1.0 
sonar.sources=.
sonar.sourceEncoding=UTF-8

打开命令行窗口,切换目录到项目目录,输入sonar-scanner

运行成功后,打开web界面,即可看到对当前项目的分析

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章