Refactoring von WordPress-Plugins: Ein kleines Beispiel
Eine der Möglichkeiten, wie WordPress-Plugins entstehen, besteht darin, dass sie, zumindest in meinem Fall, als eine Sammlung von Funktionen beginnen, die verwendet werden, um bei einem bestimmten Zweck für ein bestimmtes Projekt zu helfen. Von da an denken Sie: „Hey, vielleicht findet das jemand anderes nützlich.”
So habe ich es zumindest öfters erlebt.
Aber die Sache ist, dass Sie, bevor Sie es anderen Leuten zum Ausprobieren freigeben, den Prozess der Bereinigung des Codes durchlaufen möchten. Ich spreche auch nicht vom Refactoring von WordPress-Plugins – zumindest noch nicht.
Ich spreche davon, den Code zu nehmen, ihn zu etwas zu bringen, das als WordPress-Plugin funktioniert, und den Code dann möglicherweise umzugestalten.
Refactoring von WordPress-Plugins
Den gesamten Prozess des Refactorings von WordPress-Plugins zu durchlaufen – ganz zu schweigen von einem einzelnen WordPress-Plugin – kann mühsam sein, aber zu teilen, wie man einen Teil eines Plugins umgestaltet, ist etwas, das machbar ist.
Ich werde also ein Beispiel dafür verwenden, wie ich kürzlich etwas verwendet habe (wobei der Code ein wenig abstrahiert ist, damit ich mich nicht die Mühe mache, auf ein bestimmtes Projekt genau einzugehen).
Diagramm der idealen Ausgabe von Optionen.
Bevor ich dies tue, denke ich jedoch, dass es wichtig ist zu teilen, dass sich mein Prozess möglicherweise – oder wahrscheinlich – von Ihrem unterscheidet (da viele von uns unterschiedliche Prozesse haben).
- Entwerfen Sie die Komponente (ja, nicht einmal das vollständige Plugin) in einem Notebook,
- Überlegen Sie sich eine Checkliste der Anwendungsfälle, in denen es bestehen sollte und wann es fehlschlagen sollte,
- Schreiben Sie auf, welche Daten benötigt werden, wie sie benötigt werden und wann sie ignoriert werden sollten
- Konvertieren Sie alles oben Genannte in Code.
Natürlich konvertiere ich nicht alles buchstäblich in Code, aber Sie bekommen die Idee. Die vielleicht prägnanteste Art, es auszudrücken, lautet wie folgt:
- Beginnen Sie mit einer langen Methode, die dem idealen Anwendungsfall dient. Gestalten Sie diesen Code dann so um, dass die Funktionen kleiner sind und Fälle berücksichtigen, in denen das Ergebnis fehlschlagen würde.
Nachdem dies gesagt wurde, könnte der Code folgendermaßen aussehen.
1 Schreiben für den idealen Anwendungsfall
In diesem Beispiel ist der ideale Anwendungsfall, wenn der Benutzer die Optionen lädt, die Optionen vorhanden sind und er dann eine Aktion ausführen muss, wenn die Optionen bestimmte Werte haben.
Dieser Teil sollte einfach zu lesen sein, berücksichtigt aber nichts außer dem idealen Pfad durch den Code.
2 Werden Sie ein bisschen defensiv
Als nächstes möchte ich sicherstellen, dass die Optionen eingestellt sind, bevor ich versuche, sie zu lesen. In einigen Fällen möchten Sie möglicherweise einen Hinweis anzeigen, eine Ausnahme auslösen oder Informationen protokollieren.
In diesem Beispiel werde ich einfach darauf zurückkommen, da es einfach zu lesen ist und am einfachsten für Ihre Verwendung angepasst werden kann.
Das behandelt also die Optionen, aber was ist, wenn die Optionen gesetzt sind, aber nicht die Werte haben, die wir erwarten? Das bedeutet, dass wir dies auch überprüfen müssen. Und wenn nicht, ignorieren Sie sie, kehren Sie zurück, protokollieren Sie einen Fehler, lösen Sie eine Ausnahme aus und so weiter.
Sie wissen: Das Gleiche wie oben. Nur werde ich in diesem Fall nichts unternehmen, es sei denn, der Code enthält die ideale Information.
3 Etwas langatmig werden
An diesem Punkt wird die Methode etwas langatmig und schwieriger zu lesen. Sicher, wenn Sie ein erfahrener Programmierer sind, können Sie sagen: „Das ist Code, es ist kein Englisch”, aber warum sollten Sie nicht darauf abzielen, es ein bisschen einfacher zu machen?
Außerdem macht es das Testen etwas einfacher. Aber das würde den Rahmen dieses Beitrags sprengen. Nehmen Sie die Optionsauswertung als erstes Beispiel des Codes.
- Dies ist etwas, das in seiner Funktion verpackt werden kann, die nicht nur diese Prüfung isoliert, sondern auch den resultierenden Aufruf etwas einfacher macht.
- Nehmen Sie als Nächstes den zweiten Codeblock, der nach den idealen Optionswerten sucht. Dies kann auch aus den gleichen Gründen oben abstrahiert werden.
- Richten Sie schließlich eine Funktion ein, um sicherzustellen, dass die erwarteten Werte für jeden der angegebenen Werte festgelegt werden :
Jetzt haben Sie also zwei kleinere Methoden, die dieselbe Prüfung kapseln, die Sie gemacht haben.
4 Die letzte Funktion
An diesem Punkt ist die letzte Funktion viel einfacher zu lesen, da sie zwei Hilfsfunktionen hat, die ihre Verantwortlichkeiten kapseln, während diese wieder den idealen Pfad durch den Code auswertet:
Es genügt zu sagen, dass dies beim Refactoring von WordPress-Plugins nur ein Beispiel dafür ist, wie man nur einen Teil davon macht. Aber es ist ein Anfang, oder?
Ganze Plugins?
Ich weiß es schon gut? Das Refactoring von WordPress-Plugins ist kein Scherz. Aber wenn man mit kleinen Funktionen wie dieser anfängt und sich nach und nach um die Codebasis herumarbeitet, wird es einfacher.
Und wenn Sie Zeit damit verbringen, das Projekt von Anfang an zu planen, kann es viel Zeit sparen, wenn Sie zurückgehen und diese Art von Dingen umgestalten.