关注

SonarQube for IDE 使用教程

一、安装

  1. 在 Cursor/VS Code 左侧打开 扩展(Extensions) 面板。
  1. 搜索 "SonarQube" 或 "SonarLint"(新版本可能叫 SonarQube for IDE)。
  1. 点击 安装,按提示重载窗口。

环境要求:Node.js 需 20.12.0 及以上。


二、本地分析(不连服务器也能用)

1. 自动分析

  • 打开或保存文件时,插件会自动分析当前文件。
  • 若开启了 自动保存,边写代码边会出问题提示。
  • 问题会出现在:
  • 编辑器中(波浪线等)
  • 问题(PROBLEMS) 面板里。

2. 开关自动分析

  • 在状态栏找到 SonarQube 图标,点击可开启/关闭自动分析。
  • 或在左侧 SONARQUBE 面板里,点双箭头刷新图标切换。

3. 只分析“已修改文件”(适合提 PR 前)

  • 打开 源代码管理(SOURCE CONTROL) → Changes。
  • 点击 “Analyze Changed Files with SonarQube” 图标。
  • 会只分析自上次提交以来改动的文件,适合提交/PR 前做一次检查。

4. 查看问题详情

  • 在代码里点问题位置,或从 PROBLEMS 面板进入。
  • 可看到规则说明、严重程度,部分问题有修复建议(含 AI CodeFix)。

三、连接模式(Connected Mode)— 连 SonarQube 服务器

连接后可以和团队共用规则、质量配置,并同步服务端问题状态。

1. 打开连接设置

  • 左侧 活动栏 点 SONARQUBE SETUP(或 SonarQube 相关图标)。
  • 进入 CONNECTED MODE。

2. 连接 SonarQube Server(自建)

  1. 选 Add SonarQube Server Connection。
  1. 填写:
  • Server URL:例如 http://localhost:9000 或公司 SonarQube 地址。
  • User Token:在 SonarQube 里 账户 → Security 生成 用户 Token(不要用项目 Token / 全局 Token)。
  • Connection Name:给这个连接起个名字。
  1. 可选:开启/关闭智能通知(新问题、质量门变化等)。
  1. 点 Save Connection。

3. 连接 SonarQube Cloud

  1. 选 Add SonarQube Cloud Connection。
  1. 填写:
  • User Token:在 sonarcloud.io/account/security 生成。
  • Organization:从下拉选你的组织。
  • Connection Name:连接名称。
  1. 点 Save Connection。

4. 绑定项目(Binding)

  1. 保存连接后,在 CONNECTED MODE 里选 Add Project Binding(或按提示“Configure Binding”)。
  1. 若工作区有多个文件夹,先选要绑定的那个。
  1. 在列表里选对应的 SonarQube 上的项目。
  1. 保存后即可与服务器同步规则、质量配置和问题状态。

四、连接模式能带来什么

  • 与服务器使用相同规则、质量配置、文件排除。
  • 服务端标记为“已接受 / 误报”的问题,在 IDE 里会同步不再提示。
  • 支持更多语言(如 Apex、PL/SQL 等)和污点分析等高级规则。
  • 智能通知:新问题、质量门失败等会推送到 IDE。
  • 可从 SonarQube 网页点 “Open in IDE” 在编辑器中打开对应问题(需本地运行 IDE)。

五、团队共享配置(推荐)

  1. 第一个人按上面步骤完成:连接 + 项目绑定。
  1. 在 CONNECTED MODE 里找到该连接和绑定,点 “Share Connected Mode Configuration”(分享/导出图标)。
  1. 确认后会在项目下生成 .sonarlint/ 里的配置文件(含 Server URL 和 Project Key)。
  1. 把该文件提交到 Git,其他人拉代码后:
  • 打开项目时,插件会提示“发现共享的绑定配置”。
  • 选 Use Configuration,再填自己的 User Token 即可绑定,无需重新选项目。

注意:Token 不能共享,每人自己在 SonarQube/SonarCloud 生成;共享的只是“连哪个服务器、绑哪个项目”的配置。


六、常用入口小结

操作位置
开/关自动分析状态栏 SonarQube 图标 或 SONARQUBE 面板刷新图标
分析已修改文件源代码管理 → Changes → “Analyze Changed Files” 图标
连接/绑定活动栏 → SONARQUBE SETUP → CONNECTED MODE
查看问题PROBLEMS 面板 或 编辑器内波浪线

七、遇到问题时

  • Node 版本报错:确保 Node ≥ 20.12.0(用 node -v 检查)。
  • 连接/绑定失败:确认用的是 User Token,且服务器地址、项目 Key 正确。
  • 规则或结果和网页不一致:确认已绑定到正确项目和分支;连接模式会按当前 Git 分支匹配服务器上的分支。

如果你说一下当前卡在哪一步(例如:安装后没反应、连不上公司 SonarQube、不会绑定项目),可以按你的实际情况写更具体的操作步骤。

转载自CSDN-专业IT技术社区

原文链接:https://blog.csdn.net/m0_73612839/article/details/158537554

评论

赞0

评论列表

微信小程序
QQ小程序

关于作者

点赞数:0
关注数:0
粉丝:0
文章:0
关注标签:0
加入于:--