需求描述
公司为项目代码配置了Sonar检测,最初只是想调研在VSCode中同步远程检测的方法(现在请参考Sonar:VSCode配置SonarLint/SonarLint连接SonarQube);结果并没有找到靠谱的教程。。在度娘的信息海洋胡乱扑腾两天后,本杂鱼最终在自己本地捣鼓出了一整个SonarQube服务。。。必须详细记录下来!!
准备工作
(0) 最初的最初:
请没有账号的小伙伴先到Oracle官网创建账号,流程很简单,填写一些信息即可~这一步非常非常重要!官网的资源和文档是获取最方便、问题最少的,比网络上大多信息靠谱太多太多!!(来自本·踩坑无数·杂鱼的忠告)
搭建SonarQube服务
(1) Java 11:
首先要搭建java环境,注意:必须安装Java 11,其他版本全部打咩!(SonarQube官方文档中明确标注了SonnarQube和sonar-scanner运行所需的Java版本是11或17;如果使用Oracle数据库,Oracle JDBC driver需要JDK11,so…如果不使用Oracle,请根据实际情况选择Java版本)。
官网下载链接:JDK 11.0.18,不熟悉java环境变量配置步骤的萌新戳这里:java环境变量 的配置与详解(全网最详细教程)
(2) SonarQube:
接下来有请本文的主角:SonarQube(官网下载链接)!直接选最新版本(本文使用的最新版本是9.8,更高版本细节请以官网文档为准),点击“DOWNLOAD”即可~
将下载的压缩包解压,并进入“SonarQube解压文件夹/bin/你的操作系统”文件夹:
以64位Win10系统为例,接下来需要安装并启动SonarQube服务;首先“Win+R”,输入“cmd”打开命令行,然后将“SonarService.bat”文件拖入命令行,再在填充好的文件路径后加上“ install”(文件路径和install间有空格),回车执行命令:
再次“Win+R”,输入“services.msc”打开服务管理器,在列表中已经出现了名为“SonarQube”的服务:
如果它能正常启动,那么在浏览器中打开http://localhost:9000就可以访问SonarQube的控制台啦~(初始的用户名和密码都是“admin”):
P.S.初始界面是英文的,这张图是后来截的请不用在意,当做一个小小的穿帮吧~安装汉化插件在后文。
如果服务起不来,可以进入“SonarQube解压文件夹/logs”,根据其中“web.txt”的内容进行排查:
(3) 数据库:
如果你已经安装了SonarQube支持的数据库环境,请跳过此步;受支持的数据库环境请参考Prerequisites and overview-Supported platforms。
这是一个大家伙:Oracle 19c,不过官网下载速度挺快的:
安装过程个人觉得没有需要特别注意的,记好设置的初始密码即可;服务管理器中Oracle相关服务基本都在运行应该就OK了:
数据库连接工具我用的Navicat,需要为Sonar创建一个单独的用户和数据库,操作步骤可以参考:使用navicat创建Oracle数据库
Oracle服务相关的两个小坑坑记录:
① 01219 oracle,ORA-01219: 数据库或可插入数据库未打开: 仅允许在固定表或视图中查询
可参考这两篇博客:解决方案参考链接1、解决方案参考链接2
② ORA-12514 TNS 监听程序当前无法识别连接描述符中请求服务
可参考:ORA-12514 … 的解决方法
总之,为Sonar新建一个数据库和数据库用户,且数据库服务正常运行无报错;这一步就成功啦!
配置SonarQube
主要参考了SonarQube-Docs 9.8中的安装服务、安装插件两节:
配置数据库
以Oracle为例,首先需要修改配置文件;进入“SonarQube解压文件夹/conf”,打开其中的sonar.properties文件:
搜索“Oracle”,根据实际情况进行数据库连接、用户名、密码配置:
sonar.jdbc.url=jdbc:oracle:thin:@IP:1521/你的数据库服务名
sonar.jdbc.username=你的用户名
sonar.jdbc.password=你的密码
接下来需要获取数据库驱动:Oracle Database 19c (19.18.0.0) JDBC Driver,直接下载即可:
进入“SonarQube解压文件夹/extensions”,在其中新建一个文件夹“jdbc-driver”,再在“jdbc-driver”下新建一个“oracle”文件夹,将下载的jdbc包放在“oracle”下:
在服务管理器中重启SonarQube服务,可以看到空白的数据库中自动生成了大量表格:
安装插件
SonarQube9.8安装插件需要自己下载包,放到服务的插件目录下;以安装汉化插件为例,首先登录SonarQube控制台,点击“Administration”->“Marketplace”,在Plugins搜索框中输入“Chinese”,点击第一条结果右侧的“Homepage”:
点击Latest version后的链接,将网址末尾的版本号改为与SonarQube9.8兼容的“9.8”,直接点击下载其中的jar包:
进入“SonarQube解压文件夹/extensions/plugins”,将下载的jar包放到文件夹中:
最后,在服务管理器中重启SonarQube服务,可以看到界面文字变成中文:
scanner
进行扫描需要下载对应的扫描器,鉴于官方文档非常全面,引导也很清晰,直接按照指示操作即可;比如新建一个进行本地分析的测试项目,选择了相应的构建技术和操作系统后,页面会给出详细的操作指引:
个人认为官网文档包含了使用的各种细节,篇幅有限,就记到这里吧~★▽★~