审查 Magento 2 代码质量…

在提交代码、发起 PR 或部署前，对 Magento 2 代码进行质量、安全、性能与规范合规审查。

适用场景

解决思路

1. 强制 PSR-12 编码规范：类与方法的左花括号必须独占一行，使用空格而非 Tab，缩进 4 空格，行尾 LF，编码 UTF-8，并检查项目 .editorconfig。
2. 验证是否符合 Magento 编码标准 vendor/magento/magento-coding-standard/Magento2。
3. 要求所有类文件包含 declare(strict_types=1);（类中位于版权块之后、namespace 之前；模板中与 <?php 同行）。
4. 要求所有参数和返回类型都有类型提示。
5. 在合适处使用构造器属性提升（Constructor Property Promotion）配合 readonly 修饰符。
6. 始终使用 === 和 !== 严格比较，禁止 == 和 !=。
7. 检查代码质量清单：无未使用 import、无无理由的静态方法、构造函数含完整 @param 的 PHPDoc、含版权头、注释精简。
8. 注释规范：只保留关键注释，PHPDoc 仅含 @param、@return、@throws，避免冗长方法描述，标记直白代码中的解释性行内注释，所有文件必须有版权头。
9. 按预期格式检查类与模板结构（类：版权块 → declare → namespace → use → 构造器属性提升；模板：<?php declare(strict_types=1); 后接 use 与 @var 注释）。
10. 运行自动化工具：静态分析 vendor/bin/phpstan 或 vendor/bin/psalm，代码风格 vendor/bin/phpcs --standard=Magento2，安全扫描，性能分析使用 Blackfire、XHProf。
11. 检查规范合规：PSR-1、PSR-2、PSR-4、PSR-12，Magento 模式（Factory、Observer、Plugin、Repository、Service Contract），SOLID 原则，依赖注入（禁止 service locator），Service Contract 接口使用。
12. 安全审查：输入校验与净化、SQL 注入（推荐参数化查询）、XSS 防护（$escaper->escapeHtml() 等输出转义）、CSRF 防护（form key）、ACL 访问控制、敏感数据加密。
13. 性能审查：数据库查询（N+1、缺失索引、低效 join）、缓存策略（Full Page Cache、Block Cache）、内存使用（内存泄漏、低效对象实例化）、集合优化（filter、分页、select 语句）、前端性能（JS/CSS 打包、图片优化）。
14. 架构审查：模块目录结构、di.xml 配置、Service Contract API 接口实现、Plugin 的 before/after/around 实现、事件观察者分发模式、db_schema.xml 与升级脚本。
15. 按严重级别分类反馈：Critical（安全漏洞、数据丢失风险、破坏性变更）、High（性能、架构、规范违规）、Medium（代码质量、可维护性）、Low（风格偏好、次要优化）。
16. 反馈时提供具体代码示例、推荐修复方案、Magento 文档链接，并在适用时量化性能影响。
17. 始终检查项目中的编码规范文件（phpcs.xml、.php-cs-fixer.php、.editorconfig）并严格执行。

适用边界 · 注意事项

• 非 Magento 2 / Adobe Commerce 项目不适用。
• 未安装 phpstan、psalm、phpcs 等工具时无法执行自动化检查部分。