教你如何提升 PHP 代碼的質量

說實話，在代碼質量方面，PHP 的壓力很是大。經過閱讀本系列文章，您將瞭解如何提升 PHP 代碼的質量。

咱們能夠將此歸咎於許多緣由，但這確定不只僅是由於 PHP 生態系統缺少適當的測試工具。在本文中，我想向您展現一個簡單的設置，用於項目的基本質量測試。 我不會詳述任何特定的工具，而是專一於設定測試環境。

本文中有一個演示代碼能夠在 GitHub 上找到： https://github.com/mkosiedowski/php-testing-demo 若是你對這篇文章中的例子有任何問題，能夠參考。

1 必備條件

我假設您熟悉 PHP 7.1 語法，您可使用 Composer 和 PSR-4 來進行自動加載和 PSR-1&PSR-2 的編碼標準。在個人示例中，vendor 的二進制文件被安裝到 ./bin 目錄。

2 構建工具

咱們將使用一些不一樣的測試工具，因此最好有一些能用一個腳原本運行它們的東西。 PHING 爲咱們提供瞭解決此問題的絕佳解決方案。 PHing 與 Apache Ant 類似，可使用 XML 配置輕鬆自動執行任務。 咱們能夠經過運行如下命令來安裝它：

複製代碼

$ php composer.phar require --dev phing/phing

 

而後，在項目的根目錄中建立一些基本的 build.xml 文件。

<?xml version="1.0" encoding="UTF-8"?><project name="MyProject" default="run"></project>

 

在接下來的步驟中，咱們將添加一些由 PHing 運行的目標。

3 靜態代碼分析

我爲了提升代碼質量，您能夠作的第一件事就是設置靜態代碼分析器。他們會在沒有真正運行的狀況下閱讀你的錯誤代碼。這就像在幾秒鐘內由一個機器人完成了一個代碼審查同樣。很酷，不是嗎?

4 代碼風格

當使用正確的樣式編寫時，您的代碼更容易維護。每一個人都知道（若是你不這樣作，你至少應該開始閱讀 Robert C. Martin 的「Clean Code」），但仍然有不少團隊在遵照他們達成的標準方面存在問題。咱們能夠用 phpcs - PHP 代碼嗅探來自動化這個任務，有沒有很神奇。

咱們能夠經過運行如下命令來安裝：

$ php composer.phar require --dev squizlabs/php_codesniffer

 

而後添加一個在 build.xml 中運行它的目標。你的 build.xml 如今應該是這樣的：

<?xml version="1.0" encoding="UTF-8"?><project name="MyProject" default="run">    <target name="phpcs" description="Check code style with PHP_CodeSniffer">        <exec executable="bin/phpcs" passthru="true" checkreturn="true">            <arg line="--standard=PSR1,PSR2 -extensions=php src"/>        </exec>    </target>    <target name="run" depends="phpcs"/></project>

 

如今您能夠運行 ./bin/phing 了，phpc 將自動檢查您是否在 PSR-1 和 PSR-2 編碼標準上有任何錯誤。

許多框架，好比 Symfony，定義了它們本身的代碼風格規則，咱們也能夠自動檢查這些規則。好比：若是您使用的是 Symfony 框架，請檢查 https://github.com/leaphub/phpcs-symfony2 標準，以瞭解如何使用 phpcs 檢查 Symfony 的標準。

錯誤格式的文件的示例輸出：

MyProject > phpcs:  FILE: /home/maciej/workspace/php-testing/src/Domain/Price.php-------------------------------------------------------------------------FOUND 1 ERROR AFFECTING 1 LINE-------------------------------------------------------------------------28 | ERROR | Method name "Price::get_value" is not in camel caps format-------------------------------------------------------------------------Time: 67ms; Memory: 6Mb

 

在代碼評審期間，再也不浪費時間檢查編碼標準，從如今開始，它將自動實現！

5 複製 / 粘貼檢測器

重複的代碼是很差的，每一個人都知道。有時咱們錯誤地建立了這樣的代碼，咱們歷來沒有注意到它。有時咱們這樣作是由於咱們懶惰。最好是配備一個工具，它能夠在構建時提示這個問題。PHPCPD - PHP 複製 / 粘貼檢測器。

經過運行如下命令來安裝它：

$ php composer.phar require --dev sebastian/phpcpd

 

而後將目標添加到 build.xml：

1 <target name="phpcpd" description="Generate pmd-cpd.xml using PHPCPD">    <exec executable="bin/phpcpd" passthru="true">        <arg line="src"/>    </exec></target>...<target name="run" depends="phpcs,phpcpd"/>

 

在 vendor 目錄上運行的重複代碼檢查的示例輸出：

phpcpd 4.0.0 by Sebastian Bergmann. Found 74 clones with 2929 duplicated lines in 97 files: - /home/maciej/workspace/php-testing/vendor/phpspec/phpspec/src/PhpSpec/Matcher/TriggerMatcher.php:81-102     /home/maciej/workspace/php-testing/vendor/phpspec/phpspec/src/PhpSpec/Matcher/TriggerMatcher.php:114-135 - /home/maciej/workspace/php-testing/vendor/squizlabs/php_codesniffer/src/Reports/Full.php:81-114   /home/maciej/workspace/php-testing/vendor/squizlabs/php_codesniffer/src/Reports/Code.php:162-195 (...)

 

6 想要真正深刻的代碼分析？

若是你從頭開始你的項目，你應該看看 Phan - 它是一個很是強大的代碼分析器，它會讓你的代碼變得漂亮。在 https://github.com/phan/phan 上查看。安裝很是簡單 - 只需安裝 php-ast 擴展（在 Ubuntu 中，您能夠嘗試運行 sudo apt-get install php-ast）並運行：

$ php composer.phar require --dev phan/phan

 

而後建立一個配置文件 .phan/config.php 內容爲：

<?phpreturn [    'target_php_version' => '7.1',    'directory_list' => [        'src',        'vendor/symfony/console',    ],    "exclude_analysis_directory_list" => [        'vendor/'    ],]; 

 

在 build.xml 文件中也建立 phan 目標：

<target name="phan" description="Check code with phan">   <exec executable="bin/phan" passthru="true" checkreturn="true"/></target>...<target name="run" depends="phpcs,phpcpd,phan"/>

 

如今，您能夠運行您的代碼分析，若是您犯了錯誤（例如……爲類屬性聲明錯誤的 phpdoc 類型），您應該看到這樣的消息：

MyProject > phan: src/Domain/PriceComparator.php:17 PhanTypeMismatchProperty Assigning \Domain\PriceConverter to property but \Domain\PriceComparator::priceConverter is intsrc/Domain/PriceComparator.php:35 PhanNonClassMethodCall Call to method convert on non-class type int

 

Phan 很神奇 - 它讀取你的整個代碼並對它執行屢次檢查，包括將 phpdoc 聲明與實際使用變量、方法、類等進行比較，你能夠查看 https://github.com/phan/phan#features 的全部特徵列表。

如今，您的項目中有三個徹底自動化的工具，能夠保護您的代碼的質量。您所須要作的就是手動運行 ./bin/phing，或者將其附加到您的 git-hook 或持續集成中。您的代碼將被檢查編碼標準、重複和正式錯誤。這些檢查應該會致使更可靠的運行時，而且花費在代碼審查上的時間更少。

 

推薦閱讀：

如何提升 PHP 代碼的質量？第二部分 單元測試

如何提升 PHP 代碼的質量？第三：端到端 / 集成測試