SonarQube 代码质量管理平台

谁践踏了优雅 2023-01-08 12:24 211阅读 0赞

## SonarQube 代码质量管理平台 ##

### 一、SonarQube 概念 ###

SonarQube(sonar)是一个代码质量管理平台。 SonarQube不只是一个质量数据报告工具，更是代码质量管理平台。 支持java, C#, C/C++, PL/SQL, Cobol, JavaScrip, Groovy 等等二十几种编程语言的代码质量管理与检测。 SonarQube可以从以下七个维度检测代码质量，而作为开发人员至少需要处理前5种代码质量问题。
    
    (1) 不遵循代码标准
    SonarQube可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具规范代码编写。
    (2) 潜在的缺陷
    SonarQube可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具检 测出潜在的缺陷。
    (3) 糟糕的复杂度分布
    文件、类、方法等，如果复杂度过高将难以改变，这会使得开发人员 难以理解它们, 且如果没有自动化的单元测试，对于程序中的任何组件的改变都将可能导致需要全面的回归测试。
    (4) 重复
    显然程序中包含大量复制粘贴的代码是质量低下的，SonarQube可以展示 源码中重复严重的地方。
    (5) 注释不足或者过多
    没有注释将使代码可读性变差，特别是当不可避免地出现人员变动时，程序的可读性将大幅下降 而过多的注释又会使得开发人员将精力过多地花费在阅读注释上，亦违背初衷。
    (6) 缺乏单元测试
    SonarQube可以很方便地统计并展示单元测试覆盖率。
    (7) 糟糕的设计
    通过SonarQube可以找出循环，展示包与包、类与类之间的相互依赖关系，可以检测自定义的架构规则 通过SonarQube可以管理第三方的jar包，可以利用LCOM4检测单个任务规则的应用情况， 检测耦合。

### 二、SonarQube 下载安装 ###

#### 1、下载 ####

官网地址：[http://www.sonarqube.org/downloads/][http_www.sonarqube.org_downloads]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70]

#### 2、组成结构 ####

1. SonarQube Platform，就是SonarQube服务器，这是SonarQube运行的基础。
    首先下载并解压缩SonarQube的发布软件；
    必要的情况下配置解压缩目录下的sonarqube/conf/sonar.properties文件；
    启动SonarQube Platform：
        Windows下执行StartSonar.bat
        Linux下执行sonarqube/bin/sonar.sh start console
    启动成功，可以访问默认主页http://localhost:9000/，登录的用户名/密码为admin/admin。
    注意，在实验验证阶段，SonarQube Platform默认使用H2数据库；但是在生产环境中，还需要使用MySQL等其他企业级数据库服务器。 
    
    2. SonarQube Scanner，即分析项目代码的默认启动器
    首先下载并解压缩SonarQube Scanner；
    必要情况下，配置文件sonar-scanner/conf/sonar-scanner.properties；建议配置如下：
        每次提交前的分析，设置参数sonar.analysis.mode=preview
        每天都要执行的CI分析，设置参数sonar.analysis.mode=publish
    启动SonarQube Scanner：
        Windows下执行sonar-scanner.bat
        Linux下执行sonar-scanner/bin/sonar-scanner
    
    3.分析项目
    首先根据项目代码的编程语言，在线安装必要的SonarQube插件，以支持项目使用的编程语言；
    然后，cd到要分析的项目目录下，如some/projects/java/myproject/
    在项目目录下创建并配置sonar-project.properties文件如下：  
    sonar.projectKey=org.sonarqube:it-sonar-examples
    sonar.projectName=IT Sonar Examples Quality
    sonar.projectVersion=1.0
    sonar.sources=.
    sonar.sourceEncoding=UTF-8
    sonar.language=text

#### 3、启动验证 ####

首先下载并解压缩SonarQube的发布软件；
    必要的情况下配置解压缩目录下的sonarqube/conf/sonar.properties文件；
    启动SonarQube Platform：
        Windows下执行StartSonar.bat
        Linux下执行sonarqube/bin/sonar.sh start console
        
    注意: 在实验验证阶段，SonarQube Platform默认使用H2数据库；但是在生产环境中，还需要使用MySQL等其他企业级数据库服务器。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70 1]

### 三、SonarQube 配置使用 ###

#### 1、基础配置 ####

1.打开mysql，新建一个数据库。
    2.打开sonarqube安装目录下的D:\sonar\sonarqube-5.3\sonarqube-5.3\conf\sonar.properties文件
    3.在mysql5.X节点下输入以下信息
    sonar.jdbc.url=jdbc:mysql://192.168.10.10:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance sonar.jdbc.username=dev sonar.jdbc.password=123456 sonar.sorceEncoding=UTF-8 sonar.login=admin sonar.password=admin
     
    其中：url是数据库连接地址，username是数据库用户名，jdbc.password是数据库密码，login是sonarqube的登录名，sonar.password是sonarqube的密码
    4.重启sonarqube服务，再次访问http://localhost:9000，会稍微有点慢，因为要初始化数据库信息，重启时候有可能一直卡在那里，重启服务不生效，这时候可以重启电脑，然后再次访问http://localhost:9000，会发现配置生效。
    5.数据库初始化成功后，登录
    6.按照下图的点击顺序，进入插件安装页面，搜索框搜索chinese,选择中文包，安装中文插件，安装之后，会自动提醒重启服务，点击重启，重启完之后，刷新，就看到中文版的页面

#### 2、使用配置 ####

两种方式：1.maven提交分析。2.idea插件  
1.maven提交分析

1.  配置Maven的settings.xml

<settings>
        <pluginGroups>
            <pluginGroup>org.sonarsource.scanner.maven</pluginGroup>
        </pluginGroups>
        <profiles>
            <profile>
                <id>sonar</id>
                <activation>
                    <activeByDefault>true</activeByDefault>
                </activation>
                <properties>
                    
                    <sonar.host.url>
                      http://myserver:9000
                    </sonar.host.url>
                </properties>
            </profile>
         </profiles>
    </settings>

1.  配置Maven项目的pom.xml文件

<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <sonar.language>java</sonar.language>
      </properties>
      <build>
      <pluginManagement>
        <plugins>
          <plugin>
            <groupId>org.sonarsource.scanner.maven</groupId>
            <artifactId>sonar-maven-plugin</artifactId>
            <version>3.1.1</version>
          </plugin>
        </plugins>
      </pluginManagement>
    </build>

2.idea插件  
使用maven-sonar-plugin插件以进行SonarQube分析  
mvn clean verify sonar:sonar  
或mvn clean install org.sonarsource.scanner.maven:sonar-maven-plugin:3.1.1:sonar  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70 2]

### 四、SonarQube 常用规则 ###

很多规则，也可以自定义不在一一列举。  
[sonar rule][]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70 3]

参考：  
[SonarQube使用教程][SonarQube]  
[代码质量管理工具SonarQube详解][SonarQube 1]  
[SonarQube 代码质量管理平台][SonarQube 2]  
[sonar rule][]

[http_www.sonarqube.org_downloads]: http://www.sonarqube.org/downloads/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70]: /images/20221119/c311770dab244069be80728d30a29d35.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70 1]: /images/20221119/acdecde6bddc41369f9728032b284775.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70 2]: /images/20221119/63251551906b44e895a345e1d4482b49.png
[sonar rule]: http://www.voidcn.com/article/p-czczizzu-bnv.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L20wXzM3NTgzNjU1_size_16_color_FFFFFF_t_70 3]: /images/20221119/4a75d0d0457f4cf7a6dba5f879a91283.png
[SonarQube]: https://www.cnblogs.com/shuideqing/p/9649590.html
[SonarQube 1]: https://blog.csdn.net/taiyangdao/article/details/53122756
[SonarQube 2]: https://editor.csdn.net/md?not_checkout=1&articleId=112858909