sonarqube安装使用

目录

• 简介
• 效果(配置在下面查看)
• 官方文档
• 环境准备
• 配置compose-sonarqube.yml
• 启动
• 登录
• 集成Gitlab
  • 获取私钥
  • sonarqube配置gitlab
  • 查看项目
• 配置
  • 手动方式
  • Gitlab CI/CD 自动检测

简介

SonarQube是一个开源的代码质量管理平台，用于对代码进行静态代码分析、代码质量评估、检测代码漏洞和代码重复等。它提供了一个集中的仪表板，可以帮助开发人员和团队实时监测和跟踪代码质量，以及改进代码的可读性、可维护性和可靠性。
SonarQube支持多种编程语言，包括Java、C/C++、C#、JavaScript、Python等，可以分析和检测这些语言的代码，并提供详细的报告和指导建议。它使用了静态代码分析来检测代码中的常见问题，如代码重复、代码复杂度、安全漏洞、潜在的错误和坏味道等。
SonarQube的工作原理是通过插件和规则来对代码进行分析和评估。它提供了一系列的规则集，可以根据项目的需要进行配置和扩展。开发人员可以通过将SonarQube与版本控制系统集成，实现持续集成和自动化分析，以便在代码提交前及时发现和解决问题。
SonarQube还提供了一些高级功能，如代码覆盖率、复杂度热点、技术债务、代码质量门禁等。它还支持与Jenkins、GitLab等工具的集成，方便在开发流程中进行代码质量监控和管理。
总之，SonarQube是一个功能强大的代码质量管理平台，可以帮助开发人员提高代码质量，减少技术债务，并提供可靠的代码评估和建议。

❗这个工具能够在每次push代码的时候直接帮我们做代码检查，也可以直接检查仓库中的代码并提供丰富报表和解决方式

效果(配置在下面查看)

可以看到常见统计指标，其中代码重复率已经爆炸了。。1/5的代码重复。。

可以看到左侧的分类特别详细，实际可以操作的功能也很多

点击具体BUG可以看到详细错误信息

安全热点可以查看问题较大的代码

可以点击ide打开按钮，直接打开到当前文件

这边有详细的指标

代码统计

截图的时候是手动上传，所以活动较少，实际上通过CI方式，会和git提交同步

官方文档

https://docs.sonarqube.org/latest/setup/install-server/

环境准备

安装Docker-compose

gitlab配置CI/CD

配置compose-sonarqube.yml

version: "3"

services:
  sonarqube:
    image: sonarqube:community
    depends_on:
      - db
    environment:
      SONAR_JDBC_URL: jdbc:postgresql://db:5432/sonar
      SONAR_JDBC_USERNAME: sonar
      SONAR_JDBC_PASSWORD: sonar
    volumes:
      - sonarqube_data:/opt/sonarqube/data
      - sonarqube_extensions:/opt/sonarqube/extensions
      - sonarqube_logs:/opt/sonarqube/logs
    ports:
      - "9000:9000"
  db:
    image: postgres:12
    environment:
      POSTGRES_USER: sonar
      POSTGRES_PASSWORD: sonar
    volumes:
      - postgresql:/var/lib/postgresql
      - postgresql_data:/var/lib/postgresql/data

volumes:
  sonarqube_data:
  sonarqube_extensions:
  sonarqube_logs:
  postgresql:
  postgresql_data:

启动

docker-compose -f compose-sonarqube.yml up

登录

端口：9000

账号：admin

密码：admin

集成Gitlab

获取私钥

勾选api和read_user,其他不用勾选，过期时间可以不设置

sonarqube配置gitlab

查看项目

配置

手动方式

本地直接执行以下脚本即可自动上传

mvn sonar:sonar \
  -Dsonar.projectKey=tongliao_police_web_AXrl4hC7XnwxUigmqg-L \
  -Dsonar.host.url=http://121.4.23.85:9000 \
  -Dsonar.login=972afb8a29e0c64b9177f9b17fed5660e860476d

Gitlab CI/CD 自动检测

待完善