【转】Sonar的安装以及使用

超、凢脫俗 2023-07-18 04:48 26阅读 0赞

**【划重点！！这是一篇转载博客，转自：[https://www.cnblogs.com/qlqwjy/p/10551283.html][https_www.cnblogs.com_qlqwjy_p_10551283.html]】**

SonarQube是管理代码质量一个开放平台，可以快速的定位代码中潜在的或者明显的错误，下面将会介绍一下这个工具的安装、配置以及使用。

## 1. 简介 ##

### 1. sonar是什么 ###

Sonar是一个用于代码质量管理的开源平台，用于管理代码的质量，通过插件形式可以支持二十几种语言的代码质量检测，通过多个维度的检查了快速定位代码中潜在的或者明显的错误。

### 2. SonarQube与Sonar ###

SonarQube是sonar的服务端，相当于一个web服务器中的tomcat，用来发布应用，在线浏览分析等。

## 2.安装 ##

### 1.下载sonarqubexxx.zip并且解压即可: ###

下载地址:[http://www.sonarqube.org/downloads/][http_www.sonarqube.org_downloads]

下载完成后解压后点击StartSonar.bat启动即可，如下：

![format_png][]

**http访问9000端口出现下面则证明安装成功。 (如果需要修改端口等信息修改sonarqube-6.7.6\\conf\\sonar.properties即可)**

![format_png 1][]

### 2.配置数据库 ###

1. 在mysql数据库新建一个库的名称为sonar

2. 修改sonar/conf/sonar.properties的db信息:

不用放置驱动包，也不用创建表。

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

3.重启sonarQube会自动建表。

![format_png 2][]

4.接下来访问9000端口然后进行登录即可。默认创建的用户名和密码都是admin。可以在system选项卡看到系统信息

![format_png 3][]

## 3.使用 ##

### 1.下载sonar-scanner:(这个工具是对源码进行扫描，并将结果保存到数据库以便用上面的sonarqube进行分析) ###

下载地址: [https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner][https_docs.sonarqube.org_display_SCAN_Analyzing_with_SonarQube_Scanner]

### 2.配置mysql信息 ###

\\sonar\\sonar-scanner-3.3.0.1492-windows\\conf\\sonar-scanner.properties文件

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

#Configure here general information about the environment, such as SonarQube server connection 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
    
    sonar.jdbc.username=root
    sonar.jdbc.password=123456
    sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

### 3.配置环境变量 并测试 ###

path中增加如下变量: E:\\sonar\\sonar-scanner-3.3.0.1492-windows\\bin

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

C:\Users\Administrator>sonar-scanner --version
    INFO: Scanner configuration file: E:\sonar\sonar-scanner-3.3.0.1492-windows\bin\..\conf\sonar-scanner.properties
    INFO: Project root configuration file: NONE
    INFO: SonarQube Scanner 3.3.0.1492
    INFO: Java 1.8.0_121 Oracle Corporation (64-bit)
    INFO: Windows 10 10.0 amd64

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

### 4.打开要进行代码分析的项目根目录，新建sonar-project.properties文件 ###

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

# must be unique in a given SonarQube instance
    sonar.projectKey=my:project
    # this is the name displayed in the SonarQube UI
    sonar.projectName=springboot-ssm
    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=src/main/java
    sonar.java.binaries=./target/classes
     
    # Encoding of the source code. Default is default system encoding
    #sonar.sourceEncoding=UTF-8

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

解释：projectName是项目名字，sources是源文件所在的目录;sonar.java.binaries是项目编译后的class文件的目录。

### 5.设置成功后，启动sonarqube服务 ###

### 6.开始分析: ###

cmd窗口进入到项目的根路径，执行下面命令即可:

E:\xiangmu\springboot-ssm>sonar-scanner

如下:

![format_png 4][]

### 7.访问9000端口查看分析结果 ###

项目分析概要图:

![format_png 5][]

查看存在的bug:

![format_png 6][]

### 8.选择一个bug进行查看(可以看到与git也进行了集成，可以看到编写人与时间以及bug的原因) ###

![format_png 7][]

此工具还分析出一些异常信息的记录等，如下:

![format_png 8][]

### 9. 解决下面的bug ###

![format_png 9][]

**代码修改为下面即可:(上面逻辑应该是没有错，只是在多次改变引用的情况下被检测为bug)**

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

@Override
        public Token addOrUpdateToken(String username) {
            // 1.判断是否有对应的token,如果有的话更新时间，没有的话就创建token并且返回
            Token token = findTokenByUsername(username);
            // 1.1创建token并返回
            if (token == null) {
                return generateAndSaveTokenByUserName(username);
            }
    
            // 1.2根据失效时间更新且返回token
            return updateTokenByTokenLoseTime(token);
        }

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

### 10.解决异常处理的bug ###

![format_png 10][]

**代码修改为:**

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

@Scheduled(fixedRate = 10000)
        public void cron() {
            try {
                Thread.sleep(2000);
                System.out.println("spring anno task execute times " + count++);
            } catch (InterruptedException e) {
                System.err.println("InterruptedException " + e);
                Thread.currentThread().interrupt();
            }
        }

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

### 11.程序中故意写一个空指针异常看是否可以检测出来 ###

String string = null;
            if(string.equals("xxx")){
                System.out.println("xxx");
            }

结果:

![format_png 11][]

###  **更多的学习参考官网:** ###

[https://docs.sonarqube.org/display/SCAN/Advanced+SonarQube+Scanner+Usages][https_docs.sonarqube.org_display_SCAN_Advanced_SonarQube_Scanner_Usages]

[https://www.sonarqube.org/][https_www.sonarqube.org]

### 补充:sonarqube汉化 ###

*  到[https://docs.sonarqube.org/display/PLUG/Plugin+Library][https_docs.sonarqube.org_display_PLUG_Plugin_Library] 网站搜索 **chinese pack**

![format_png 12][]

*  **然后点击到对应的git地址[https://github.com/SonarQubeCommunity/sonar-l10n-zh/releases][https_github.com_SonarQubeCommunity_sonar-l10n-zh_releases]下载对应版本的jar包，下载之后放到sonar\\sonarqube-6.7.6\\extensions\\plugins目录下面重启即可，如下:**

![format_png 13][]

*  **再次通过9000端口访问发现变为中文版:**

![format_png 14][]

## 4. 注册为windows服务　 ##

sonar自带的有注册与删除服务的方法，采用wrapper注册为服务，如下已管理员方式运行InstallNTService.bat即可:

![format_png 15][]

注册为服务之后我这里启动服务报错不能正常启动服务，到 %sonar%/logs/sonar.log中查看原因如下:

Launching a JVM...
    Unable to execute Java command.  系统找不到指定的文件。 (0x2)

**解决办法：修改%sonar%/conf/wrapper.conf中java的路径为绝对路径**

![format_png 16][]

补充:sonar-scanner的配置也可以进行分模块配置，比如我想检测一个web项目的所有文件(包括Java、JSP、JS、Html、XML)，如下:

0. 如果检测html和JSP需要下载sonar-html-plugin-3.1.0.1615.jar插件置于sonarqube-6.7.6\\extensions\\plugins目录下，而且html的language为web，jsp的language为jsp

![format_png 17][]

1.项目结构如下:

![format_png 18][]

2.sonar-project.properties配置文件如下:

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

# must be unique in a given SonarQube instance
    sonar.projectKey=my:project
    # this is the name displayed in the SonarQube UI
    sonar.projectName=sonarTest
    sonar.projectVersion=1.0
    sonar.modules=java-module,javascript-module,xml-module,jsp-module,html-module
    sonar.sourceEncoding=UTF-8
    
    # Java module 
    java-module.sonar.projectName=Java Module 
    java-module.sonar.language=java 
    java-module.sonar.projectBaseDir=.
    java-module.sonar.sources=src
    #ignore files and directory
    java-module.sonar.exclusions=src/cn/qlq/test2/**,src/cn/qlq/test3.java
    sonar.java.binaries=./build
    
    # JavaScript module 
    javascript-module.sonar.projectName=JavaScript Module 
    javascript-module.sonar.projectBaseDir=.
    javascript-module.sonar.language=js 
    javascript-module.sonar.sources=WebContent
    
    # Jsp module 
    jsp-module.sonar.projectName=Jsp Module 
    jsp-module.sonar.projectBaseDir=.
    jsp-module.sonar.language=jsp
    jsp-module.sonar.sources=WebContent
    
    # Html module 
    html-module.sonar.projectName=Html Module 
    html-module.sonar.projectBaseDir=.
    html-module.sonar.language=web
    html-module.sonar.sources=WebContent
    
    #Xml module 
    xml-module.sonar.projectName=Xml Module 
    xml-module.sonar.projectBaseDir=.
    xml-module.sonar.language=xml
    xml-module.sonar.sources=WebContent

![复制代码][aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]

3.测试结果从web上访问如下:

![format_png 19][]

补充:sonar集成阿里的p3c规则

1.下载插件

到[https://github.com/mrprince/sonar-p3c-pmd/releases][https_github.com_mrprince_sonar-p3c-pmd_releases] 下载jar包即可

2.jar放在sonarqube-6.7.6\\extensions\\plugins目录下

3.重启sonarqube

4.到网页规则搜索p3c，如下

![format_png 20][]

5. 创建规则，不用选文件，如下：

![format_png 21][]

6.接下来激活p3c规则 (选择上面的创建的p3c，同时搜索未激活的p3c，然后激活即可。如果p3c也需要即可sonar的自带规则就不要加搜索条件，选择所有的规则)

![format_png 22][]

7.查看p3c激活的规则 (48条)

![format_png 23][]

8. 到质量配置设为java默认规则即可

![format_png 24][]

9.简单的测试

sonar自带的与p3c规则最明显的区别是:

str.equals("xxx")在p3c会被检测，在自带规则不会被检测到。

System.out.print... 会被自带规则检测到，p3c不会检测到。

[https_www.cnblogs.com_qlqwjy_p_10551283.html]: https://www.cnblogs.com/qlqwjy/p/10551283.html
[http_www.sonarqube.org_downloads]: http://www.sonarqube.org/downloads/
[format_png]: /images/20230528/1e91f0c6224d4802ae99d8d14f66fabc.png
[format_png 1]: /images/20230528/f1fee5e180ad4e718169bcf55e46a1c3.png
[format_png 2]: /images/20230528/3fbcca0b875c4ff8ad389f5561fddde1.png
[format_png 3]: /images/20230528/d66736ad82bf47fcab5ca54132c23722.png
[https_docs.sonarqube.org_display_SCAN_Analyzing_with_SonarQube_Scanner]: https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner
[aHR0cHM6Ly9jb21tb24uY25ibG9ncy5jb20vaW1hZ2VzL2NvcHljb2RlLmdpZg]: /images/20230528/50fa9990a4ad4362ac1730416e2940b1.png
[format_png 4]: /images/20230528/c3e9b803f5a149df811d59f5d743baa2.png
[format_png 5]: /images/20230528/9b3d5aef8c0f4820aaa1bfef7c3a2b92.png
[format_png 6]: /images/20230528/99fa5f67a41542f6a0833d40a6d12783.png
[format_png 7]: /images/20230528/4fbd939a27d44d1797f50910c68dbdcb.png
[format_png 8]: /images/20230528/5caca1f2fc724fc0b79007cad402fe2a.png
[format_png 9]: /images/20230528/cb0b87ee53f34c3c8e8709c258b98400.png
[format_png 10]: /images/20230528/c6fb132c850b41ccb0c30163ad4875a1.png
[format_png 11]: /images/20230528/4f03fc3e5e564a95a6cfa2e17cfd58d7.png
[https_docs.sonarqube.org_display_SCAN_Advanced_SonarQube_Scanner_Usages]: https://docs.sonarqube.org/display/SCAN/Advanced+SonarQube+Scanner+Usages
[https_www.sonarqube.org]: https://www.sonarqube.org/
[https_docs.sonarqube.org_display_PLUG_Plugin_Library]: https://docs.sonarqube.org/display/PLUG/Plugin+Library
[format_png 12]: /images/20230528/08bf8c5346f0460289a1d837a0ba5afc.png
[https_github.com_SonarQubeCommunity_sonar-l10n-zh_releases]: https://github.com/SonarQubeCommunity/sonar-l10n-zh/releases
[format_png 13]: /images/20230528/1107ac3e7dfd4657b59ef1e444c0cbf9.png
[format_png 14]: /images/20230528/007b88a4edf54424be2dcbd17b5a3928.png
[format_png 15]: /images/20230528/5040fcc1d5cd4b7594df5e875f165277.png
[format_png 16]: /images/20230528/190a8b70e2f949b6ba34a24d12ca16e3.png
[format_png 17]: /images/20230528/c085ae7a67e04eb09245a827476f1d5e.png
[format_png 18]: /images/20230528/166619ddee74426b9079d32a8eefcc8c.png
[format_png 19]: /images/20230528/fcc99d67656a493ca57c908ad354c57d.png
[https_github.com_mrprince_sonar-p3c-pmd_releases]: https://github.com/mrprince/sonar-p3c-pmd/releases
[format_png 20]: /images/20230528/9f96f4fedf434258a4245cbd2e5df9d9.png
[format_png 21]: /images/20230528/c80ae92b8d624f07a96abe1b243c446c.png
[format_png 22]: /images/20230528/a8dcd6438f5444beb4e75688e6834ec5.png
[format_png 23]: /images/20230528/e8b171ccbfb747dfbbe7206b7961e708.png
[format_png 24]: /images/20230528/0f8747cd3d07405a85427141da02e665.png