Poka Yoke-高防御プログラミングでプロジェクトを保存します-PHPチュートリアル-php.cn

Poka Yoke - Saving Projects with Hyper-Defensive Programming

この記事は、Deji AkalaとMarco Pivettaによって査読されました。 SitePointで最高のコンテンツを取得するためにSetePointのすべてのピアレビューアに感謝します！

お互いのコードとその使用方法を理解する方法は、中程度のチームと大規模なチームが同じコードベースで協力すると困難になる場合があります。この目的のために、複数のソリューションがあります。たとえば、コードの読みやすさを改善するために一連のコーディング標準に従って、すべてのチームメンバーに馴染みのあるフレームワークを使用することに同意することができます（優れたLaravelエントリレベルのコースはこちらから入手できます）。

ただし、これは通常、バグを修正したり新しい機能を追加したりするために書かれたアプリケーションセクションを掘り下げる必要がある場合に、通常十分ではありません。この時点で、特定のクラスがどのように機能するかを思い出すことは困難です。この時点で、副作用やエラーを知らずに誤って導入するのは簡単です。

これらのエラーは品質保証で見られる可能性がありますが、本当に無視される場合があります。発見されたとしても、コードを返送して修正するには多くの時間がかかる場合があります。 Poka Yoke - Saving Projects with Hyper-Defensive Programming

では、これをどのように防ぐのでしょうか？答えは

「ポカヨーク」

です。

キーポイント

Poka Yokeの定義：Poka Yokeは、「エラー防止」を意味する日本の用語であり、コードの使用の予期しないエラーを防ぐためにプログラミングに適用されます。

ポカヨークとは何ですか？

Poka Yokeは、「反error」に大まかに翻訳される日本の用語です。この用語はリーン製造に由来し、機械オペレーターがエラーを回避するのに役立つあらゆるメカニズムを指します。

製造に加えて、Poka Yokeは家電でも頻繁に使用されます。たとえば、SIMカードは、非対称形状のために1つの方法でSIMトレイにのみ挿入できます。

Poka Yokeを欠いているハードウェアの例は、キーボードコネクタとマウスコネクタとまったく同じ形状を持つPS/2ポートです。それらはカラーコードを使用することによってのみ区別することができるため、コネクタは誤って交換して間違ったポートに挿入するのが簡単です。

Poka Yoke - Saving Projects with Hyper-Defensive Programming

ハードウェアで使用されていることに加えて、Poka Yokeの概念もプログラミングに適用できます。アイデアは、コードのパブリックインターフェースをできるだけ理解しやすくすることを行い、コードが誤って使用されている場合にすぐにエラーをスローすることです。これは明白なように思えますが、実際には、この点で欠陥があるコードに遭遇することがよくあります。

ただし、Poka Yokeは意図的な虐待を防ぐことを意図していないことに注意してください。その目標は、コードを悪意のある使用から保護するのではなく、予期しないエラーを防ぐことです。誰かがあなたのコードにアクセスできる限り、彼らは本当に望むなら常にあなたのセキュリティ対策を迂回することができます。

コードをよりエラー防止にするためにどのような具体的な測定値を取ることができるかを議論する前に、ポカヨークメカニズムを通常2つのカテゴリに分割できることを知ることが重要です。

エラー予防技術は、できるだけ早くエラーを検出するのに役立ちます。彼らは、インターフェイスと動作を可能な限り単純で簡単にすることによって、誰も私たちのコードを誤って誤って使用できないように設計されています。 SIMカードの例を考えてみてください。これは、1つの方法でSIMトレイにのみ挿入できます。

一方、エラー検出メカニズムはコードの外側に存在します。彼らは潜在的なエラーについて私たちのアプリケーションを監視し、私たちに警告します。例は、PS/2ポートに接続されたデバイスが正しいタイプのソフトウェアであるかどうかを検出することであり、そうでない場合、それが機能しない理由について警告がユーザーに表示されます。この特定のソフトウェアは、接続するとコネクタが交換可能であるためエラーを防ぐことはできませんが、エラーを検出して警告することができ、エラーを修正できるようにします。

この記事の残りの部分では、アプリケーションでエラー予防とエラー検出を実装するために使用できるいくつかの方法を検討します。ただし、このリストはほんの出発点にすぎないことを忘れないでください。特定のアプリケーションに応じて、コードをよりエラー防止にする可能性のある追加の測定値がある場合があります。また、ポカヨークの前払いコストを覚えておいて、特定のプロジェクトに価値があることを確認することが重要です。アプリケーションの複雑さとサイズに応じて、潜在的なエラーコストに比べていくつかのメジャーは高すぎる場合があります。したがって、あなたとあなたのチームは、あなたがとるのに最適な措置を決定する必要があります。

エラー防止例

（スカラー）タイプ宣言 Poka Yoke - Saving Projects with Hyper-Defensive Programming 以前にPHP 5でタイプのヒントと呼ばれていたタイプのヒントは、PHP 7のエラー防止機能とメソッド署名を開始する簡単な方法です。

関数パラメーターに特定のタイプを割り当てることにより、関数を呼び出すときにパラメーターの順序を難読化することにより、より困難になります。

たとえば、

ユーザーに送信したいこの通知を見てみましょう。

<?php
class Notification {
    private $userId;
    private $subject;
    private $message;

    public function __construct(
        $userId,
        $subject,
        $message
    ) {
        $this->userId = $userId;
        $this->subject = $subject;
        $this->message = $message;
    }

    public function getUserId()
    {
        return $this->userId;
    }

    public function getSubject()
    {
        return $this->subject;
    }

    public function getMessage()
    {
        return $this->message;
    }
}

ログイン後にコピー

タイプ宣言がなければ、間違ったタイプの変数を簡単に注入できます。これにより、アプリケーションが破損する可能性があります。たとえば、$ useridは文字列である必要があり、実際には整数である必要があると仮定できます。

間違ったタイプを挿入すると、アプリケーションが実際に通知を処理しようとするまでエラーが検出されない場合があります。その時までに、予期しないタイプに関する理解できないエラーメッセージをいくつか取得するかもしれませんが、整数の代わりに文字列を挿入するコードをすぐに指すものはありません。

したがって、通常、開発中にそのようなエラーをできるだけ早く検出できるように、できるだけ早くアプリケーションを強制的にクラッシュさせることが通常興味深いです。

この場合、単にタイプの宣言を追加できます。パラメータータイプを難読化すると、PHPはすぐに停止し、致命的なエラーを警告します。

しかし、デフォルトでは、PHPは予想されるタイプに誤ったパラメーターをキャストしようとすることに注意してください。これを防ぐために、strict_typesを有効にして、エラーが発生したときに実際に致命的なエラーを受信することが重要です。したがって、スカラー型宣言は理想的なポカヨークフォームではありませんが、エラーを減らすための良いスタートです。 strict_typesが無効になっていても、パラメーターの予想されるタイプの指標として機能することができます。

さらに、メソッドの返品タイプを宣言します。これらにより、特定の関数を呼び出すときに期待できる値を簡単に判断できます。

<?php
declare(strict_types=1);

class Notification {
    private $userId;
    private $subject;
    private $message;

    public function __construct(
        int $userId,
        string $subject,
        string $message
    ) {
        $this->userId = $userId;
        $this->subject = $subject;
        $this->message = $message;
    }

    public function getUserId() : int
    {
        return $this->userId;
    }

    public function getSubject() : string
    {
        return $this->subject;
    }

    public function getMessage() : string
    {
        return $this->message;
    }
}

ログイン後にコピー

操作的に定義されたリターンタイプは、戻り値を処理するときに多数のスイッチステートメントを使用することを避けるのにも役立ちます。これは、メソッドが明示的に宣言されたリターンタイプなしでさまざまなタイプを返すことができるためです。したがって、私たちの方法を使用する人は、特定のケースで実際にどのタイプが返されるかを確認する必要があります。これらのスイッチステートメントは明らかに忘れられており、検出不能なエラーにつながります。返品タイプを使用すると、このようなエラーは大幅に削減されます。

値オブジェクト

スカラータイプのヒントを簡単に解決できないという問題の1つは、複数の関数パラメーターを使用すると、上記のパラメーターの順序を混乱させることができることです。

すべてのパラメーターが異なるスカラータイプを持っている場合、パラメーターの順序を難読化すると、

PHPが警告できますが、ほとんどの場合、同じタイプのいくつかのパラメーターがある場合があります。

この問題を解決するために、このような値オブジェクトにパラメーターを包むことができます。

Poka Yoke - Saving Projects with Hyper-Defensive Programming パラメーターには非常に具体的なタイプがあるため、それらを混乱させることはほとんど不可能です。

スカラー型宣言の代わりに値オブジェクトを使用するもう1つの利点は、各ファイルでstrict_typesを有効にする必要がなくなったことです。覚えておく必要がない場合は、誤って忘れることはできません。

検証

Poka Yoke - Saving Projects with Hyper-Defensive Programming

値オブジェクトを使用する場合、オブジェクト自体のデータ検証ロジックをカプセル化できます。そうすることで、無効な状態で値オブジェクトの作成を防ぐことができます。これにより、アプリケーションの他のレイヤーに問題が発生する可能性があります。

たとえば、

特定のユーザーIDは常に肯定的でなければならないというルールがあるかもしれません。

ユーザーIDを入力として取得するたびにこのルールを明らかに検証できますが、一方では、ある場所で簡単に忘れられることもあります。

このエラーがアプリケーションの別のレイヤーで実際のエラーが発生した場合でも、エラーメッセージは、実際に発生したエラーを明確に示していない場合があり、デバッグが困難です。

このようなエラーを防ぐために、ユーザーIDコンストラクターに検証を追加できます。

この方法では、userIDオブジェクトを使用するときに有効な状態があることを常に保証できます。これにより、アプリケーションのあらゆるレベルでデータを常に敬意なくすることができなくなります。

<?php
class Notification {
    private $userId;
    private $subject;
    private $message;

    public function __construct(
        $userId,
        $subject,
        $message
    ) {
        $this->userId = $userId;
        $this->subject = $subject;
        $this->message = $message;
    }

    public function getUserId()
    {
        return $this->userId;
    }

    public function getSubject()
    {
        return $this->subject;
    }

    public function getMessage()
    {
        return $this->message;
    }
}

ログイン後にコピー

IS_INTを使用する代わりにスカラー型宣言を追加できることに注意してくださいが、これにより、ユーザーIDを使用するすべての場所でstrict_typesを有効にすることができます。

strict_typesを有効にしない場合、PHPはユーザーIDに渡すときに、他のタイプをintに自動的にキャストしようとします。これには問題が発生する可能性があります。たとえば、フローティングポイント数を挿入する可能性があります。これは、ユーザーIDが浮動小数点数ではないため、実際には誤った変数になる可能性があります。

PHPがフローティングポイント変数をintに自動的に変換するため、価格値オブジェクトを使用する場合など、他の場合など、strict_typesを無効にすると、丸めエラーが発生する場合があります。

不変

デフォルトでは、オブジェクトはPHPで参照によって渡されます。これは、オブジェクトを変更すると、アプリケーション全体ですぐに変更されることを意味します。

この方法には利点がありますが、いくつかの欠点もあります。テキストメッセージと電子メールを介してユーザーに通知を送信する例を見てみましょう。 Poka Yoke - Saving Projects with Hyper-Defensive Programming

通知オブジェクトは参照によって渡されるため、予期しない副作用を引き起こしています。 SMSNotificationsenderのメッセージの長さを短縮することにより、参照される通知オブジェクトはアプリケーション全体で更新されます。つまり、EmailNotificationsenderによって後で送信されると短縮されます。

この問題を解決するために、通知オブジェクトを不変にすることができます。それを変更するために設定されたメソッドを提供する代わりに、元の通知のコピーを作成して変更を適用して、次の方法でいくつかを追加できます。

このように、たとえば、メッセージの長さを短縮することで通知クラスを変更するたびに、アプリケーション全体で変化はもはや伝播しないため、予期しない副作用が防止されます。

<?php
declare(strict_types=1);

class Notification {
    private $userId;
    private $subject;
    private $message;

    public function __construct(
        int $userId,
        string $subject,
        string $message
    ) {
        $this->userId = $userId;
        $this->subject = $subject;
        $this->message = $message;
    }

    public function getUserId() : int
    {
        return $this->userId;
    }

    public function getSubject() : string
    {
        return $this->subject;
    }

    public function getMessage() : string
    {
        return $this->message;
    }
}

ログイン後にコピー

しかし、PHPでオブジェクトを真に不変にすることは難しい（不可能ではないにしても）注意してください。しかし、コードをよりエラー防止にするために、セットメソッドの代わりにメソッドを「不変」に追加すると、クラスのユーザーが変更を行う前にオブジェクト自体をクローンすることを忘れないでください。

空のオブジェクトに戻ります

特定の値またはnullを返すことができる関数または方法がある場合があります。これらの無効な返品値は、それらを使用する前に空であるかどうかをほとんど常に確認する必要があるため、問題を引き起こす可能性があります。繰り返しますが、これは私たちが簡単に忘れることができるものです。常に返品値を確認する必要がないようにするために、代わりに空のオブジェクトを返すことができます。

Poka Yoke - Saving Projects with Hyper-Defensive Programming

たとえば、

割引が適用されたり、割引が適用されないショッピングカートを使用できます。

<?php
class Notification {
    private $userId;
    private $subject;
    private $message;

    public function __construct(
        $userId,
        $subject,
        $message
    ) {
        $this->userId = $userId;
        $this->subject = $subject;
        $this->message = $message;
    }

    public function getUserId()
    {
        return $this->userId;
    }

    public function getSubject()
    {
        return $this->subject;
    }

    public function getMessage()
    {
        return $this->message;
    }
}

ログイン後にコピー

一方、割引が設定されていないときに空のオブジェクトを返す場合、これらのチェックを完全に削除できます。

nullable nullable Return値を避けたい理由により、オプションの依存関係を避けたいかもしれませんが、すべての依存関係を必要にするだけです。

dosomething（）メソッドにロガーがあるかどうかを常に確認する必要があります。

サービスコンテナにSomeServiceクラスをセットアップする場合、誰かが実際にロガーをセットアップするのを忘れたり、クラスにロガーをセットアップするオプションがあることさえ知らない場合があります。

さらに、IFステートメントを省略して、ロガーが注入されているかどうかを確認しました。