PHP と PHPUnit を使用してコードの規則と品質をチェックする方法

現代のソフトウェア開発では、コードの品質と仕様は非常に重要な要素です。コードがすっきりして保守しやすくなるだけでなく、コードの読みやすさとスケーラビリティも向上します。しかし、コードの品質と仕様をどのようにチェックするのでしょうか?この記事では、この目標を達成するために PHP と PHPUnit を使用する方法を説明します。

ステップ 1: コード仕様を確認する

PHP 開発では、PSR (PHP 標準仕様) と呼ばれる非常に一般的なコード仕様があります。 PSR 仕様の目的は、PHP コードをより読みやすく、保守しやすくすることです。その中で最もよく知られているのは PSR-1 と PSR-2 です。

PHP や PHPUnit を使ってコードの仕様を確認する場合、「PHP_CodeSniffer」というツールをインストールする必要があります。コードがPSR仕様に準拠しているかどうかをチェックできるPHPコード仕様チェッカーです。

PHP_CodeSniffer の使用は非常に簡単です。これをグローバル コマンド (Composer を通じてインストール) としてインストールし、ターミナルで次のコマンドを使用してコード仕様を確認できます:

phpcs --standard=PSR2 path/to/code

ここで、「path/to/code」はコード ディレクトリに置き換える必要があります。確認したいファイルパスまたはファイルパスを指定します。このコマンドを実行すると、仕様に違反した行数とエラーの内容が出力されます。 PSR 仕様に準拠するように、出力に基づいてコードを変更できます。

PSR 仕様に加えて、PHP_CodeSniffer は、Zend、PEAR、Squiz などの他の仕様もサポートしています。 --standard オプションを使用して、コマンドラインで使用する仕様を指定できます。

ステップ 2: コードの品質を確認する

コード仕様に関しては、検査に PHP_CodeSniffer を使用しました。ただし、このツールではコードの品質をチェックできません。コードの品質をチェックするには、「PHPMD」という別のツールを使用する必要があります。

PHPMD は、コードがいくつかの一般的なコード品質の問題を満たしているかどうかをチェックできる静的コード アナライザーです。不適切な設計、過度に複雑なコード、未使用のコードなどのチェックをサポートします。

PHP_CodeSniffer と同様に、Composer を使用して PHPMD をグローバルにインストールし、コマンド ライン ツールを使用してコードの品質をチェックすることもできます。次のコマンドは、コード内のコード品質の問題をチェックできます。

phpmd path/to/code text cleancode,codesize,controversial,design,naming,unusedcode

このコマンドは、コード ディレクトリ "path/to/code" 内のすべての PHP ファイルをチェックします。パラメータ「text」は、出力される結果の形式を指定します。 PHPMD は、HTML、XML、JSON などの複数の結果形式をサポートしています。最後のパラメータ「cleancode,codesize,controversial,design,naming,unusedcode」は、使用するルール セットを指定します。これらは、多くの一般的なコード品質の問題をカバーしています。

このコマンドを実行すると、品質ルールに違反しているファイル、行数、違反しているルールの種類が出力されます。結果に基づいてコードを修正し、より高いコード品質を達成できます。

ステップ 3: 統合チェック

このプロセスを自動化したい場合は、PHP_CodeSniffer と PHPMD をビルド プロセスに統合できます。 PHP_CodeSniffer と PHPMD はどちらもコマンド ライン ツールを使用して検査されるため、ビルド スクリプトの一部として実行できます。

たとえば、PHPUnit をテスト フレームワークとして使用する場合、phpunit.xml 構成ファイルに次のコードを追加できます:

<target name="phpcs">
   <exec executable="phpcs">
      <arg value="--standard=PSR2"/>
      <arg value="./path/to/code"/>
   </exec>
</target>

<target name="phpmd">
   <exec executable="phpmd">
      <arg value="./path/to/code"/>
      <arg value="text"/>
      <arg value="cleancode,codesize,controversial,design,naming,unusedcode"/>
   </exec>
</target>

<target name="build" depends="phpcs,phpmd">
   <echo message="Build success!"/>
</target>

この例では、2 つのビルド ターゲットを定義します: phpcsそしてphpmd。これらのターゲットは、それぞれ PHP_CodeSniffer と PHPMD のコード検査を実行します。ビルドの最後に、ビルドが成功したことを示すメッセージが出力されます。

この例は単純ですが、より複雑なビルド プロセスに拡張できます。たとえば、コードの品質と仕様のチェックが失敗した場合に、ビルド プロセスが続行されないようにすることができます。

結論

この記事では、PHP と PHPUnit を使用してコードの仕様と品質を確認する方法を紹介しました。これらのツールを使用すると、コードの品質と保守性が大幅に向上します。これらは非常に使いやすく、ビルドプロセスに統合してチェックを自動化できます。小規模なアプリケーションを作成する場合でも、大規模なプロジェクトを作成する場合でも、コードの品質と仕様は優先事項の 1 つである必要があります。

以上がPHP と PHPUnit を使用してコードの規則と品質をチェックする方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。