1. 程式人生 > 程式設計 >淺談如何提高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 為我們提供瞭解NqpLlf決此問題的絕佳解決方案。 PHing 與 Apache Ant 相似,可以使用 XML 配置輕鬆自動執行任務。 我們可以通過執行http://www.cppcns.com以下命令來安裝它:

$ 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:

<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 內容為:

<?php
return [
'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 int程式設計客棧src/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程式碼的質量的資料請關注我們其它相關文章!