PHP로 클린 코드 마스터하기: 나의 코딩 여정에서 얻은 주요 교훈

"PHP에서 클린 코드 마스터하기: 내 코딩 여정에서 얻은 핵심 교훈"은 PHP 개발자가 깔끔하고 유지 관리가 가능하며 효율적인 코드를 작성하는 데 도움이 되는 실용적이고 실무적인 규칙과 예에 중점을 둡니다. 여기서는 이러한 필수 규칙을 소화 가능한 부분으로 나누어 각각의 예를 들어보겠습니다.

1. 의미 있는 이름

• 규칙: 변수, 함수, 클래스에는 명확하고 설명이 포함된 이름을 사용하세요.
• 이유: 이렇게 하면 코드를 더 쉽게 이해하고 유지 관리할 수 있습니다.

예:

   // BAD:
   $x = 25;
   function d($a, $b) {
       return $a + $b;
   }

   // GOOD:
   $age = 25;
   function calculateSum($firstNumber, $secondNumber) {
       return $firstNumber + $secondNumber;
   }

설명:

• $x 또는 $d와 같은 한 글자 변수는 사용하지 마세요. 대신 $age 또는calculateSum과 같은 설명적인 이름을 사용하십시오.
• 명확한 이름은 의도를 명확하게 하여 현재와 미래의 개발자 모두 코드의 목적을 이해하는 데 도움이 됩니다.

2. 단일 책임 원칙(SRP)

• 규칙: 함수나 클래스는 변경 이유가 하나만 있어야 합니다. 즉, 한 가지 작업만 수행해야 합니다.
• 이유: 이렇게 하면 코드가 더욱 모듈화되고 리팩터링이 쉬워집니다.

예:

   // BAD:
   class Order {
       public function calculateTotal() {
           // logic to calculate total
       }

       public function sendInvoiceEmail() {
           // logic to send email
       }
   }

   // GOOD:
   class Order {
       public function calculateTotal() {
           // logic to calculate total
       }
   }

   class InvoiceMailer {
       public function sendInvoiceEmail() {
           // logic to send email
       }
   }

설명:

• BAD 예에서 Order 클래스는 총액 계산과 이메일 전송을 모두 담당합니다. 이는 두 가지 책임이 있으므로 SRP를 위반합니다.
• GOOD 예에서는 이메일 작업을 담당하는 InvoiceMailer 클래스를 만들어 각 클래스를 더 쉽게 관리하고 업데이트할 수 있도록 하여 문제를 분리합니다.

3. 기능을 작게 유지

• 규칙: 함수는 한 가지 일을 잘 수행해야 합니다. 큰 기능을 작은 기능으로 나눕니다.
• 이유: 작은 기능은 이해, 테스트, 유지 관리가 더 쉽습니다.

예:

   // BAD:
   function processOrder($order) {
       // Validate order
       if (!$this->validateOrder($order)) {
           return false;
       }

       // Calculate total
       $total = $this->calculateTotal($order);

       // Send invoice
       $this->sendInvoiceEmail($order);

       return true;
   }

   // GOOD:
   function processOrder($order) {
       if (!$this->isOrderValid($order)) {
           return false;
       }

       $this->finalizeOrder($order);
       return true;
   }

   private function isOrderValid($order) {
       return $this->validateOrder($order);
   }

   private function finalizeOrder($order) {
       $total = $this->calculateTotal($order);
       $this->sendInvoiceEmail($order);
   }

설명:

• BAD 예에서 processOrder 함수는 검증, 계산, 송장 보내기 등 모든 작업을 수행하려고 합니다.
• GOOD 예에서는 작업을 더 작고 집중적인 메서드(isOrderValid, finalizeOrder)로 나누어 가독성과 재사용성을 향상했습니다.

4. 마법의 숫자와 문자열을 피하세요

• 규칙: "마법의" 숫자와 문자열을 명명된 상수로 바꾸세요.
• 이유: 이렇게 하면 가독성이 향상되고 코드 수정이 더 쉬워집니다.

예:

   // BAD:
   if ($user->age > 18) {
       echo "Eligible";
   }

   // GOOD:
   define('MINIMUM_AGE', 18);

   if ($user->age > MINIMUM_AGE) {
       echo "Eligible";
   }

설명:

• BAD 예에서 숫자 18은 "매직 넘버"입니다. 맥락을 분석하기 전까지는 그것이 무엇을 의미하는지 알 수 없습니다.
• GOOD 예시에서 MINIMUM_AGE를 사용하면 의도가 명확해지고 코드베이스를 검색하지 않고도 한 곳에서 값을 변경할 수 있습니다.

5. DRY(반복하지 마세요)

• 규칙: 코드 중복을 피하세요. 가능하면 함수나 클래스를 재사용하세요.
• 이유: 중복된 코드는 유지 관리가 더 어렵고 버그가 발생하기 쉽습니다.

예:

   // BAD:
   $total = $itemPrice * $quantity;
   $finalPrice = $total - ($total * $discountRate);

   $cartTotal = $cartItemPrice * $cartQuantity;
   $finalCartPrice = $cartTotal - ($cartTotal * $cartDiscountRate);

   // GOOD:
   function calculateFinalPrice($price, $quantity, $discountRate) {
       $total = $price * $quantity;
       return $total - ($total * $discountRate);
   }

   $finalPrice = calculateFinalPrice($itemPrice, $quantity, $discountRate);
   $finalCartPrice = calculateFinalPrice($cartItemPrice, $cartQuantity, $cartDiscountRate);

설명:

• BAD 예시에서는 가격 계산 로직이 중복되어 있습니다.
• GOOD 예에서는 반복을 방지하고 코드 유지 관리를 더 쉽게 만들기 위해 재사용 가능한 함수 계산FinalPrice를 생성합니다.

6. 보호 조항을 사용하여 중첩을 줄입니다

• 규칙: 깊게 중첩된 if 문 대신 일찍 반환하여 구조를 단순화하세요.
• 이유: 가드 절은 불필요한 중첩을 제거하여 코드를 더 깔끔하고 따르기 쉽게 만듭니다.

예:

   // BAD:
   function processPayment($amount) {
       if ($amount > 0) {
           if ($this->isPaymentMethodAvailable()) {
               if ($this->isUserLoggedIn()) {
                   // Process payment
               }
           }
       }
   }

   // GOOD:
   function processPayment($amount) {
       if ($amount <= 0) {
           return;
       }
       if (!$this->isPaymentMethodAvailable()) {
           return;
       }
       if (!$this->isUserLoggedIn()) {
           return;
       }

       // Process payment
   }

설명:

• BAD 예에서는 논리가 깊게 중첩되어 읽기가 더 어렵습니다.
• GOOD 예시에서는 조건이 충족되지 않을 경우 조기에 반환하기 위해 가드 절을 사용하여 구조를 평면화하고 코드를 더 깔끔하게 만듭니다.

7. 무엇이 아닌 왜에 대한 댓글

• 규칙: 무슨 일이 일어나고 있는지가 아니라 왜 무슨 일이 일어나고 있는지 설명하는 주석을 작성하세요(코드에서 명확해야 함).
• 이유: 주석은 명백한 것 이상의 가치를 제공하여 코드 뒤에 숨은 의도와 추론을 설명하는 데 도움이 되어야 합니다.

예:

   // BAD:
   // Increment age by 1
   $age++;

   // GOOD:
   // User's birthday has passed, increase age by 1
   $age++;

설명:

• The BAD comment simply restates what the code does, which is obvious from the code itself.
• The GOOD comment explains why we are incrementing the age, adding meaningful context.

8. Refactor for Clarity

• Rule: Continuously refactor to improve code clarity and simplicity.
• Why: Clean code is achieved through constant refactoring to ensure that it is always readable, efficient, and maintainable.

Example:

   // Before Refactoring:
   function getDiscountedPrice($price, $isHoliday) {
       if ($isHoliday) {
           return $price * 0.9;
       } else {
           return $price;
       }
   }

   // After Refactoring:
   function getDiscountedPrice($price, $isHoliday) {
       return $isHoliday ? $price * 0.9 : $price;
   }

Description:

• Refactoring transforms long-winded code into more concise, elegant versions without losing clarity. In this example, we simplified an if-else structure using a ternary operator.

---

These essential rules—derived from the journey of coding cleanly in PHP—make your code more readable, maintainable, and scalable. By applying these principles consistently, you ensure that your code is easy to understand and modify over time, regardless of the complexity of your projects.

위 내용은 PHP로 클린 코드 마스터하기: 나의 코딩 여정에서 얻은 주요 교훈의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!