POKA 요크 - 과다 방어 프로그래밍으로 프로젝트를 절약합니다

이 기사는 Deji Akala와 Marco Pivetta가 동료 검토했습니다. Sitepoint에서 최고의 콘텐츠를 얻으려면 Sitepoint의 모든 동료 검토 자에게 감사합니다!

서로의 코드를 이해하고 사용하는 방법은 중간 및 대형 팀이 동일한 코드 기반에서 협력 할 때 때때로 어려워 질 수 있습니다. 이를 위해 여러 솔루션이 있습니다. 예를 들어, 코드의 가독성을 향상시키기 위해 코딩 표준 세트를 따르거나 모든 팀원에게 친숙한 프레임 워크를 사용하는 데 동의 할 수 있습니다 (우수한 Laravel 엔트리 레벨 과정은 여기에서 사용할 수 있음).

그러나 이것은 일반적으로 충분하지 않습니다. 특히 버그를 수정하거나 새로운 기능을 추가하기 위해 얼마 전에 작성된 응용 프로그램 섹션을 탐구해야 할 때 특히 충분하지 않습니다. 이 시점에서, 특정 계급이 어떻게 자신들과 어떻게 결합되는지를 포함하여 어떻게 작동 할 것으로 예상되는지 기억하기가 어렵습니다. 이 시점에서 실수로 부작용이나 오류를 알지 못하고 쉽게 도입 할 수 있습니다.

이러한 오류는 품질 보증에서 찾을 수 있지만 실제로 무시할 수도 있습니다. 발견 되더라도 코드를 다시 보내고 수정하는 데 많은 시간이 걸릴 수 있습니다.

---

그래서 우리는 이것을 어떻게 막을 수 있습니까? 대답은

"포카 요크"입니다.

키 포인트

Poka 요크 정의 : Poka 요크는 "오류 방지"를 의미하는 일본어 용어입니다. 오류 예방 및 감지 :이 방법은 오류 방지 (코드가 올바르게 사용되는지 확인) 및 오류 감지 (잠재적 오류에 대한 응용 프로그램 모니터링 포함)로 나뉩니다.

<:> 실용 응용 프로그램 예 : PHP에서 유형 선언 구현 매개 변수 유형 오류를 방지하고 값 객체를 사용하여 난독 화 기능 매개 변수를 피하는 것이 오류 방지의 핵심 예입니다.

불변성 및 빈 개체 : 응용 프로그램의 부작용을 방지하기 위해 물체의 불변성을 강조하고 빈 개체를 사용하여 빈 체크를 피하는 것은 고급 포카 요크 전략입니다.

오류 처리 및 로깅 : PHP에서 엄격한 유형을 활성화하고 오류를 억제하지 않고 사전에 로깅 및 모니터링하는 것과 같은 엄격한 오류 처리를 옹호합니다.

광범위한 적용 가능성 : POKA 요크는 프로그래밍에만 국한되지 않으며 API 가용성을 향상시키고, 응용 프로그램 구성을 개선하며, 다양한 인터페이스에서 사용자 오류를 방지하여 다른 필드에서 보편성을 보여줍니다. 포카 요크는 무엇입니까?

Poka 요크는 대략 "반대기"로 변환되는 일본어 용어입니다. 이 용어는 Lean Manufacturing에서 비롯되었으며 기계 운영자가 오류를 피하는 데 도움이되는 메커니즘을 나타냅니다.

제조 외에도 포카 요크는 소비자 전자 제품에 자주 사용됩니다. 예를 들어, SIM 카드는 비대칭 모양으로 인해 SIM 트레이에만 삽입 될 수 있습니다.

• 포카 요크가없는 하드웨어 예제는 PS/2 포트이며, 키보드 커넥터와 마우스 커넥터와 정확히 동일한 모양을 갖습니다. 색상 코드를 사용 하여만 구별 할 수 있으므로 실수로 커넥터를 교체하고 같은 방식으로 적합하므로 잘못된 포트에 쉽게 삽입 할 수 있습니다.

  하드웨어에 사용되는 것 외에도 포카 요크의 개념을 프로그래밍에도 적용 할 수 있습니다. 아이디어는 코드의 공개 인터페이스를 가능한 한 이해하기 쉽고 코드를 잘못 사용 할 때 즉시 오류를 던지는 것입니다. 이것은 분명해 보이지만 실제로는 종종 이와 관련하여 결함이있는 코드를 만납니다. 그러나 포카 요크는 의도적 인 학대를 예방하기위한 것이 아닙니다. 목표는 코드를 악의적 인 사용으로부터 보호하지 않고 예기치 않은 오류를 방지하는 것입니다. 누군가가 귀하의 코드에 액세스 할 수있는 한, 실제로 원하는 경우 보안 조치를 우회 할 수 있습니다.

  코드를 오류 방지하기 위해 어떤 특정 조치를 취할 수 있는지 논의하기 전에 Poka 요크 메커니즘이 일반적으로 두 가지 범주로 나눌 수 있음을 아는 것이 중요합니다.

  오류 방지 오류 감지

  오류 방지 기술은 가능한 빨리 오류를 감지하는 데 도움이됩니다. 그들은 인터페이스와 동작을 가능한 한 간단하고 간단하게 만들어 아무도 실수로 우리의 코드를 잘못 사용할 수 없도록 설계되었습니다. SIM 카드의 예를 생각해보십시오.

  반면에 오류 감지 메커니즘은 코드 외부에 존재합니다. 그들은 잠재적 오류에 대한 응용 프로그램을 모니터링하고 경고합니다. 예를 들어 PS/2 포트에 연결된 장치가 올바른 유형의 소프트웨어인지 여부를 감지하는 것이며, 그렇지 않은 경우 작동하지 않는 이유에 대한 경고가 표시됩니다. 이 특정 소프트웨어는 연결할 때 커넥터가 상호 교환 될 수 있으므로 오류를 방지 할 수 없지만 오류를 감지하고 오류를 수정할 수 있도록 경고 할 수 있습니다.

  이 기사의 나머지 부분에서는 응용 프로그램에서 오류 예방 및 오류 감지를 구현하는 데 사용할 수있는 몇 가지 방법을 살펴 봅니다. 그러나이 목록은 시작점 일뿐입니다. 특정 애플리케이션에 따라 코드를보다 오류 방지 할 수있는 추가 조치가있을 수 있습니다. 또한, 포카 요크의 선불 비용을 기억하고 특정 프로젝트에 가치가 있는지 확인하는 것이 중요합니다. 응용 프로그램의 복잡성과 크기에 따라 잠재적 오류 비용에 비해 일부 측정 값이 너무 비쌀 수 있습니다. 따라서 귀하와 귀하의 팀은 귀하가 취할 수있는 가장 적합한 조치를 결정해야합니다.

  오류 방지 예

  (스칼라) 유형 선언 이전에 PHP 5에서 유형 힌트라고 불리는 유형 선언은 PHP 7에서 오류 방지 기능 및 메소드 서명을 시작하는 쉬운 방법입니다.
  • 함수 매개 변수에 특정 유형을 할당하여 함수를 호출 할 때 매개 변수 순서를 난독 화하는 것이 더 어려워집니다.
  예를 들어 사용자에게 보내고 싶은이 알림을 살펴 보겠습니다.

  유형 선언이 없으면 잘못된 유형의 변수를 쉽게 주입하여 응용 프로그램을 중단 할 수 있습니다. 예를 들어, $ 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;
      }
  }
  

  따라서 따라서, 개발 중에 가능한 한 빨리 이러한 오류를 감지 할 수 있도록 적용이 가능한 빨리 충돌하도록 강제하는 것이 일반적으로 더 흥미 롭습니다.

  이 경우 일부 유형 선언을 추가 할 수 있으며 매개 변수 유형을 난독 화하면 PHP가 즉시 중지되고 치명적인 오류를 경고합니다.

  그러나 기본적으로 PHP는 예상 ​​유형에 잘못된 매개 변수를 캐스팅하려고합니다. 이를 방지하기 위해서는 오류가 발생하면 실제로 치명적인 오류를받을 수 있도록 strict_types를 활성화하는 것이 중요합니다. 따라서 스칼라 유형 선언은 이상적인 포카 요크 형태는 아니지만 오류를 줄이는 것이 좋습니다. strict_types가 비활성화 되더라도 여전히 예상 유형의 매개 변수를 표시 할 수 있습니다.

  또한 메소드의 리턴 유형을 선언합니다. 이를 통해 특정 함수를 호출 할 때 기대할 수있는 값을 쉽게 결정할 수 있습니다.

  운영 정의 된 반환 유형은 또한 반환 값을 처리 할 때 많은 수의 스위치 문을 사용하지 않도록 도와줍니다. 우리의 메소드는 명시 적으로 선언 된 반환 유형없이 다양한 유형을 반환 할 수 있기 때문입니다. 따라서 우리의 방법을 사용하는 사람들은 특정 경우에 실제로 반환되는 유형을 확인해야합니다. 이 스위치 명령문은 분명히 잊혀지고 감지 할 수없는 오류로 이어집니다. 반환 유형을 사용하면 이러한 오류가 크게 줄어 듭니다.
  value 객체 <🎜 🎜> 스칼라 유형 힌트를 쉽게 해결할 수없는 한 가지 문제는 여러 함수 매개 변수를 갖는 것이 해당 매개 변수의 순서를 혼동 할 수 있다는 것입니다.
  <<>

  <?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는 경고 할 수 있지만 대부분의 경우 동일한 유형의 매개 변수가있을 수 있습니다.

  이 문제를 해결하기 위해 값 객체로 매개 변수를 랩핑 할 수 있습니다.

  우리의 매개 변수는 이제 매우 구체적인 유형을 가지고 있기 때문에 혼동하는 것은 거의 불가능합니다.

  스칼라 유형 선언 대신 값 객체를 사용하는 또 다른 장점은 더 이상 각 파일에서 strict_types를 활성화 할 필요가 없다는 것입니다. 우리가 그것을 기억할 필요가 없다면, 실수로 그것을 잊을 수는 없습니다.

  검증 <🎜 🎜>

  <<>