Kopieren Sie den Code nicht nur und fügen Sie ihn ein, sondern machen Sie ihn wiederverwendbar

Hintergrund

Es ist völlig normal, Code aus dem Internet zu kopieren und einzufügen. Tatsächlich gibt es für die meisten Codierungsprobleme, mit denen wir konfrontiert sind – seien es Fehler, Styling-Herausforderungen oder die Notwendigkeit eines eleganten Seitenladers in einfachem CSS – oft Lösungen, die online verfügbar sind. Wir suchen nach Antworten und das Internet bietet eine Fülle von Codeschnipseln und Anleitungen. Natürlich ist es wichtig, diese Lösungen zu filtern und zu überprüfen, um sicherzustellen, dass sie gut zu unseren Anforderungen passen.

Beim Schreiben von Code kann man sich leicht von der Bequemlichkeit des Kopierens und Einfügens von Code mitreißen lassen. Mit der Zeit bemerken wir jedoch möglicherweise, dass unser Code unübersichtlich und schwer zu pflegen geworden ist. Das Muster sieht oft so aus:

1. Wir stoßen auf ein Problem.
2. Suchen Sie online nach einer Lösung.
3. Kopieren Sie den Code, den wir finden.
4. Fügen Sie es in unsere Codebasis ein.
5. Weitermachen.

Wie bereits erwähnt, besteht eine gute Chance, dass wir irgendwann wieder mit denselben Problemen konfrontiert werden. Dieser Zyklus wiederholt sich, und am Ende überdenken und kopieren wir Lösungen erneut, ohne sie wirklich zu integrieren oder zu verstehen (die Herausforderungen, mit denen andere konfrontiert waren, sind jetzt zu unseren eigenen geworden?). Also kehren wir zu Schritt 1: Auf ein Problem stoßen zurück – und der Zyklus geht weiter.

Lösung

Um diesen Teufelskreis zu vermeiden, könnte das DRY-Prinzip die Lösung sein. Das DRY-Prinzip, das für „Don't Repeat Yourself“ steht, ist ein Softwareentwicklungsprinzip, das darauf abzielt, Codeduplizierung und sich wiederholende Muster zu reduzieren. Durch die Anwendung des DRY-Prinzips auf Ihren Code werden repetitiver Code und sich wiederholende Logik durch modularen und referenzierbaren Code ersetzt. Oder in diesem Artikel, um zu vermeiden, dass Sie bei demselben Problem erneut von Schritt 5 zu Schritt 1 zurückkehren.

Sehen wir uns diese Beispiele an:

Verwendung von Funktionen zur Vermeidung von Wiederholungen

Funktion zum Lösen von sich wiederholendem Code. Es ist definitiv falsch, wenn Sie eine Funktion schreiben, aber dennoch sich wiederholenden Code in Ihrer Codebasis belassen.

Wenn Sie feststellen, dass ähnliche Logikblöcke wiederholt werden, wandeln Sie sie in eine wiederverwendbare Funktion um.

// Before

function calculateAreaRectangle(width: number, height: number): number {
    return width * height;
}

function calculateAreaTriangle(base: number, height: number): number {
    return 0.5 * base * height;
}

Erstellen Sie eine Allzweckfunktion zur Flächenberechnung.

// after

function calculateArea(shape: "rectangle" | "triangle", dimension1: number, dimension2: number): number {
    if (shape === "rectangle") return dimension1 * dimension2;
    if (shape === "triangle") return 0.5 * dimension1 * dimension2;
    throw new Error("Invalid shape");
}

// Usage
const rectangleArea = calculateArea("rectangle", 5, 10);
const triangleArea = calculateArea("triangle", 5, 10);

Dienstprogrammfunktionen erstellen

Ich spreche immer noch von Funktionen: Das Erstellen einer Dienstprogrammfunktion ist eine Möglichkeit, sauberen Code zu erhalten. Wenn beispielsweise mehrere Teile Ihres Codes eine Zeichenfolge in die Groß- und Kleinschreibung des Titels umwandeln, extrahieren Sie diese in eine Dienstprogrammfunktion.

// before

let title1 = "hello world".split(' ').map(word => word[0].toUpperCase() + word.slice(1)).join(' ');
let title2 = "good morning".split(' ').map(word => word[0].toUpperCase() + word.slice(1)).join(' ');

Erwägen Sie, eine Funktion zu erstellen, um dieses Problem zu lösen.

// after
function toTitleCase(input: string): string {
    return input.split(' ').map(word => word[0].toUpperCase() + word.slice(1)).join(' ');
}

let title1 = toTitleCase("hello world");
let title2 = toTitleCase("good morning");

Konstanten für gemeinsame Werte

Wie oft rufen Sie eine API auf, die denselben Endpunkt hat? Ich glaube, es ist mehr als einmal.

Wenn bestimmte Werte wie URLs oder Konfigurationsoptionen in Ihrer App verwendet werden, definieren Sie sie einmal als Konstanten.

// Before

function calculateAreaRectangle(width: number, height: number): number {
    return width * height;
}

function calculateAreaTriangle(base: number, height: number): number {
    return 0.5 * base * height;
}

Was passiert, wenn das Backend die URL geändert hat? Wenn Sie diesen Code weiterhin wie im obigen Beispiel schreiben, ändern Sie alle Codes, die die URL enthalten. Wenn Sie den Endpunkt auf eine Konstante verschieben, ist es sinnvoll, dass Sie ihn einmal ändern können und alle API-Aufrufe weiterhin funktionieren, da sie der von Ihnen erstellten Konstante folgen.

// after

function calculateArea(shape: "rectangle" | "triangle", dimension1: number, dimension2: number): number {
    if (shape === "rectangle") return dimension1 * dimension2;
    if (shape === "triangle") return 0.5 * dimension1 * dimension2;
    throw new Error("Invalid shape");
}

// Usage
const rectangleArea = calculateArea("rectangle", 5, 10);
const triangleArea = calculateArea("triangle", 5, 10);

Haben Sie eine andere Idee?

Diese Beispiele sollen nur ein wenig veranschaulichen, wie wichtig es ist, unseren Code auf den Punkt zu bringen und den sich wiederholenden Code nicht immer wieder beizubehalten. Teilen Sie Ihren Gedanken gerne im Kommentarfeld unten mit.

Zusammenfassung

Das DRY-Prinzip (Don't Repeat Yourself) ist eine grundlegende Codierungspraxis, die Entwickler dazu ermutigt, Redundanzen zu vermeiden, indem sie Code wo immer möglich wiederverwendet. Die Anwendung von DRY-Prinzipien kann die Wartbarkeit, Lesbarkeit und Effizienz einer Codebasis erheblich verbessern, da dadurch die Anzahl der Stellen minimiert wird, an denen Änderungen vorgenommen werden müssen, wenn Aktualisierungen erforderlich sind. Beim DRY-Prinzip geht es darum, wiederverwendbaren, wartbaren Code zu erstellen. Durch die Nutzung der Funktionen von TypeScript – wie Funktionen, Generika, Schnittstellen und Aufzählungen – können Sie Ihre Codebasis sauber halten und Redundanz reduzieren.

Das obige ist der detaillierte Inhalt vonKopieren Sie den Code nicht nur und fügen Sie ihn ein, sondern machen Sie ihn wiederverwendbar. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!