一見の価値あり！上級 PHP エンジニアに必要なコーディングスキルと考え方-PHPチュートリアル-php.cn

一見の価値あり！上級 PHP エンジニアに必要なコーディングスキルと考え方

藏色散人

リリース： 2023-04-09 14:16:02

転載

3453 人が閲覧しました

優れた開発者は、通常、コードの品質によって決まります。ソフトウェア業界では、優れたコードを書くということは、テスト、更新、拡張、バグ修正にかかる費用を節約することを意味します。この記事では、ロジックコードをクリーンアップし、リファクタリングして、より堅牢でモジュール化するのに役立つテクニックとアイデアの実例をいくつか示します。これらのヒントは、古いコードをリファクタリングするのに役立つだけでなく、今後よりクリーンなコードを作成する方法についての良いアドバイスも提供します。

リファクタリングとは何ですか?なぜリファクタリングが必要なのでしょうか?

リファクタリングとは、簡潔なコードを書くのに役立つ方法と手順を指します。これは、あまり編集せずにコードを読み、拡張し、再利用できる他の開発者にとって重要です。

次のコンテンツでは、ロジックコードをリファクタリングして改善する例をいくつか示します。

単体テストなしで運用コードをリファクタリングしないでください

私の最初のアドバイスは、完全な単体テストを行わずにロジックコードをリファクタリングしないことです。私の推論は次のとおりです。機能が壊れてしまい、何が壊れているのかを特定するのが難しいため、修正するのが困難になります。したがって、リファクタリングする場合は、テストから始めてください。リファクタリングを計画している部分がテストでカバーされていることを確認してください。 PHPUnit コードカバレッジ分析.

コードの下部からリファクタリングを開始

下の図を見てください。これは Github から見つけた本物のホテル管理システムのプロジェクトです。これはオープンソースプロジェクトですが、クローズドソースプロジェクトではひどいことになるでしょう。

例: 下からのリファクタリング

このコードを見ると、赤でマークされた 3 つのレベルがあります。最下位レベルは、最初の if 条件の if/else で囲まれた宣言である必要があります。通常、最下位レベルは単一の論理処理に集中しており、リファクタリングが容易です。

メソッドを短くし、より小さなメソッドまたは構成ファイル/DB テーブルに分解します。

ここで、以下のように改良できるかもしれません。プライベートメソッド:

#メソッドを短くする

次の深さは、パラメーターのアップロードとビューの読み込みです。次に、他の部分をリファクタリングした後の add() メソッドを見てみましょう。より簡潔になり、読みやすく、テストしやすくなります。

例: 最下位レベルを最初にリファクタリングする

if ステートメントでは中かっこの使用が必須

ほとんどのプログラミング言語すべての 1 行の if ステートメントがサポートされています。単純なため、一部の開発者はこの方法を使用しています。ただし、空行があると条件が中断され、クラッシュが発生する可能性があるため、読みにくく、問題が発生しやすくなります。次の 2 つの例の違いを見てください:

例: 中かっこを使用します

マジックナンバーやマジック文字列は使用しないでください:

次の例では、部屋が 250 を超えるとエラーメッセージが返されることがわかります。ここで、250 はマジックナンバーとみなされます。これを書いている開発者でなければ、この数字が何を意味するのかを理解するのは難しいでしょう。

例: マジックナンバー

このメソッドをリファクタリングするには、250 が部屋の最大数を表すことを示すことができます。ハードコーディングを置き換えるには、それを変数 $maxAvailableRooms に抽出します。他の開発者にとってもより理解しやすくなりました。

例: マジックナンバーを修正する

本当に必要がない場合は、else ステートメントを使用しないでください。

同じ availablerooms() 関数内で、if ステートメントに注目すると、else 部分を簡単に削除でき、ロジックの一貫性が保たれます。

#例: else ステートメントを無視します

メソッド、変数、テストを表す名前を使用します

次の例では、ホテル管理システムに「index()」と「room_m()」という 2 つのメソッドがあることがわかります。私には、彼らの目的が何なのか理解できません。彼らの名前が彼ら自身を表していると理解しやすいと思います。

例: 不適切なメソッドの名前付け

プログラミング言語の力を最大限に活用する

多くの開発者プログラマは、使用しているプログラミング言語の機能を最大限に活用できなくなります。多くの機能により時間を節約し、コードをより堅牢にすることができます。以下の例を見て、型ヒントを使用することで、より少ないコードで同じ結果を簡単に達成できることに注目してください。

#最後に、コーディングを改善するための簡単なヒントをいくつか提供したいと思います。

データ型を確認しないことが重要でない限り、== の代わりに === 演算子を使用してください。
パブリックメソッドには短くてわかりやすい名前を付けることをお勧めします。プライベートメソッドではスコープがより制限されているため、長い名前を使用できます。
インターフェースを実装するメソッドに対してのみ add() などの一般名を使用し、個々のクラスメソッドに対しては addUser() や addDocument() などのわかりやすい名前を使用します。
未使用のメソッドをクラスから削除します。
ブール値: isAdmin($user)、hasPermission($user) などの値を返す関数には、is/has プレフィックスを使用します。
クラスのメソッドとプロパティでは常にアクセス修飾子を使用してください。
インターフェイスの汚染に注意してください。ユーザーが公的に利用できるメソッドのみを使用してください。
パブリックメソッドが先頭になるようにクラスメソッドを編成します。
クラス内では常に単一責任の概念を適用してください。