Was ist Boilerplate-Code? Konzeptzusammenfassung und Beispiele

Was ist Boilerplate?

• Boilerplate bezieht sich auf die von Zeitungsunternehmen verwendete Metallplatte.
• Zeitungen drucken den gleichen Inhalt wiederholt unter Verwendung von Vorlagen, die bereits auf Metallplatten erstellt wurden.

Boilerplate-Code-Konzept

• Boilerplate-Code bezieht sich auf Code, der jedes Mal, wenn Sie ein neues Projekt starten, wiederholt geschrieben werden muss. Boilerplate-Code ist Code, der an mehreren Stellen auf ähnliche Weise wiederholt wird.
• Dazu gehört beispielsweise das Erstellen der Projektstruktur, das Initialisieren von Einstellungen, das Laden von Bibliotheken usw. Alternativ bezieht es sich auf Code, der wiederholt geschrieben werden muss, wenn eine bestimmte Funktion implementiert wird, beispielsweise eine Getter- und Setter-Methode.

Boilerplate-Codebeispiel

• Boilerplate-Code kann in verschiedenen Sprachen vorkommen.
• Ein Beispiel für Code, der in Java als Boilerplate verwendet wird, ist wie folgt:
  • Getter- und Setter-Methode
  • equal() und hashCode() Methode
  • toString()-Methode
  • Konstruktormethode
• Die oben genannten Codes müssen jedes Mal wiederholt geschrieben werden, wenn eine neue Klasse erstellt wird.

// 1. Getter & Setter Method
public class Person {
    private String name;
    private int age;

    // Getter Method
    public String getName() {
        return name;
    }

    // Setter Method
    public void setName(String name) {
        this.name = name;
    }

    // Getter Method
    public int getAge() {
        return age;
    }

    // Setter Method
    public void setAge(int age) {
        this.age = age;
    }
}

// 2. equals() and hashCode() Method
public class Person {
    private String name;
    private int age;

    // equals() Method
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Person person = (Person) o;
        return age == person.age && Objects.equals(name, person.name);
    }

    // hashCode() Method
    @Override
    public int hashCode() {
        return Objects.hash(name, age);
    }
}

// 3. toString() Method
public class Person {
    private String name;
    private int age;

    // toString() Method
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

// 4. Constructor Method
public class Person {
    private String name;
    private int age;

    // Constructor Method
    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
}

So reduzieren Sie den Boilerplate-Code

• Boilerplate-Code ist Code, der wiederholt geschrieben werden muss. Mit zunehmender Codemenge kann die Lesbarkeit des Codes abnehmen.
• In Java können Sie die folgenden Methoden verwenden, um Boilerplate-Code zu reduzieren.
  • IDE (Integrated Development Environment) verwenden: Boilerplate-Code kann mithilfe der von der IDE bereitgestellten Funktionen automatisch generiert werden.
  • Verwenden Sie die Lombok-Bibliothek: Sie können die Lombok-Bibliothek verwenden, um die Getter- und Setter-Methode, die equal()- und hashCode()-Methode, die toString()-Methode, die Konstruktormethode usw. automatisch zu generieren.
  • Annotation Processor verwenden: Boilerplate-Code kann mit dem Annotation Processor automatisch generiert werden.
  • Template Engine verwenden: Boilerplate-Code kann mithilfe der Template Engine automatisch generiert werden.
• In Java können Sie die Lombok-Bibliothek verwenden, um den Boilerplate-Code wie unten gezeigt zu reduzieren.
  • Mithilfe der @Data-Annotation können Sie automatisch die Getter- und Setter-Methode, die equal()- und hashCode()-Methode, die toString()-Methode und die Konstruktormethode erstellen.
  • Sie können das Schreiben von Code reduzieren, indem Sie einfach @Data Annotation verwenden, wie unten gezeigt.

import lombok.Data;

@Data
public class Person {
    private String name;
    private int age;
}

• Abhängig von der Sprache oder dem Framework können die Methoden zur Reduzierung des Boilerplate-Codes variieren. Finden Sie Möglichkeiten, den Boilerplate-Code zu reduzieren, indem Sie Funktionen nutzen, die von der verwendeten Sprache oder dem verwendeten Framework bereitgestellt werden.