Aufteilung eines großen Laravel Livewire Components – Teil 1

In diesem Blogbeitrag erfährst du, wie du Livewire-Komponenten effektiv aufteilst, Views und Validierungsregeln strukturierst und Sub-Komponenten wiederverwendest. Optimiere deine Livewire-Entwicklung mit bewährten Best Practices. Bleib dran!

Manchmal, egal welche Lösung du zur Entwicklung deines Systems verwendest, kommt der Punkt, an dem alles etwas zu groß wird und unübersichtlich zu werden droht. Zum Glück bietet Livewire eine Lösung für dieses Problem.

Was ist Livewire?

Laravel Livewire bietet eine Möglichkeit, dynamische Benutzeroberflächen zu erstellen. Anstatt einer JavaScript-Bibliothek wie Vue oder React erlaubt es Entwicklern, ihren Code in PHP-Komponenten und Blade-Templates zu schreiben. Es ist fantastisch. Ich nutze es bereits im vielen Projekten. Wenn du es noch nicht ausprobiert hast, empfehle ich dir, es einmal anzuschauen.

Was ist das Problem?

Oftmals beinhalten Tutorials und Beispiele nur den Aufbau kleiner Komponenten, wie z.B. eines Kontaktformulars oder einer To-Do-Liste. Das ist vollkommen in Ordnung, da es ermöglicht, den Aufbau von Anfang bis Ende zu zeigen. Doch in einem Projekt aus dem wahren Leben hat man oft mit großen und sehr komplexen Systemen zu tun und erhalten hier dann kundenspezifische Anforderungen die umgesetzt werden sollen.

Nehmen wir als Beispiel eine Website zur Buchung von Mietwagen für den Urlaub. Bei der Buchung müssen Kundendetails wie Name und Adresse, der gewünschte Fahrzeugtyp sowie Extras wie zusätzliche Versicherungen oder sogar Hotelreservierungen erfasst werden.

Eine Herangehensweise wäre die Erstellung einer einzigen großen Komponente mit der gesamten Logik und einer einzelnen Ansichtsdatei, die immer länger wird. Das funktioniert wahrscheinlich gut, aber es gibt Tools, mit denen man diese Aufgabe in überschaubare Abschnitte aufteilen kann.

Die Aufteilung der Komponentenklasse mit Traits

Livewire v2 bietet eine großartige Funktion von PHP namens Traits, mit der man eine Datei erstellen kann, die innerhalb einer Klasse verwendet wird und der Klasse die Methoden und Eigenschaften des Traits zur Verfügung stellt. Dadurch kann man die Logik auf mehrere kleinere und besser handhabbare Dateien aufteilen und sie in der Hauptkomponente wiederverwenden.

Wenn wir zu unserem Beispiel der Mietwagenbuchung zurückkehren, benötigen wir möglicherweise ein Trait, das unsere Methoden zum Abrufen von Fahrzeugdaten enthält, ein weiteres Trait für Standortinformationen wie Adressen oder ein Trait zur Speicherung der Kundendetails.

Aber Livewire-Traits gehen sogar noch weiter.

Neben der Definition eigener Methoden können wir auch eine Namenskonvention verwenden, um uns in die Livewire-Lifecycle-Hooks einzuklinken. Wir haben gesagt, dass wir ein Trait erstellen werden, das sich auf Fahrzeuginformationen konzentriert, aber wie machen wir diese Daten für den Rest der Komponente verfügbar? Wir könnten eine Methode aus der mount-Methode der Hauptkomponentenklasse aufrufen, aber wir könnten dies auch im Trait selbst tun, indem wir die mount-Methode des Traits verwenden.

Wenn unser Trait „VehicleInformation“ heißt, können wir eine Methode „mountVehicleInformation“ in unserem Trait erstellen, in der wir die Fahrzeugdaten einer öffentlichen Variable zuweisen. Dadurch stehen sie der Hauptkomponente zur Verfügung.

Aus dem obigen Beispiel können wir sowohl in der Hauptkomponentenklasse mit $this->vehicles als auch in der Blade-View mit $vehicles auf die Fahrzeugdaten zugreifen.

Eine weitere Herausforderung bei der Entwicklung großer Livewire-Komponenten besteht darin, die Views und Validierungsregeln zu verwalten. Um die Code-Wartbarkeit und die Wiederverwendbarkeit zu verbessern, können wir auch hier auf die Aufteilung setzen.

Zusätzlich können wir Sub-Komponenten erstellen, um bestimmte Funktionen oder Abschnitte unserer Hauptkomponente zu modularisieren.

In meinem nächsten Beitrag werde ich detailliert darauf eingehen, wie wir dies auch erreichen können. Sobald dieser Beitrag fertig ist, werde ich hier einen Link bereitstellen, damit ihr ihn lesen könnt.

Bleibt gespannt und freut euch auf weitere Tipps und Tricks zum effizienten Entwickeln mit Livewire!

Mein Rückblick auf das Jahr 2022

Wie jedes Jahr, schreibe ich in den letzten Wochen des Jahres immer ein kurzes Review über das vergangene Jahr. Dies ist besonders für mich immer interessant, da ich mir wirklich bewusst nochmal Gedanken dazu mache, was gut oder schlecht gelaufen ist. Aber durch den Beitrag hier erhaltet ihr auch einen Einblick und vielleicht ein wenig Inspiration.

Gerade nutze ich die Zeit diesen Beitrag zu schreiben, auf dem Weg nach Köln zur diesjährigen Firmenveranstaltung. Es ist auch was besonderes dieses Jahr. Denn Tricept feiert den 22. Geburtstag. Darum sind neben den Mitarbeiterinnen und Mitarbeiter auch z.B. Kunden eingeladen. Auch für mich ist es dieses Jahr etwas besonderes. Denn ich bin nun auch schon seit 10 Jahren bei Tricept mit dabei.

Als ich vor 10 Jahren meine Ausbildung zum Fachinformatiker in der Anwendungsentwicklung angefangen habe, hätte ich nie gedacht so lange hier zu bleiben. Da ich zuvor eine Ausbildung zum Koch absolviert hatte, kannte ich viele Kollegen die oft nur wenige Jahre oder gar Monate in einem Betrieb gearbeitet haben.

Doch nicht bei Tricept. Nach meiner Ausbildung wurde ich übernommen und die Projekte und Aufgaben wurden immer vielfältiger und spannender. Natürlich aber auch fordendern und anspruchsvoller. Wenn ich zurück auf die letzten gut 8 Jahre blicke, die ich hauptsächlich im Bereich für Phoenix II gearbeitet habe, ist es wirklich erstaunlich was wir für ein tolles Produkt entwickelt haben und was ich auch alles dazu beitragen konnte.

Mittlerweile ist mein Beruf wirklich viel mehr als nur das reine Arbeiten. Es ist meine Berufung. Ich stecke neben der Arbeit auch in meiner Freizeit wirklich sehr viel Zeit in private Projekte und das Kennenlernen von neuen Funktionen, Packages oder Technologien. Dies ist auch der Grund, warum ich Tools wie Sitealarm.de, Zhylon.de oder meinen URL-Shortener entwickelt habe und auch ständig weiter am laufen halte.

Dieses Jahr war geprägt von vielen Änderungen. Auch durch einen Umzug in Sommer, musste ich viele Gewohnheiten umstellen und die neue Umgebung auf mich einwirken lassen. Insgesamt hatte ich dieses Jahr recht wenig Zeit in private Projekte gesteckt. Erst jetzt so gegen Ende Oktober gelingt mir es wieder besser.

Insgesamt glaube ich aber, dass ich meine privaten Ziele gut eingehalten habe und auch einige Projekte weiterentwickeln konnte. Ich habe mir ja extra nicht zu viel vorgenommen. Etwas schade finde ich jedoch weiterhin, dass ich viel zu wenig hier auf meinem Blog schreibe oder auf Twitter poste. Das werde ich vermutlich dann nächstes Jahr angehen.

Technologisch habe ich noch intensiver mit ClodFlare beschäftigt. Habe hier z.B. die Zero Trust Technology angesehen. Auch im Bereich Server Management im Bezug auf Zhylon habe ich einiges neues gelernt. Und mein Projekt Management Tool ist mittlerweile soweit ausgereift, dass es schon einige Bekannte als echte Lösung verwenden.

Ich hoffe das nächste Jahr geht genau so gut weiter wie es aktuell läuft. Noch etwas mehr Zeit für die Familie und vielleicht auch weiterhin mehr Bewegung durch Fitness.

Ich empfehle dir auch Mal auf die freien Stellen bei Tricept mal zu schauen. Wenn sich die Digitalisierung interessiert und eine Ausschreibung auf dich zu trifft, dann bewerbe dich gerne bei der Tricept.

Nun heißt es anpacken und die letzten Wochen des Jahres noch super abschließen.

Laravel Livewire – From Scratch

Livewire ist mittlerweile zu einem sehr populären Tool geworden, wenn es darum geht eine Laravel Anwendung zu programmieren. Livewire unterstützt vor allem die typischen Backendentwickler darin, UI/UX für den Anwender deutlich zu bessern, ohne dabei auf typische Merkmale von Laravel zu verzichten.

Wer Livewire noch nie verwendet hat, sollte dies schnell mal ändern. Die Dokumentation ist sehr umfangreich und Livewire bietet sogar selbst einige Screencasts, um schneller die Verwendung zu verstehen.

Wer aber mal genau wissen möchte, was Livewire alles im Hintergrund macht und was eigentlich alles zu beachten ist, der schaut sich am besten mal eines der neusten Laracasts Videos von Caleb Porzio (@calebporzio) an. Hier wird in mehreren Videos eine minimal Version von Livewire nachgebaut.

Hier der Link: https://laracasts.com/series/livewire-uncovered

Verschlüsselung der .env Datei

In modernen Anwendungen wie z.B. Laravel, werden häufig „.env“ Dateien verwendet, um Zugangsdaten für die Datenbanken, API-Token oder andere Zugangsschlüssel zu speichern (siehe https://dotenv.org/). Dies hat den Vorteil, dass diese nicht im Quellcode der Anwendung hinterlegt werden müssen und so an einer zentralen Stelle gespeichert werden. Außerdem kommen sie so nicht in die Versionskontrolle wo sie ggf. von Personen außerhalb des Projektes gelesen werden könnten.

Sobald ein neuer Wert in dieser Datei hinterlegt wird, muss dieser auch bei allen Entwickler im Team hinterlegt werden oder in die produktive Umgebung eingespielt werden. Gerade wenn es hierfür keinen richtigen Prozess gibt, wie die Zugangsdaten dann verteilt werden, könnte dies wieder unsicher übertragen werden. Vielleicht wird hier eine Rundmail geschrieben oder mit einer Message via Slack, Teams oder gar in WhatsApp verschickt. Und sollten sich die Werte auch nicht in Produktion automatisch oder per Deployment aktualisieren, dann muss hier auch immer händisch noch der richtige Wert hinterlegt werden.

Eine Lösung hierfür kommt von Dotenv selbst und bietet eine Synchronisierung. Doch wer Kosten sparen möchte oder eine Cloud Lösung nicht in Frage kommt, der steht wieder vor dem Ausgangsproblem.

Darum habe ich ein kleines Package gebaut, mit dem man die .env Datei sicher im Repository hinterlegen kann, ohne das es hier zu Bedenken der Sicherheit kommt. Mit dem Package lässt sich die lokale .env Datei sicher verschlüsseln und damit auch in das Repository einchecken. Andere Personen im Team können diese dann auschecken und dann wieder entschlüsseln. Das gleiche geht auch für die produktive Umgebung. So muss nur noch der geheime Schlüssel bekannt sein, welcher nur für ausgewählte Personen im Team bekannt ist.

Das Package findest du wie immer bei GitHub. Es befindet sich noch in der aller ersten Version: https://github.com/TobyMaxham/laravel-envcrypter

Sitealarm: Self hosted Checks

Wir haben ein wirklich cooles neues Feature in unsere Sitealarm App integriert. Es gibt nun die Möglichkeit, eigene Checks zu definieren und diese über unsere API abfragen zu lassen.

Sitealarm kann genutzt werden, um den Status deiner Website zu überprüfen, die SSL Zertifikate zu überwachen und deine regelmäßigen Jobs auf Ausführung zu beobachten. Doch was ist eigentlich mit Serverseitigen Prozessen, auf die Sitealarm keinen Zugriff hat. Wie kann z.B. der Status der Datenbanken oder ob noch genügend freier Disk Space vorhanden ist?

Unser neuer Monitor ruft regelmäßig einen bestimmten Endpunkt bei dir auf und prüft die Antwort deines Systems. Dabei muss kein Skript auf deinem Server von uns installiert werden und wir benötigen auch keinen Zugriff auf deinen Server. In der Rückmeldung von deinem System sind dann die einzelnen Services aufgeführt und haben einen entsprechenden Status. Mehr dazu findest du auch in unserer Dokumentation.

Die Prüfung deiner Services übernimmst du also selbst. Wir validieren dann das Ergebnis und informieren dich, sollte etwas nicht stimmen oder dein Endpunkt nicht erreichbar sein. Es gibt fünf verschiedene Status Typen: ok, warning, crashed, failed und skipped.

Je nach Status bzw. vorherigem Status senden wir dir dann eine entsprechende Mitteilung über den hinterlegten Notification Channel. So verpasst du nie wieder, wenn ein Service in deiner Infrastruktur nicht mehr ordnungsgemäß funktioniert.

I’m nächsten Schritt wollen wir ein Package entwickeln, welches du in deiner Anwendung hinterlegen kannst, damit diese Überwachung automatisch ausgeführt werden kann.