[PHP知识库]PHP使用FriendsOfPHP/PHP-CS-Fixer进行PHP代码修正

简介#

良好的代码规范可以提高代码可读性，团队沟通维护成本，也是每个程序员必须养成的良好习惯。对于PHP来说，因为其作为解释性语言，语法严谨度低，往往编写者书写够不够规范，因此推荐大家遵守的是 php-fig（PHP Framework Interop Group） 组织定义的 PSR-1 、 PSR-2 两个。不了解的同学可以先通过链接点击过去阅读下。

这个工具的作用就是按照 PSR-1 和 PSR-2 的规范格式化你的代码。

安装#

PHP需求：PHP最小版本5.3.6。推荐PHP5.6以上版本。

使用composer安装#

FriendsOfPHP是一款基于composer下安装的PHP编码标准修正器。PHP编码标准修复程序（PHP CS修复程序）工具修复代码以遵循标准；无论是想遵循PSR-1、PSR-2等中定义的标准PHP编码标准，还是其他社区驱动的标准，如Symfony标准，都可以通过里面内置的配置文件进行代码规范的配置。

它可以使老旧的代码现代化（如将函数转换为PHP5.6上的运算符）并（微型）优化它

大家都知道手工修复这些问题非常繁琐，尤其是在大型项目中。此工具不仅可以检测到它们，还可以自动修复它们。

安装方法#

安装PHP CS Fixer的推荐方法是在项目中的专用目录中使用Composer，例如在以下目录中：

项目根目录/tools/php-cs-fixer

在项目目录中使用mkdir命令创建一个目录，或在windows系统中手动新建文件夹（文件夹名可自定义，但最好与下面一致）

mkdir --parents tools/php-cs-fixer

在项目目录中使用composer命令将PHP CS Fixer安装到项目中

composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer

使用方法#

如果已经按照上面的说明安装了PHP CS Fixer，那么可以运行以下命令来修复目录中的PHP文件夹，例如在lumen框架中，业务代码主要在/app文件夹中，那么可以运行以下命令一键修复/app文件夹下的所有PHP代码的规范与错误。

$ tools/php-cs-fixer/vendor/bin/php-cs-fixer fix app(想要修复代码规范的文件目录路径)

在已经安装了PHP CS Fixer的情况下，建议在每次代码书写完之后，代码提交之前，运行一次命令使用PHP CS Fixer修正自己的代码规范后再提交代码。

自定义代码规范#

在安装了PHP CS Fixer之后，项目目录下会自动生成一个.editorconfig的文件，通过配置该文件内容即可实现自定义的代码规范，而不只是拘泥于 PSR-1 和 PSR-2 的规范。

root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 4
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.{yml,yaml}]
indent_size =