TP5.1 老项目适配 PSR-12 编码规范自动化改造【整洁】

雨瑶同学_4690

雨瑶同学_4690

2026-07-16

163人浏览

原创

需用 php-cs-fixer 作为强制守门人实现 psr-12 规范:先确保 composer.json 正确配置 psr-4 自动加载并执行 dump-autoload,再安装 php-cs-fixer、配置 .php-cs-fixer.php 指定扫描目录,通过 --dry-run 验证后全量修复,最后接入 pre-commit 钩子与 ci 校验。

tp5.1 老项目适配 psr-12 编码规范自动化改造【整洁】

将 ThinkPHP 5.1 老项目从自由编码风格升级为 PSR-12 自动化规范,需绕过框架自身不校验的限制,用外部工具链接管格式控制权——不能只改编辑器设置,也不能只跑一次 fix 命令,必须让 php-cs-fixer 成为代码落地前的强制守门人。

确认项目基础结构是否满足 PSR-4 加载前提

TP5.1 默认未注册 app/ 目录为 PSR-4 自动加载路径,若类文件命名空间与物理路径不严格匹配,php-cs-fixer 即使修复了格式,后续也会因 Class not found 报错而无法验证效果。先检查 composer.json 是否已声明映射:

打开 composer.json,确认 【"autoload": {"psr-4": {"app\": "app/"}}】 存在且末尾有反斜杠;若缺失,手动添加并保存。

执行 composer dump-autoload -o 生成优化版 autoload_static.php——这步漏掉会导致后续所有格式修复后的代码在运行时找不到类。

安装并配置 PHP-CS-Fixer

TP5.1 不内置代码格式化工具,必须手动引入 PHP-CS-Fixer:

运行 composer require --dev friendsofphp/php-cs-fixer 安装到开发依赖。

在项目根目录创建 .php-cs-fixer.php 配置文件,内容为:

return PhpCsFixerConfig::create()<br>    ->setRules([<br>        '@PSR12' => true,<br>        'array_syntax' => ['syntax' => 'short'],<br>        'no_unused_imports' => true,<br>        'visibility_required' => true,<br>    ])<br>    ->setFinder(<br>        PhpCsFixerFinder::create()<br>            ->in(['app', 'common', 'extend'])<br>            ->exclude('vendor')<br>            ->name('*.php')<br>    );

注意:TP5.1 的 app 目录是核心业务区,common 存放公共函数,extend 是扩展类存放点——这三个目录必须显式写入 in(),否则 fix 命令不会扫描它们。

执行首次全量修复并验证效果

第一步:运行 ./vendor/bin/php-cs-fixer fix --dry-run --diff 查看哪些文件会变、哪里要改,不实际写入。

第二步:确认无误后执行 ./vendor/bin/php-cs-fixer fix ——这会直接覆盖原文件,【操作不可逆,请提前 git commit 或备份】

第三步:挑出几个典型文件(如 app/controller/Index.php 和 app/model/User.php),用 PhpStorm 打开,按 Ctrl+Alt+L 触发编辑器格式化,对比是否与 php-cs-fixer 输出一致;若不一致,说明 PhpStorm 的 Code Style 没对齐 PSR-12,需进入 Settings → Editor → Code Style → PHP → Set from → PSR-12 → Apply。

ThinkPHP5.1企业站点快速开发-源码课件
ThinkPHP5.1企业站点快速开发-源码课件

ThinkPHP5.1企业站点快速开发

下载

接入 Git pre-commit 钩子防止规范回退

方法一:用 husky-like 方式(推荐)

在项目根目录新建 .husky/pre-commit 文件,写入:

#!/bin/sh<br>./vendor/bin/php-cs-fixer fix --verbose

赋予可执行权限:chmod +x .husky/pre-commit

方法二:纯 shell 钩子(兼容性更强)

进入 .git/hooks/ 目录,新建 pre-commit 文件,内容为:

#!/bin/sh<br>echo "Running PSR-12 fix before commit..."<br>if ! ./vendor/bin/php-cs-fixer fix --dry-run --quiet; then<br>  echo "PSR-12 violations found. Fixing..."<br>  ./vendor/bin/php-cs-fixer fix<br>  git add .<br>fi

同样执行 chmod +x pre-commit

这一步做完,每次 git commit 前都会自动跑一遍修复,不合规范的代码进不了仓库。

CI 流水线中加入强制校验

在 CI 配置文件(如 .github/workflows/ci.yml 或 .gitlab-ci.yml)中,在 test 步骤前插入:

- name: Check PSR-12 compliance<br>  run: ./vendor/bin/php-cs-fixer fix --dry-run --diff

CI 环境中不加 --dry-run 会直接修改文件但不提交,导致构建失败;加了它则只检查,违反即报错中断流程。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

thinkphp

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
PHP 命令行脚本与自动化任务开发
PHP 命令行脚本与自动化任务开发

本专题系统讲解 PHP 在命令行环境(CLI)下的开发与应用,内容涵盖 PHP CLI 基础、参数解析、文件与目录操作、日志输出、异常处理,以及与 Linux 定时任务(Cron)的结合使用。通过实战示例,帮助开发者掌握使用 PHP 构建 自动化脚本、批处理工具与后台任务程序 的能力。

2025.12.13

426

14

Figma AI自动化智能数据填充与交互生成实战
Figma AI自动化智能数据填充与交互生成实战

告别机械重复,详细演示如何用 AI 填充业务真实数据,并自动为页面添加交互连线,将静态设计稿快速转变为动态原型。

2026.05.13

245

17

NumPy性能优化版本更新与常见报错排查
NumPy性能优化版本更新与常见报错排查

本专题整理 NumPy 性能优化、版本更新与常见报错排查相关教程,覆盖向量化计算、广播性能、内存布局、NumPy 2.0 升级、版本兼容冲突、安装导入报错、dtype 溢出、矩阵运算异常和 broadcasting 报错修复,帮助读者系统掌握 NumPy 性能调优与问题定位方法。

2026.09.22

0

25

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

2026.09.21

20

20

NumPy随机数文件读写与dtype数据类型
NumPy随机数文件读写与dtype数据类型

本专题整理 NumPy 随机数、文件读写与 dtype 数据类型相关教程,覆盖 Generator/random、随机数种子、正态分布采样、npy/npz/CSV/TXT 保存读取、loadtxt/savetxt、memmap、大文件处理、astype 类型转换、结构化 dtype、整数溢出和精度丢失等场景。

2026.09.21

20

24

NumPy矩阵运算与线性代数计算
NumPy矩阵运算与线性代数计算

本专题整理 NumPy 矩阵运算与线性代数计算相关教程,覆盖矩阵乘法、dot 与 @ 运算符、逆矩阵、行列式、特征值与特征向量、SVD、线性方程组、欧氏距离、矩阵分解和大规模矩阵性能优化等内容,帮助读者掌握 np.linalg 与矩阵计算实战。

2026.09.21

0

20

NumPy广播机制数学运算与统计分析
NumPy广播机制数学运算与统计分析

本专题整理 NumPy 广播机制、数组数学运算与统计分析相关教程,覆盖广播规则、维度对齐、矩阵与数组加减除法、向量化计算、均值方差、分位数、中位数、直方图和 unique 频次统计等场景,帮助读者掌握 ndarray 高效计算与统计处理方法。

2026.09.21

0

17

NumPy数组创建索引切片与数据选择
NumPy数组创建索引切片与数据选择

本专题整理 NumPy 数组创建、索引、切片与数据选择相关教程,覆盖 np.array、zeros/ones、多维数组形状、基础切片、花式索引、布尔索引、条件筛选、视图与副本等常用场景,帮助读者系统掌握 ndarray 数据构造与高效提取方法。

2026.09.21

0

12

Aionclaw智能助手介绍
Aionclaw智能助手介绍

本专题汇总了AionClaw(AI龙虾助手)的功能介绍与在线使用入口。AionClaw是杭州趣猿人工智能有限公司推出的桌面级AI智能体,能直接在电脑上读写文件、运行脚本、操作浏览器,自动交付Word、PPT、Excel等成品。

2026.09.20

40

13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程