PHP をマスターする: タイプ ヒンティングのテクニック

写真提供: ???? ??? Unsplash

で

型ヒントは機能の聖杯であると考える人もいます。すべてのプログラミング言語に必須のものです。 PHP には長い間そのようなシステムがありませんでしたが、現在ではほとんどの開発者によって広く採用されています。

そうは言っても、PHP の型システムは他の言語ほどではありません。多くはジェネリックとして知られるものを実装しています。これは、構造体とコレクション間で型を強制する機能です。たとえば、Java では、配列には特定のタイプの項目 (たとえば、文字列の配列) のみを含める必要があると指定できます。

いつかこの機能が PHP にも実装されるかもしれませんが、それまでは、いくつかの異なるテクニックを使って実際にこの問題を解決することができます。より適切な説明がないため、これらを ソフト タイプ ヒント および ランタイム ヒント と呼びます。

タイプヒント

最初の最も明白な型ヒントは、PHP 7 で導入されたもので、現在も PHP に追加されています。タイプヒンテッド定数は PHP 8.3 でのみ追加されました。

型ヒントは、メソッドまたは関数にパラメータとして何を渡す必要があるか、またはそのメソッドが何を返すかを伝えるのに役立ちます。すでに確立されている型ヒントを使用してクラスを拡張すると、型ヒントをオーバーライドできないことを意味するため、型ヒントは、それを使用するクラスのシグネチャに影響します。

型を最大限に活用するクラスの例は次のとおりです。

<?php

class Foo
{
    public function bar(array $strings): \Closure
    {
       return function (string $string) use ($strings): bool {
           return in_array($string, $strings);
       };
    }
}

もちろん、型ヒントには制限があります。前述したように、配列をすべて同じ型に適合させることはできず、代わりに array を使用する必要があるからです。また、数値を正のみまたは特定の範囲内に制限することもできません。

PHP のネイティブ型内で匿名関数を記述する方法がないため、もう 1 つはクロージャである可能性があります。代わりに、 Closure または callable を使用する必要があります。多くの場合、callable は型としても使用できません。

幸いなことに、型ヒントを使用してこれらのより複雑なシナリオを記述する方法はまだあります。

ソフトタイプのヒント

次の種類の型ヒントは、PHPDoc 経由で提供されます。メソッドが渡された場合、または間違った型を返した場合、ネイティブ型は実行時に例外をスローしますが、PHPDoc 型ヒントはアプリケーションの実行時に影響を与えません。

代わりに、VS Code や PHPStorm などの型を検出してくれる IDE を使用しているときに、ソフト型ヒントが役立ちます。もう 1 つのユースケースは、PHPStan やその後の Rector などの静的分析ツールを使用したものです。

ソフト型を使用する最大の利点は、パラメータやプロパティなどの型をより正確に記述できることです。たとえば、前のクラスを使用して、使用される配列やクロージャを理解しやすくすることができます。 .

<?php

class Foo
{
    /**
     * @param string[] $strings
     * @return \Closure(string): bool
     */
    public function bar(array $strings): \Closure
    {
       return function (string $string) use ($strings): bool {
           return in_array($string, $strings);
       };
    }
}

型の使用法がすべて正しいことを確認する最善の方法は、PHPStan をインストールすることです。そこからは、少なくともレベル 5 を使用する必要がある可能性があります。これは、タイプ ヒンティングが正しいことを確認する継続的統合ステップを通じて適用できます。

実際には、正しいソフト タイプ ヒントを使用したい場合に使用できるリストがあります。さらに良いことに、確信が持てず、簡単なテストを実行したい場合に、PHPStan ごとにすべての型ヒントが正しいかどうかをテストするために使用できる PHPStan ツールがあります。

実行時のヒント

型をサポートする次の方法は、実行時ヒントを使用することです。これが実際に意味するのは、独自のコードを実行してパラメータから型をチェックすることです。たとえば、配列に特定の種類のオブジェクトのみが含まれているかどうかを確認できます。そうでない場合は、InvalidArgumentException をスローします。

<?php

/**
 * @param string[] $foo
 */
function bar(array $foo) {
    foreach ($foo as $string) {
        if (! is_string($string)) {
            throw new \InvalidArgumentException('foo contains non-string value');
        }
    }

    // rest of the code
}

ちなみに、この手法は防御的プログラミングと呼ばれることもあります。コード例を見ると、これはかなり面倒です。配列が正しいかどうかを単純にチェックするだけでも膨大なコードになります。そのため、代わりにライブラリ (この場合は webmozart/assert ) を使用することがよくあります。

composer require webmozart/assert

このパッケージがインストールされたので、これを単純な 1 行のライナーに短縮できます。

<?php

use Webmozart\Assert;

/**
 * @param string[] $foo
 */
function bar(array $foo) {
    Assert::allStrings($foo);
}

このライブラリの優れた点の 1 つは、PHPStan に Assert 拡張機能を追加すると、コード分析時の型カバレッジに役立つことです。

結論

結論として、PHP で型ヒントを習得することは、クリーンで保守可能で信頼性の高いコードを記述したい開発者にとって不可欠なスキルです。 PHP の型システムには、ジェネリックなど、他の言語にあるいくつかの機能がまだ欠けていますが、ネイティブ型ヒント、PHPDoc アノテーション、実行時チェックなど、より厳密な型付けを強制するために利用できる複数の戦略があります。 PHPStan などのツールや Assert などのライブラリを活用すると、複雑なシナリオでも型の安全性を確保できます。これらのテクニックを開発ワークフローに統合することで、PHP の動的な性質を自信を持って正確に処理できるようになります。

私は Peter Fox です。英国のソフトウェア開発者で、Laravel を使っています。私の記事を読んでいただきありがとうございます。https://articles.peterfox.me には他にもたくさんの記事があります。私は現在、GitHub のスポンサーにもなっています。このような記事をもっと書くよう私に勧めたい場合は、少額の 1 回限りの寄付を検討してください。

以上がPHP をマスターする: タイプ ヒンティングのテクニックの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。