如何使用SonarQube检查Magento 2模块及安装与报告生成指导

1. SonarQube 安装步骤 #

环境准备 #

• 确保系统已安装 Java 11（SonarQube 9.x+ 版本要求，低版本可对应调整Java版本）
• 推荐使用Linux服务器部署，Windows也可兼容

安装与配置 #

1. 下载对应系统的SonarQube安装包，解压到目标目录，示例命令：

   tar -xzf sonarqube-9.9.0.65466.tar.gz
   mv sonarqube-9.9.0.65466 /opt/sonarqube
   

2. 创建专用用户运行SonarQube（避免root权限风险）：

   useradd sonar
   chown -R sonar:sonar /opt/sonarqube
   

3. 启动SonarQube服务：

   su sonar
   /opt/sonarqube/bin/linux-x86-64/sonar.sh start
   

4. 访问控制台：打开浏览器输入http://<服务器IP>:9000，默认账号密码为admin/admin，首次登录需修改密码。

2. 使用SonarQube验证Magento 2模块并生成报告 #

前置准备 #

• 安装 SonarQube Scanner（用于本地或CI环境执行扫描）
• 确保Magento 2模块源码结构规范，已安装Magento CodeSniffer（无需重复安装，仅需关联SonarQube规则）

配置SonarQube项目规则 #

1. 在SonarQube控制台进入「Marketplace」，确认PHP插件已安装（默认包含，未安装则手动添加）
2. 启用Magento相关规则：在SonarQube规则库中筛选「Magento」标签的规则，根据项目需求启用对应编码规范

项目扫描配置 #

在Magento 2模块的根目录下创建sonar-project.properties文件，示例配置：

# 项目基本信息
sonar.projectKey=magento2-custom-module
sonar.projectName=Magento 2 Custom Module
sonar.projectVersion=1.0

# 源码目录（替换为你的模块实际路径）
sonar.sources=app/code/YourVendor/YourModule
sonar.php.source=8.1 # 对应你的Magento 2版本要求的PHP版本

# 关联Magento CodeSniffer规则
sonar.php.standard=Magento2
sonar.php.reportPaths=phpcs-report.xml # 可选，关联已生成的phpcs报告

# 排除无需扫描的目录
sonar.exclusions=**/vendor/**,**/node_modules/**,**/generated/**

执行扫描并查看报告 #

1. 可选：预先生成Magento CodeSniffer报告（用于SonarQube关联）：

   vendor/bin/phpcs --standard=Magento2 app/code/YourVendor/YourModule --report=xml --report-file=phpcs-report.xml
   

2. 运行SonarQube Scanner执行扫描：

   sonar-scanner
   

3. 查看报告：扫描完成后，回到SonarQube控制台找到对应项目，即可查看代码质量报告，包含代码异味、漏洞、不符合Magento规范的代码片段等。

额外建议 #

• 集成CI/CD：在Magento 2部署流水线中添加SonarQube扫描步骤，确保每次代码提交都经过质量校验
• 自定义规则：根据团队需求调整SonarQube中Magento规则的启用状态，适配项目专属编码规范

内容的提问来源于stack exchange，提问作者Rajiv Ranjan