Lernseite · Software-Architektur und Entwurfsmuster
Gut gebauter Code: Architektur, Muster und Tests in TYPO3
Wohin gehört ein Stück Code? Auf dieser Seite wächst unsere Extension my_extension für Konferenzen Schritt für Schritt. Du lernst MVC, das Repository, Domain-Driven Design, Entwurfsmuster und SOLID kennen. Danach geht es um wiederkehrende Aufgaben, Tests und drei kleine Datenstrukturen aus dem Core.
Drei Rollen: Model, View, Controller
MVC steht für Model-View-Controller. Das Muster teilt eine Anwendung in drei Rollen:
- Das Model hält die Daten und die Geschäftslogik. Bei uns ist das die Klasse
Conferencemit Eigenschaften wie Titel und Datum. Das Model kennt weder Controller noch View. - Die View stellt die Daten dar. In Extbase übernehmen das die Fluid-Templates.
- Der Controller nimmt die Anfrage an und wertet die Argumente aus. Er ruft Model, Repository oder Services auf, übergibt das Ergebnis an die View und gibt eine Antwort zurück, etwa HTML oder eine Weiterleitung.
In Extbase liegen die Modelle im Ordner Classes, Domain, Model und die Controller im Ordner Classes, Controller. So tauschst du ein Template aus, ohne die Logik anzufassen.
Ein Controller soll schlank bleiben. Er vermittelt nur. Geschäftsregeln gehören in Model und Services, Datenbankabfragen ins Repository.
Repository und Domain-Driven Design
Ein Repository ist die zentrale Stelle, um Objekte einer Art zu suchen und zu speichern. Es verhält sich wie eine Sammlung. Martin Fowler beschreibt es als Vermittler zwischen der Domäne und der Datenabbildung. Die Geschäftslogik weiß nicht, wie die Abfrage technisch läuft. Für Tests ersetzt du ein Repository leicht durch eine Attrappe.
Jedes Extbase-Repository erbt von der Klasse Repository. Es bringt fertige Methoden mit, etwa findAll(), findByUid(), findBy(), add(), update() und remove(). Eigene Abfragen bekommen sprechende Namen. Holt ein Controller kommende Konferenzen einer Stadt mit einem eigenen QueryBuilder-Aufruf, gehört diese Abfrage in eine Methode wie findUpcomingByCity() im ConferenceRepository.
Domain-Driven Design, kurz DDD, richtet die Software am Fachgebiet aus. Die wichtigsten Begriffe:
- Ubiquitous Language ist die gemeinsame Fachsprache von Fachleuten und Entwicklern. Ihre Wörter tauchen direkt in Klassen und Methoden auf.
- Ein Bounded Context ist ein abgegrenzter Bereich, in dem diese Sprache eindeutig gilt.
- Eine Entity hat eine eigene Identität. Zwei Teilnehmer mit gleichem Namen bleiben zwei verschiedene Personen. In Extbase erkennt man sie an der
uid. - Ein Value Object wird nur durch seine Werte bestimmt. Zwei gleiche Adressen sind gleich. Es hat keine Identität und ist unveränderlich.
- Ein Aggregate ist eine Gruppe von Objekten, die als Einheit gilt. Seine Aggregate Root ist der einzige Zugang.
Ein Repository gibt es je Aggregate Root. Eine Bestellung mit ihren Positionen bekommt also ein OrderRepository, aber keines für die Positionen. Positionen fügst du nur über die Bestellung hinzu, damit die Gesamtsumme immer stimmt.
Entwurfsmuster im Alltag
Ein Entwurfsmuster ist eine bewährte Lösungsidee für ein wiederkehrendes Entwurfsproblem. Es ist keine Bibliothek und kein fertiger Code. Du passt es an deine Lage an. Ist das Problem einfach, bringt ein Muster nur zusätzliche Abstraktion. Dann lässt du es weg.
Im TYPO3 Core findest du viele Muster:
- Observer: Beobachter melden sich für ein Ereignis an und werden benachrichtigt. So verteilt der EventDispatcher ein PSR-14-Event an alle Listener.
- Chain of Responsibility: Jede Middleware im PSR-15-Stack bearbeitet die Anfrage oder reicht sie weiter.
- Factory: Eine Factory entscheidet, welches konkrete Objekt entsteht. Beispiele sind die ResponseFactory nach PSR-17 oder eine eigene Methode
createExporter(), die je nach Format den passenden Exporter liefert. - Decorator: Eine Klasse mit derselben Schnittstelle umhüllt ein Objekt und ergänzt sein Verhalten. Ein Caching-Repository fragt zuerst den Cache und erst dann das echte Repository. Der Aufrufer merkt davon nichts.
- Strategy: Jede Variante steckt in einer eigenen Klasse mit gemeinsamer Schnittstelle.
Active Record nutzt TYPO3 nicht. Datensätze schreibst du über Repositories, den DataHandler oder den QueryBuilder.
Der Builder setzt ein komplexes Objekt Schritt für Schritt zusammen und liefert am Ende das Ergebnis. Statt eines Konstruktors mit vielen optionalen Parametern setzt du die Teile einzeln. Der QueryBuilder baut so eine Abfrage aus Aufrufen wie select(), from() und where(). Weitere Builder sind der UriBuilder von Extbase und der UriBuilder des Backends. ConnectionPool und CacheManager sind dagegen keine Builder, sie liefern fertige Objekte aus.
Ein Builder sammelt Zustand. Benutzt du ihn ein zweites Mal, stecken die alten Einstellungen noch drin. Darum holst du für jede Abfrage einen frischen QueryBuilder. Den UriBuilder im Extbase-Controller setzt du vor jedem neuen Link mit reset() zurück. Sonst landet zum Beispiel die Zielseite des ersten Links auch im zweiten.
$uri = $this->uriBuilder
->reset()
->setTargetPageUid(12)
->uriFor('show', ['conference' => $conference]);Die SOLID-Prinzipien
SOLID fasst fünf Prinzipien von Robert C. Martin zusammen. Sie sollen Code wartbar und erweiterbar machen.
- S wie Single Responsibility: Eine Klasse hat genau eine Aufgabe und nur einen Grund zur Änderung. Eine Klasse, die Mails sendet, Logs schreibt und Rechnungen berechnet, verletzt das.
- O wie Open-Closed: Klassen sind offen für Erweiterung, aber geschlossen für Änderung. Neue Fälle kommen als neue Klassen hinzu. Auch PSR-14-Events folgen dieser Idee, denn sie ergänzen Verhalten, ohne den Core zu ändern. Vererbung ist dabei nicht verboten.
- L wie Liskov Substitution: Eine Unterklasse muss überall funktionieren, wo die Oberklasse erwartet wird. Ein Quadrat als Unterklasse eines Rechtecks, das bei verschiedener Breite und Höhe eine Exception wirft, bricht diese Regel.
- I wie Interface Segregation: Lieber mehrere kleine Schnittstellen als eine große. Muss ein JSON-Exporter leere Methoden für CSV, PDF und XML füllen, ist die Schnittstelle zu groß.
- D wie Dependency Inversion: Klassen hängen von Abstraktionen ab, nicht von konkreten Klassen.
Ein Beispiel für Dependency Inversion: Unser InvoiceService erzeugt im Konstruktor mit new einen SmtpMailer. Besser nimmt er ein MailerInterface per Dependency Injection an. Dann kommt die konkrete Klasse von außen, und im Test setzt du eine Attrappe ein. Ein Aufruf von GeneralUtility::makeInstance() statt new ändert an der festen Abhängigkeit nichts.
Für Open-Closed nimmt man oft eine Strategie. Bisher wählt unser Checkout die Zahlungsart mit einem switch. Jede neue Zahlungsart ändert diese Klasse. Stattdessen bekommt jede Zahlungsart eine eigene Klasse mit dem PaymentProviderInterface. Ein Tag am Interface sammelt alle Klassen ein.
#[AutoconfigureTag('myext.payment')]
interface PaymentProviderInterface { /* ... */ }
final class CheckoutService
{
public function __construct(
#[AutowireIterator('myext.payment')] private iterable $providers,
) {}
}Eine neue Zahlungsart, auch aus einer anderen Extension, kommt nun ohne Änderung am Service hinzu. Einen switch in eine statische Methode auszulagern, hilft dagegen nicht.
Konvention und Metaprogrammierung
Convention over Configuration heißt: Konventionen ersetzen Einstellungen, solange du nicht abweichst. Erst wer abweicht, muss etwas festlegen. TYPO3 hat viele solche Konventionen:
- Extbase findet das Template einer Action über Controller- und Action-Namen. Für die Action show im
ConferenceControllerist das die Datei Show im Ordner Templates, Conference. - Ein Layout mit dem Namen Default sucht Extbase im Ordner Layouts unter Resources, Private. Partials liegen im Ordner Partials daneben. Andere Orte setzt du über
layoutRootPathsundpartialRootPaths. - Zum Model
Conferencegehört das RepositoryConferenceRepositoryim Ordner Domain, Repository. - Die Tabelle eines Models wird aus Extension-Name und Klassenname gebildet.
Resources/Private/Templates/Conference/Show.fluid.html
Resources/Private/Layouts/Default.html
tx_myextension_domain_model_conferenceDer Vorteil: weniger Boilerplate und ein einheitlicher Aufbau über Projekte hinweg. Der Nachteil: Wer die Konventionen nicht kennt, hält das Verhalten für Magie. Abweichungen brauchen zusätzliche, teils versteckte Konfiguration, etwa in der Datei Classes.php unter Configuration, Extbase, Persistence.
Die zweite Idee dieses Abschnitts heißt Metaprogrammierung. Sie ist Code, der anderen Code erzeugt, untersucht oder zur Laufzeit verändert. Statt vieler gleichförmiger Klassen genügt eine Beschreibung. So sparst du wiederholten Code. Getestet werden muss das Ergebnis trotzdem.
Typische Techniken in PHP:
- Mit Reflection liest du Attribute einer Klasse oder Methode aus und reagierst darauf.
- Die magische Methode
__call()fängt Aufrufe von Methoden ab, die es gar nicht gibt. - Proxy-Klassen und anderer Code werden zur Build-Zeit erzeugt.
In TYPO3 liest Extbase das Attribut Validate per Reflection. Der Symfony-Container wird beim Kompilieren als PHP-Code erzeugt und gecacht. Eine einfache Schleife oder eine Typdeklaration ist dagegen keine Metaprogrammierung.
$attributes = (new \ReflectionMethod($class, $method))->getAttributes(Exportable::class);
foreach ($attributes as $attribute) {
$exportable = $attribute->newInstance();
}Single Table Inheritance
Unsere Konferenz hat Vorträge und Workshops. Beide sind Unterklassen von Session und liegen in einer gemeinsamen Tabelle. Das nennt man Single Table Inheritance. Ein Typfeld in jeder Zeile sagt, welche Klasse ein Datensatz ist.
Im TCA nennt die Einstellung type im Bereich ctrl das Typfeld. Sein Wert bestimmt den Satztyp und damit die Felder im Backend. Der Core macht es genauso. Die Tabelle tt_content nutzt das Typfeld CType, die Tabelle pages das Feld doktype.
Extbase ordnet die Typen in der Datei Classes.php den Klassen zu. Die Oberklasse nennt ihre Unterklassen unter subclasses. Jede Unterklasse nennt ihren Wert im Typfeld unter recordType und ihre Tabelle unter tableName. Ein eigenes Attribut dafür gibt es nicht.
return [
Session::class => [
'subclasses' => ['talk' => Talk::class, 'workshop' => Workshop::class],
],
Talk::class => ['tableName' => 'tx_myextension_domain_model_session', 'recordType' => 'talk'],
Workshop::class => ['tableName' => 'tx_myextension_domain_model_session', 'recordType' => 'workshop'],
];Der Vorteil: Abfragen über alle Typen sind einfach und schnell, denn es gibt keine JOINs. Die Nachteile: Viele Spalten bleiben je nach Typ leer. Und eine Spalte kann nicht für alle Typen als NOT NULL gelten, wenn nur ein Typ sie braucht.
Wiederkehrende Aufgaben
Jede Nacht importiert my_extension Konferenzen aus einem fremden System. Dafür gibt es einen eigenen Konsolenbefehl. Das Attribut AsCommand macht ihn bekannt, plant ihn aber nicht ein. Für das regelmäßige Ausführen gibt es zwei Wege:
- Im Scheduler legst du eine Aufgabe vom Typ „Execute console commands“ an. Du wählst den Befehl und das Intervall. Ein Cronjob auf dem Server startet regelmäßig den Befehl scheduler run. Der Scheduler entscheidet dann, welche Aufgaben fällig sind.
- Oder ein Cronjob ruft den Symfony-Befehl direkt auf.
*/5 * * * * /var/www/html/vendor/bin/typo3 scheduler:runCode in der Datei ext_localconf.php oder ein Plugin, das bei jedem Seitenaufruf die Aufgabe startet, ist dafür ungeeignet.
Damit solche Aufgaben zuverlässig laufen, gelten ein paar Regeln:
- Der Import ist idempotent. Mehrfaches Ausführen führt zum selben Ergebnis. Er gleicht Datensätze über eine externe Kennung ab und legt keine Dubletten an. Ein Neustart nach einem Abbruch ist so gefahrlos.
- Ein Lock verhindert, dass sich zwei Läufe überschneiden.
- Ergebnisse und Fehler werden protokolliert und überwacht. Fehler unterdrückst du nicht.
- Große Datenmengen verarbeitest du in Paketen, damit Laufzeit und Speicher reichen. Bündle nicht alles in einer einzigen riesigen Aufgabe.
Software testen
Drei Testarten ergänzen sich:
- Unit-Tests prüfen eine einzelne Klasse für sich, ohne Datenbank. Sie laufen sehr schnell.
- Functional-Tests prüfen das Zusammenspiel mit Datenbank und Framework.
- Acceptance-Tests prüfen die Anwendung aus Sicht der Nutzer im Browser. Sie sind am langsamsten.
Das TYPO3 Testing Framework bindest du über das Composer-Paket typo3/testing-framework ein, als Entwicklungsabhängigkeit und nicht für Kunden. Es baut auf PHPUnit auf und ersetzt es nicht. Unit-Tests erben von UnitTestCase, Functional-Tests von FunctionalTestCase. Akzeptanztests laufen im Core mit Codeception.
Testbarer Code erzeugt seine Abhängigkeiten nicht selbst mit new. Sonst kannst du sie nicht durch Attrappen ersetzen. Mit Dependency Injection übergibt der Test einen Stub oder einen Mock:
- Ein Stub liefert nur vorgegebene Werte. Du baust ihn mit der statischen Methode
createStub(). - Ein Mock prüft zusätzlich, wie er aufgerufen wird. Du baust ihn mit
createMock()und legst etwa fest, dass die Methode send des Mailers genau einmal aufgerufen wird. Ein Mock ohne Erwartungen führt in PHPUnit 13 zu einem Hinweis, nimm dann einen Stub.
$repository = self::createStub(ConferenceRepository::class);
$repository->method('findUpcoming')->willReturn([$conference]);
$mailer = $this->createMock(MailerInterface::class);
$mailer->expects($this->once())->method('send');Mehrere Eingaben gibst du mit einem Data Provider an. In PHPUnit 13 steht das Attribut DataProvider mit dem Namen der Provider-Methode am Test. Die Provider-Methode ist public und static. Annotationen im DocBlock ignoriert PHPUnit seit Version 12. Jeder Datensatz läuft als eigener Test. Eine Schleife in einem einzigen Test bricht dagegen beim ersten Fehler ab.
Exceptions: Rufe expectException() vor dem Aufruf auf, der die Exception werfen soll. Danach wäre es zu spät, denn die Exception beendet den Test. Mit expectExceptionCode() prüfst du zusätzlich den Code.
Functional-Tests setzen eine eigene TYPO3-Instanz mit eigener, frischer Testdatenbank auf. Eigene Extensions trägst du in die Eigenschaft testExtensionsToLoad ein, System-Extensions wie den Scheduler in coreExtensionsToLoad. Ausgangsdaten lädst du mit importCSVDataSet() aus einer CSV-Datei. Das Ergebnis vergleichst du mit assertCSVDataSet() mit einer erwarteten CSV-Datei.
protected array $testExtensionsToLoad = ['my-vendor/my-events'];
#[Test]
public function importCreatesRecords(): void
{
$this->importCSVDataSet(__DIR__ . '/Fixtures/Import.csv');
$this->get(ConferenceImporter::class)->run();
$this->assertCSVDataSet(__DIR__ . '/Fixtures/ImportResult.csv');
}Kleine Datenstrukturen im Core
BitSet speichert mehrere Ja-oder-Nein-Optionen in einer einzigen Ganzzahl. Jedes Bit steht für eine Option, etwa ein Recht. Statt von Hand mit Bit-Operatoren zu rechnen, nutzt du set(), unset() und get(). Diese Methoden erwarten den Wert des Bits, also 1, 2 oder 4, nicht seine Position. Die Methode __toInt() liefert die Zahl zurück.
$bits = new BitSet(0b011); // 3
$bits->unset(0b001); // 0b010 = 2
$bits->set(0b100); // 0b110 = 6Für sprechende Rechte erweiterst du die Klasse. Eine Klasse Permissions erbt von BitSet, benennt die Bits mit Konstanten und bietet eine Methode wie isGranted(), die intern get() aufruft. Ein eigenes Interface für BitSets gibt es nicht. Zwei Nachteile solltest du kennen. Die Zahl der Optionen ist durch die Größe einer PHP-Ganzzahl begrenzt, also 64 Bit. Und der gespeicherte Zahlenwert ist ohne die Bedeutung der Bits schwer lesbar.
Map ist eine Zuordnung, die auch Objekte als Schlüssel erlaubt. PHP bietet dafür zwar WeakMap, aber dort verschwindet ein Eintrag, sobald das Schlüsselobjekt sonst nirgends mehr gebraucht wird. SplObjectStorage liefert bei foreach aus alten Gründen den Schlüssel als Wert. Die Map von TYPO3 vermeidet beides und liefert Schlüssel und Wert korrekt.
TypeInterface verlangt von einer Klasse nur die Methode __toString(). So lässt sich der Wert als Zeichenkette verwenden. Extbase kann Werte aus dem Request per Type Converter in solche Typen umwandeln.
Das Wichtigste in Kürze
- Model hält Daten und Geschäftslogik, View stellt dar, Controller vermittelt und bleibt schlank.
- Ein Repository je Aggregate Root kapselt Suche und Speicherung, eigene Abfragen bekommen sprechende Namen.
- Value Objects sind unveränderlich, eine Änderung erzeugt ein neues Objekt.
- Builder sammeln Zustand, darum frischer QueryBuilder und
reset()am UriBuilder. - SOLID: eine Aufgabe je Klasse, offen für Erweiterung, Unterklassen ersetzbar, kleine Schnittstellen, Abhängigkeit von Abstraktionen.
- Single Table Inheritance: ein Typfeld im TCA, die Zuordnung in der Datei
Classes.php. - Wiederkehrende Aufgaben laufen über Scheduler und Cronjob, sind idempotent und gegen Überschneidung gesperrt.
- Stub liefert Werte, Mock prüft Aufrufe,
expectException()steht vor dem Aufruf. - BitSet rechnet mit Bitwerten, nicht mit Positionen.
Begriffe
- Aggregate Root
- Einziger Zugang zu einer Gruppe zusammengehöriger Objekte.
- Bounded Context
- Abgegrenzter Bereich, in dem eine Fachsprache eindeutig gilt.
- Decorator
- Hülle mit derselben Schnittstelle, die Verhalten ergänzt.
- Entity
- Objekt mit eigener Identität.
- Idempotent
- Mehrfaches Ausführen ergibt dasselbe Ergebnis wie einmaliges.
- Mock
- Attrappe, die prüft, wie sie aufgerufen wird.
- Stub
- Attrappe, die nur vorgegebene Werte liefert.
- Value Object
- Unveränderliches Objekt ohne Identität, bestimmt durch seine Werte.