sonarqube代码扫描java项目 sonar代码检查java

转载

编程艺术之光 2023-07-14 14:14:04

文章标签 sonarqube代码扫描java项目 bc java mysql 文章分类 Java 后端开发

最近公司要求，学习了一下使用sonar进行代码分析检查。其中走了许多坑，配置也崩溃好几次。。。因此写下详细步骤以防以后再碰到这样的坑

一、安装Sonar

环境：Windows10，sonarqube6.7，java1.8，MySQL5.7.1 (注：用来检查java1.8以下的项目依旧可以使用，但是环境变量得是1.8的才能启动，我本次使用检查的项目就是jdk1.7)

Sonar官网地址：https://www.sonarqube.org/downloads/，首页截图如下：

sonarqube代码扫描java项目 sonar代码检查java_java

1、配置jdk1.8的环境

2、安装mysql数据库（也可以使用自带的数据库）

　　配置数据库用户：

CREATE DATABASE sonarCHARACTER SET utf8 COLLATE utf8_general_ci;   
  
CREATE USER 'sonar'IDENTIFIED BY 'sonar';  
  
GRANT ALL ON sonar.* TO'sonar'@'%' IDENTIFIED BY 'sonar';  
  
GRANT ALL ON sonar.* TO'sonar'@'localhost' IDENTIFIED BY 'sonar';

3、下载sonarqube6.7，解压到自己指定的目录下（我的路径是：D:\sonarqube-6.7）

　　配置sonar文件数据库信息（如果不用mysql或其他数据库的可以跳过本步骤）：在D:\sonarqube-6.7\conf 下打开sonar.properties 找到mysql定义的地方，修改为：

sonar.jdbc.username=sonar  
  
sonar.jdbc.password=sonar  
  
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false  
  
sonar.web.port=9000

　　此处的用户名密码即为刚才创建的，9000端口是启动服务器后访问的端口地址，也可以设置为其他的

4、启动运行sonarqube6.7

　　在安装路径D:\sonarqube-6.7\bin下会有不同操作系统对应的版本，，找到自己对应的版本，我的是win 64 ，进入之后点击启动服务批处理文件 D:\sonarqube-6.7\bin\windows-x86-64

sonarqube代码扫描java项目 sonar代码检查java_bc_02

　　如果不出意外的话，在大概几十秒之后可以在命令行窗口看到启动成功的信息如下：

sonarqube代码扫描java项目 sonar代码检查java_sonarqube代码扫描java项目_03

　　　　PS：我在启动时遇到了几个错误，大致解决方法可以分为几类：

　　　　　　1 .连接mysql数据库出错。。。这个时候先确定mysql是否可以正常连接，我当时就是因为没有启动mysql服务就启动sonarqube6.7了。。其他情况还可能使mysql的驱动版本不对，，这个时候D:\sonarqube-6.7\lib\jdbc\mysql 下面看看这个jar包对应不。

　　　　　2.可能是因为jdk环境不对。。。我电脑上由于项目版本较多，安装了jdk1.6、1.7、1.8的，可以直接在cmd窗口输入java -version,如果不是1.8的话需要改为1.8

　　　　　　修改方式：修改环境变量中JAVA_HOME是1.8的路径。。我当时修改成了1.8的还是不对，，然后搜索一波，发现我1.7的是使用安装包自动安装的，因此在C盘下有java.exe，直接删除即可。

　启动成功之后访问localhost:9000即可看到页面

sonarqube代码扫描java项目 sonar代码检查java_java_04

5、下载并配置插件sonar-scanner-2.6 下载地址：https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner

sonarqube代码扫描java项目 sonar代码检查java_java_05

此处可以看到当前最新版本是3.0.3的2018-01-09，我当时下载的时候下载的版本是2.6的，，大家可以在以前版本里面找到，，不过下载最新的应该也没问题（并没有试过，大致猜测哈）

下载之后是个zip压缩包，将其解压到自己指定路径下。我的路径是D:\tool\sonar-scanner-2.6。

然后直接在环境变量的path下面新建一个环境变量，指向D:\tool\sonar-scanner-2.6\bin 这一步是保证后面使用插件命令可以找到目录

下载完后找到配置文件的路径，编辑它D:\tool\sonar-scanner-2.6\conf\sonar-scanner.properties，，我直接加上mysql的即可

#Configure here general information about the environment, such as SonarQube DB details for example
#No information about specific project should appear here

#----- Default SonarQube server
#sonar.host.url=http://localhost:9000

#----- Default source code encoding
#sonar.sourceEncoding=UTF-8

#----- Global database settings (not used for SonarQube 5.2+)
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar

#----- PostgreSQL
#sonar.jdbc.url=jdbc:postgresql://localhost/sonar

#----- MySQL
sonar.jdbc.url=jdbc:mysql://127.0.0.1:3306/sonar?useUnicode=true&characterEncoding=utf8

#----- Oracle
#sonar.jdbc.url=jdbc:oracle:thin:@localhost/XE

#----- Microsoft SQLServer
#sonar.jdbc.url=jdbc:jtds:sqlserver://localhost/sonar;SelectMethod=Cursor

6、开始测试项目

到自己要测试的项目根路径下面新建一个sonar-project.properties文件。比如我要测试的项目路径是D:\Java\Test,,就在Test下建立sonar-project.properties文件，文件中配置要测试的信息，如下：

#required metadata 
#projectKey项目的唯一标识，不能重复

sonar.projectKey=testuser
sonar.projectName=testuser
sonar.projectVersion=1.0  
sonar.sourceEncoding=UTF-8 
sonar.modules=java-module
sonar.java.binaries=.
#,javascript-module,html-module 
  
# Java module 
java-module.sonar.projectName=Java Module 
java-module.sonar.language=java 
# .表示projectBaseDir指定的目录 
java-module.sonar.sources=. 
java-module.sonar.projectBaseDir=src/main/java 
sonar.binaries=classes
   
# JavaScript module 
#javascript-module.sonar.projectName=JavaScript Module 
#javascript-module.sonar.language=js 
#javascript-module.sonar.sources=js 
#javascript-module.sonar.projectBaseDir=src/main/webapp
   
# Html module 
#html-module.sonar.projectName=Html Module 
#html-module.sonar.language=web 
#html-module.sonar.sources=pages 
#html-module.sonar.projectBaseDir=src/main/webapp

　　此处对HTML，JavaScript的配置我直接删除了。。在代码中，红色的一句我暂时也没明白什么意思，，但是最开始没加的时候启动检测会报错

sonarqube代码扫描java项目 sonar代码检查java_mysql_06