Sauberen Code in PHP beherrschen: Wichtige Erkenntnisse aus meiner Coding-Reise

„Mastering Clean Code in PHP: Key Lessons from My Coding Journey“ konzentriert sich auf praktische, praktische Regeln und Beispiele, die PHP-Entwicklern dabei helfen sollen, sauberen, wartbaren und effizienten Code zu schreiben. Hier zerlegen wir diese wesentlichen Regeln in leicht verständliche Teile, jeweils begleitet von einem Beispiel.

1. Bedeutungsvolle Namen

• Regel: Verwenden Sie klare und beschreibende Namen für Variablen, Funktionen und Klassen.
• Warum: Dadurch ist Ihr Code leichter zu verstehen und zu warten.

Beispiel:

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

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

Beschreibung:

• Vermeiden Sie Variablen mit einem Buchstaben wie $x oder $d. Verwenden Sie stattdessen beschreibende Namen wie $age oder berechneSum.
• Eindeutige Namen machen Ihre Absicht deutlich und helfen sowohl aktuellen als auch zukünftigen Entwicklern, den Zweck Ihres Codes zu verstehen.

2. Single-Responsibility-Prinzip (SRP)

• Regel: Eine Funktion oder Klasse sollte nur einen Grund zur Änderung haben, das heißt, sie sollte nur eine Sache tun.
• Warum: Dadurch wird Ihr Code modularer und lässt sich leichter umgestalten.

Beispiel:

   // 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
       }
   }

Beschreibung:

• Im Beispiel BAD ist die Order-Klasse sowohl für die Berechnung der Gesamtsumme als auch für den Versand einer E-Mail verantwortlich. Dies verstößt gegen SRP, da es zwei Verantwortlichkeiten gibt.
• Im Beispiel GUT trennen wir Anliegen, indem wir eine InvoiceMailer-Klasse erstellen, die für E-Mail-Aufgaben verantwortlich ist, wodurch jede Klasse einfacher zu verwalten und zu aktualisieren ist.

3. Funktionen klein halten

• Regel: Funktionen sollten eine Sache tun und zwar gut. Teilen Sie große Funktionen in kleinere auf.
• Warum: Kleine Funktionen sind einfacher zu verstehen, zu testen und zu warten.

Beispiel:

   // 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);
   }

Beschreibung:

• Im Beispiel BAD versucht die Funktion „processOrder“, alles zu tun: Validierung, Berechnung und Senden einer Rechnung.
• Im Beispiel GUT zerlegen wir Aufgaben in kleinere, fokussiertere Methoden (isOrderValid, finalizeOrder), wodurch die Lesbarkeit und Wiederverwendbarkeit verbessert wird.

4. Vermeiden Sie magische Zahlen und Zeichenfolgen

• Regel: Ersetzen Sie „magische“ Zahlen und Zeichenfolgen durch benannte Konstanten.
• Warum: Dies verbessert die Lesbarkeit und erleichtert die Änderung des Codes.

Beispiel:

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

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

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

Beschreibung:

• Im Beispiel SCHLECHT ist die Zahl 18 eine „magische Zahl“. Sie wissen nicht, was es darstellt, bis Sie den Kontext analysieren.
• Im Beispiel GUT macht die Verwendung von MINIMUM_AGE die Absicht klar und ermöglicht es Ihnen, den Wert an einer Stelle zu ändern, ohne die Codebasis zu durchsuchen.

5. DRY (nicht wiederholen)

• Regel: Vermeiden Sie die Duplizierung von Code. Verwenden Sie Funktionen oder Klassen nach Möglichkeit wieder.
• Warum: Duplizierter Code ist schwieriger zu warten und anfälliger für Fehler.

Beispiel:

   // 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);

Beschreibung:

• Im Beispiel BAD ist die Preisberechnungslogik dupliziert.
• Im Beispiel GUT erstellen wir eine wiederverwendbare Funktion berechneFinalPreis, um Wiederholungen zu vermeiden und den Code wartbarer zu machen.

6. Verwenden Sie Schutzklauseln, um die Verschachtelung zu reduzieren

• Regel: Statt tief verschachtelter if-Anweisungen früh zurückkehren, um die Struktur zu vereinfachen.
• Warum: Schutzklauseln eliminieren unnötige Verschachtelungen, wodurch der Code sauberer und leichter verständlich wird.

Beispiel:

   // 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
   }

Beschreibung:

• Im Beispiel SCHLECHT ist die Logik tief verschachtelt, was die Lesbarkeit erschwert.
• Im Beispiel GUT werden Schutzklauseln verwendet, um vorzeitig zurückzukehren, wenn Bedingungen nicht erfüllt sind, wodurch die Struktur abgeflacht und der Code sauberer wird.

7. Kommentieren Sie zum Warum, nicht zum Was

• Regel: Schreiben Sie Kommentare, um zu erklären, warum etwas passiert, nicht was passiert (was aus dem Code klar hervorgehen sollte).
• Warum: Kommentare sollten einen Mehrwert bieten, der über das Offensichtliche hinausgeht, und dabei helfen, die Absicht und Begründung hinter dem Code zu erklären.

Beispiel:

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

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

Beschreibung:

• 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.

Das obige ist der detaillierte Inhalt vonSauberen Code in PHP beherrschen: Wichtige Erkenntnisse aus meiner Coding-Reise. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!