PHP 規(guī)范說明與工具

snowLu 發(fā)布于2019-06-28 13:49 / 615人閱讀

摘要：今天這篇分享將簡(jiǎn)單地梳理一下規(guī)范，并介紹一個(gè)代碼檢查工具，結(jié)合以及進(jìn)行實(shí)踐。目前流行的一些規(guī)范是的簡(jiǎn)寫，由組織制定的規(guī)范，是開發(fā)的實(shí)踐標(biāo)準(zhǔn)。目前已表決通過了套標(biāo)準(zhǔn)，已經(jīng)得到大部分框架的支持和認(rèn)可。

> 作為一個(gè)新手，寫出規(guī)范的代碼也是一門必修課，除了閱讀相應(yīng)的代碼規(guī)范文檔之外，充分利用相關(guān)的工具能使得進(jìn)階之路事半功倍。今天這篇分享將簡(jiǎn)單地梳理一下 PHP 規(guī)范，并介紹一個(gè)代碼檢查工具 Code Sniffer，結(jié)合 PHPStorm 以及 GIT 進(jìn)行實(shí)踐。

PHP 規(guī)范

為什么需要統(tǒng)一代碼規(guī)范？

PHP 社區(qū)百花齊放，擁有大量的函數(shù)庫(kù)、框架和組件。PHP 開發(fā)者通常會(huì)在自己的項(xiàng)目中使用若干個(gè)外部庫(kù)，因此 PHP 代碼遵循（盡可能接近）同一個(gè)代碼風(fēng)格就非常重要，這讓開發(fā)者可以輕松地將多個(gè)代碼庫(kù)整合到自己的項(xiàng)目中。

目前流行的一些規(guī)范：

PSR

PSR 是 PHP Standard Recommendations 的簡(jiǎn)寫，由 PHP FIG 組織制定的 PHP 規(guī)范，是 PHP 開發(fā)的實(shí)踐標(biāo)準(zhǔn)。

PHP FIG，F(xiàn)IG 是 Framework Interoperability Group（框架可互用性小組）的縮寫，由幾位開源框架的開發(fā)者成立于 2009 年，從那開始也選取了很多其他成員進(jìn)來（包括但不限于 Laravel, Joomla, Drupal, Composer, Phalcon, Slim, Symfony, Zend Framework 等），雖然不是「官方」組織，但也代表了大部分的 PHP 社區(qū)。

項(xiàng)目的目的在于：通過框架作者或者框架的代表之間討論，以最低程度的限制，制定一個(gè)協(xié)作標(biāo)準(zhǔn)，各個(gè)框架遵循統(tǒng)一的編碼規(guī)范，避免各家自行發(fā)展的風(fēng)格阻礙了 PHP 的發(fā)展，解決這個(gè)程序設(shè)計(jì)師由來已久的困擾。

目前已表決通過了 6 套標(biāo)準(zhǔn)，已經(jīng)得到大部分 PHP 框架的支持和認(rèn)可。

詳細(xì)介紹請(qǐng)參考官方說明：

中文文檔

官方網(wǎng)站

PEAR

The PEAR Coding Standards apply to code that is part of the official PEAR distribution. Coding standards often abbreviated as CS among developers and they aim to keep code consistent to be easily readable and maintainable by most of PEAR folks.

參考官方說明

Zend

Zend Framework 使用的代碼規(guī)范。

參考官方說明

Code Sniffer

官方網(wǎng)站：https://github.com/squizlabs/PHP_CodeSniffer

PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.

簡(jiǎn)單來說，就是兩個(gè)小工具，

phpcs (PHP Code Standard)，用來檢查代碼規(guī)范

phpcbf (PHP Code Beautifier and Fixer)，用來自動(dòng)修復(fù)代碼

安裝 Code Sniffer

參考官方文檔

使用 Code Sniffer

執(zhí)行 phpcs 檢查代碼規(guī)范

$ phpcs /path/to/code/myfile.php

FILE: /path/to/code/myfile.php
--------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 4 LINES
--------------------------------------------------------------------------------
 2 | ERROR | [ ] Missing file doc comment
 3 | ERROR | [x] TRUE, FALSE and NULL must be lowercase; expected "false" but
   |       |     found "FALSE"
 5 | ERROR | [x] Line indented incorrectly; expected at least 4 spaces, found 1
 8 | ERROR | [ ] Missing function doc comment
 8 | ERROR | [ ] Opening brace should be on a new line
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

Code-Sniffer 默認(rèn)使用 PEAR 代碼規(guī)范。可以使用 --standard=xxx 指定。

$ phpcs --standard=PSR2 /path/to/code/myfile.php

或者修改默認(rèn)配置

$ phpcs --config-set default_standard Squiz

執(zhí)行 phpcbs 修復(fù)代碼

$ phpcbf /path/to/code
Processing init.php [PHP => 7875 tokens in 960 lines]... DONE in 274ms (12 fixable violations)
    => Fixing file: 0/12 violations remaining [made 3 passes]... DONE in 412ms
Processing config.php [PHP => 8009 tokens in 957 lines]... DONE in 421ms (155 fixable violations)
    => Fixing file: 0/155 violations remaining [made 7 passes]... DONE in 937ms
Patched 2 files
Time: 2.55 secs, Memory: 25.00Mb

更多功能，參考官方文檔

與 PHP Storm 集成

將 Code Sniffer 與 PHP Storm 集成，可以使 IDE 實(shí)時(shí)顯示代碼的規(guī)范情況，提醒開發(fā)人員修改代碼，長(zhǎng)期使用，可以讓開發(fā)人員養(yǎng)成非常規(guī)范的代碼習(xí)慣。

如何配置？

為 PHPStorm 配置 Code Sniffer 路徑：

![code-sniffer](http://imgur.com/X4rIc0e.png)
![code-sniffer](http://imgur.com/TdqQVfz.png)

設(shè)置 Inspections

選擇合適的 Coding Standard
![](http://imgur.com/hLmHbZo.png)

利用 GIT Hook 強(qiáng)制代碼檢查

使用 GIT 的 Pre-Commit Hook，可以在代碼被提交之前，強(qiáng)制調(diào)用 Code Sniffer 進(jìn)行代碼檢查，如果不符合規(guī)范，將阻止用戶提交代碼。

在項(xiàng)目的 .git/hooks 建立 pre-commit 文件

寫入代碼：

[Pre-Commit Gist](https://gist.githubusercontent.com/yangzhyo/6dad52e862c5efa368c992efc52e1fb9/raw/dec18f55ddfdf6eeb6d659a19398ec2d106fface/pre-commit.php)

試試看:)