php-cs-fixer怎么使用

发布时间：2021-11-29 15:09:49 作者：iii
来源：亿速云阅读：787

# php-cs-fixer怎么使用

## 一、工具简介

PHP-CS-Fixer 是一个开源的PHP代码格式化工具，能够自动检测和修复不符合编码规范的PHP代码。它支持PSR-1、PSR-2、PSR-12等主流PHP编码标准，也可以根据项目需求自定义规则。

### 核心特点
- 支持批量处理整个项目或单个文件
- 提供200+内置修复规则
- 可配置自定义规则集
- 与主流IDE和CI/CD工具集成
- 支持缓存机制提升执行效率

## 二、安装方法

### 1. 全局安装（推荐）

通过Composer全局安装：

```bash
composer global require friendsofphp/php-cs-fixer

安装完成后将Composer的全局vendor目录添加到PATH环境变量：

export PATH="$PATH:$HOME/.composer/vendor/bin"

验证安装：

php-cs-fixer --version

2. 项目级安装

composer require --dev friendsofphp/php-cs-fixer

3. PHAR方式

wget https://cs.symfony.com/download/php-cs-fixer-v3.phar -O php-cs-fixer
chmod +x php-cs-fixer
sudo mv php-cs-fixer /usr/local/bin/php-cs-fixer

三、基础使用

1. 格式化单个文件

php-cs-fixer fix /path/to/file.php

2. 格式化整个目录

php-cs-fixer fix /path/to/project

3. 常用参数说明

参数	说明
`--dry-run`	只显示需要修复的文件而不实际修改
`--diff`	显示修复前后的差异
`--rules=@PSR12`	指定使用的规则集
`--using-cache=no`	禁用缓存
`--verbose`	显示详细输出
`--allow-risky=yes`	允许执行有风险的规则

四、规则配置

1. 配置文件格式

在项目根目录创建 .php-cs-fixer.php 或 .php-cs-fixer.dist.php：

<?php

$finder = PhpCsFixer\Finder::create()
    ->in(__DIR__)
    ->exclude('vendor');

return PhpCsFixer\Config::create()
    ->setRules([
        '@PSR12' => true,
        'strict_param' => true,
        'array_syntax' => ['syntax' => 'short'],
    ])
    ->setFinder($finder);

2. 常用规则示例

'rules' => [
    // 基础规则集
    '@PSR12' => true,
    
    // 数组使用短语法
    'array_syntax' => ['syntax' => 'short'],
    
    // 类属性必须声明可见性
    'visibility_required' => ['elements' => ['property', 'method']],
    
    // 方法参数类型提示
    'declare_strict_types' => true,
    
    // 删除多余空行
    'no_extra_blank_lines' => true,
    
    // 方法链调用换行
    'method_chaining_indentation' => true,
]

3. 继承规则集

return PhpCsFixer\Config::create()
    ->setRules([
        '@Symfony' => true,
        '@PHP80Migration' => true,
        // 自定义覆盖规则
        'concat_space' => ['spacing' => 'one'],
    ]);

五、进阶用法

1. 排除特定文件/目录

$finder->notPath('src/Debug/')
      ->notName('*.test.php');

2. 多规则集配置

return PhpCsFixer\Config::create()
    ->setRules([
        '@PSR12' => true,
        '@PHP80Migration:risky' => true,
    ]);

3. 自定义规则开发

继承抽象规则类：

use PhpCsFixer\AbstractFixer;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\Tokenizer\Tokens;

class MyCustomFixer extends AbstractFixer {
    public function getDefinition() {
        return new FixerDefinition(
            'Description of your fixer.',
            []
        );
    }
    
    public function isCandidate(Tokens $tokens) {
        return $tokens->isTokenKindFound(T_STRING);
    }
    
    protected function applyFix(\SplFileInfo $file, Tokens $tokens) {
        // 实现修复逻辑
    }
}

六、集成开发环境

1. VS Code 配置

安装PHP-CS-Fixer扩展后配置settings.json：

{
    "php-cs-fixer.executablePath": "${extensionPath}/php-cs-fixer",
    "php-cs-fixer.onsave": true,
    "php-cs-fixer.rules": "@PSR12",
    "php-cs-fixer.config": ".php-cs-fixer.dist.php"
}

2. PhpStorm 配置

打开 Settings > Tools > External Tools
添加新工具：
- Program: php-cs-fixer
- Arguments: fix $FileDir$/$FileName$ --rules=@PSR12
- Working directory: $ProjectFileDir$

七、持续集成

1. GitHub Actions 示例

name: PHP-CS-Fixer

on: [push, pull_request]

jobs:
  php-cs-fixer:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Install PHP-CS-Fixer
        run: composer require --dev friendsofphp/php-cs-fixer
      - name: Run PHP-CS-Fixer
        run: vendor/bin/php-cs-fixer fix --dry-run --diff --verbose

2. Git 预提交钩子

在 .git/hooks/pre-commit 中添加：

#!/bin/sh
files=$(git diff --cached --name-only --diff-filter=ACM | grep ".php$")
if [ "$files" != "" ]; then
    vendor/bin/php-cs-fixer fix $files
    git add $files
fi

八、常见问题解决

1. 缓存问题

清除缓存：

php-cs-fixer fix --using-cache=no

2. 规则冲突处理

使用 --stop-on-violation 参数定位第一个冲突点：

php-cs-fixer fix --stop-on-violation

3. 性能优化

使用缓存（默认开启）

限制检查范围：


php-cs-fixer fix src/ tests/ --path-mode=intersection

九、最佳实践建议

团队协作：将配置文件纳入版本控制
渐进式采用：初期使用--dry-run，逐步修复问题
CI集成：在流水线中添加检查步骤
版本控制：锁定特定版本避免团队间差异
文档记录：维护团队编码规范文档

十、替代方案比较

工具	特点	适用场景
PHP-CS-Fixer	修复能力强，规则丰富	需要自动修复的场景
PHP_CodeSniffer	检查为主，修复有限	需要详细报告的场景
PHPCBF	PHPCS的修复工具	与PHPCS配合使用
Prettier-PHP	专注于代码样式	前端团队统一工具链

结语

PHP-CS-Fixer 是现代化PHP项目维护代码质量的利器。通过合理配置和团队规范，可以显著提升代码可读性和维护效率。建议从基础规则集开始，逐步根据项目特点定制规则，最终形成团队的编码标准。

注意：本文基于php-cs-fixer v3.0版本编写，不同版本可能存在差异。建议定期升级工具版本以获得最新功能和规则支持。 “`

这篇文章共计约3050字，涵盖了php-cs-fixer的安装、配置、使用技巧到高级集成等完整内容，采用Markdown格式编写，包含代码块、表格等结构化元素，便于阅读和理解。