Der vollständige Konstruktor

oop clean code constructor

Vor einigen Tagen habe ich in einem Artikel beschrieben, wie man mit vielen Parametern in Methoden umgehen kann. Beim Konstruktor handelt es sich allerdings um einen Sonderfall, denn im Gegensatz zu normalen Methoden haben die einzelnen Parameter oft nicht viel miteinander zu tun und lassen sich deswegen nicht zu Parameterobjekten zusammenfassen. Um den Code dennoch lesbar zu halten, benötigen wir andere Mittel.

Weiterlesen

‚ vs. „

Im Netz gibt es zahlreiche Vergleiche zwischen single- und double quotes. Die Meisten basieren auf verschiedenen Benchmarks und stellen die Performance-Unteschiede zwischen den beiden Möglichkeiten dar. Da ich die minimalen Performance-Unterschiede für nicht relevant halte, möchte ich heute einen etwas anderen Vergleich vorstellen.

Weiterlesen

Das Gesetz der Demeter

oop clean code gesetz demeter

Durch Objektorientierte Programmierung versucht man unter anderem, die einzelnen Komponenten einer Software möglichst lose zu koppeln und Abhängigkeiten zu vermeiden. Ein erster Schritt in diese Richtung ist es, die Eigenschaften eines Objektes als private oder protected zu kennzeichnen. Der Zugriff auf diese Eigenschaften erfolgt ausschließlich über entsprechende set- und get-Methoden. Dadurch haben wir z.B. die Möglichkeit, den Namen der Eigenschaft zu verändern ohne die Änderung an allen Stellen durchführen zu müssen, die die Eigenschaft des Objektes verwenden.

Das hier beschriebene Prinzip nennt sich Kapselung. Schauen wir uns das bei folgendem (sinnfreien) Beispiel an.

class Car
{
    private $_name;

    public function __construct($name)
    {
        $this->_name = $name;
    }

    public function getName()
    {
        return $this->_name;
    }
}

class Person
{
    private $_name;

    private $_car;

    public function __construct($name, Car $car)
    {
        $this->_name = $name;
        $this->_car  = $car;
    }

    public function getName()
    {
        return $this->_name;
    }

    public function getCar()
    {
        return $this->_car;
    }
}

class Logger
{
    public function log(Person $value)
    {
        printf(
            '%s fährt einen %s',
            $value->getName(),
            $value->getCar()->getName()
        );
    }
}

$car    = new Car('VW Golf');
$person = new Person('John', $car);
$logger = new Logger();
$logger->log($person);

Soweit so gut, unsere Daten sind alle ordentlich gekapselt. Was aber, wenn wir nun aus der getName-Methode eine getShortName-Methode machen wollen? Nun stehen wir vor dem gleichen Problem, das wir schon bei der Kapselung hatten. Wir müssen unsere Änderungen unter Umständen an vielen Stellen durchführen. Auch wenn die IDE heutzutage viel Arbeit abnimmt, wir haben eine Menge Abhängigkeiten geschaffen und genau das wollten wir ja eigentlich vermeiden.

Weiterlesen

(Zu) viele Parameter

oop clean code parameter

Oft entwirft man Methoden, die viele Parameter benötigen. Nachdem noch 1-2 Features zu der Klasse hinzugefügt wurden, stellt man dann fest, dass es eindeutig zu viele Parameter geworden sind. Folgende Methode dient uns als Beispiel:

public function send(
    $fromStreet, $fromPostalCode, $fromCity, $fromCountry,
    $toStreet,   $toPostalCode,   $toCity,   $toCountry
) {
    //..
}

Das mag bei der Definition noch einigermaßen übersichtlich sein, doch spätestens bei der Nutzung der Methode geht die Übersicht verloren (und das obwohl die Reihenfolge der Parameter sich hier einfach ableiten lässt):

$obj->send('Musterstraße 74', '22041', 'Hamburg', 'Deutschland', 'Musterweg 42', '8471', 'Leibnitz', 'Österreich');

Weiterlesen

Guard Clauses

Oft brauche ich eine Funktion, die mir einen von verschiedenen Faktoren abhängigen Wert zurück liefert. Das folgende Beispiel stammt aus der Berechnung von Bonuspunkten für einen Onlineshop.

public function getCreditPoints()
{
    $points = $this->_getBasisPoints();

    if ($this->_isPayedWithCreditCard()) {
        $points *= 1.1;
    } else if ($this->_isPayedWithPrepayment()) {
        $points *= 1.25;
    }
    return $points;
}

Der Code ist soweit okay, lässt sich aber in einer Hinsicht noch optimieren. Jeder, der sich die Methode anschaut, muss sich sowohl beim if-Block als auch beim elseif-Block merken, was bisher passiert ist. Denn zu dem Zeitpunkt weiß der Leser ja noch nicht, dass mit $points nichts mehr gemacht wird.

Weiterlesen