SonarQube

爪哇程序人生
697 阅读2分钟

小知识，大挑战！本文正在参与“程序员必备小知识”创作活动

1. SonarQube的使用

SonarQube是一款用来检查代码质量的工具，发现代码中的潜在问题，提升我们开发效率。

sonarQube官网

2. IDEA中maven插件中配置SonarQube

本地IDEA中配置后，可在maven命令中执行代码质量扫描，并将扫描结果同步至远程服务器中

2.1 文件配置

首先需要修改本地maven的setting配置文件

<profile>
    <id>sonar</id>
    <activation>
        <activeByDefault>true</activeByDefault>
    </activation>
    <properties>
     	<!--服务安装地址-->   
        <sonar.host.url>
            http://10.2.55.100:9988
        </sonar.host.url>
    </properties>
</profile>

2.2 添加插件配置

以maven插件形式使用时，需要在pom.xml文件，即修改项目的依赖管理文件中添加maven插件信息

 <plugin>
     <groupId>org.sonarsource.scanner.maven</groupId>
     <artifactId>sonar-maven-plugin</artifactId>
     <version>3.7.0.1746</version>
 </plugin>

2.3 执行命令

配置完成后，在当前项目的maven命令中便会出现sonar命令工具，执行其中的sonar:sonar

image.png

执行后，会自动扫描本地代码，扫描完成后，到配置的服务端查可以看扫描报告。

3. IDEA中安装sonarLint插件

在IDEA中安装sonarLint可以在代码编写时就发现问题，或者仅在本地查看代码质量，而不需要扫描到服务端。

3.1 插件安装

  • IDEA中搜索Sonar，找到SonarLint插件进行安装
  • 官网地址：www.sonarlint.org/
  • 插件安装完成后，重启IDEA

image.png

3.2 插件使用

  1. SonarLint会出现在IDEA底部标签中，如果没有，则点击view -> Tool Windows -> SonarLint打开
  2. 选择文件夹或文件，右键 -> Analyze -> Analyze with SonarLint 或 右键 -> SonarLint分析代码质量
  3. SonarLint比较关心代码正确性，存在的问题，风险，漏洞等，例如，重复代码，空指针，安全漏洞等

3.3 SonarLint窗口名词含义

  • Current：IDEA当前打开文件的质量问题
  • Report：使用SonarLint分析的文件质量问题
  • Taint vulnerabilities：如果关联了SonarQube，则显示相关信息
  • Log：使用SonarLint检查代码时的日志输出
  • Rule：规则，问题的具体内容，并有示例和反例展示
  • Locations：问题重复出现的位置
  • Issues：检查产生的质量问题
  • 问题状态：
    • Bug：窃听器（可靠性）
    • Vulnerability：漏洞（安全）
    • Code Smell：代码嗅觉（可维护性）
  • 问题等级：
    • BLOCKER（致命）
    • CRITICAL（关键 ）
    • MAJOR（主要）
    • MINOR（微小）
    • INFO（未知）
avatar
文章
阅读
粉丝