Qu'est-ce que le code passe-partout ? Résumé du concept et exemples

Qu'est-ce que le passe-partout ?

• Le passe-partout fait référence à la plaque métallique utilisée par les sociétés de presse.
• Les journaux impriment le même contenu de manière répétée en utilisant des modèles déjà réalisés sur des plaques métalliques.

Concept de code passe-partout

• Le code Boilerplate fait référence au code qui doit être écrit à plusieurs reprises chaque fois que vous démarrez un nouveau projet. Le code passe-partout est un code qui est répété de la même manière à plusieurs endroits.
• Cela inclut, par exemple, la création de la structure du projet, l'initialisation des paramètres, le chargement des bibliothèques, etc. Alternativement, il fait référence au code qui doit être écrit à plusieurs reprises lors de l'implémentation d'une fonction spécifique, telle qu'une méthode Getter & Setter.

Exemple de code passe-partout

• Le code passe-partout peut apparaître dans différentes langues.
• Un exemple de code utilisé comme passe-partout en Java est le suivant :
  • Méthode Getter & Setter
  • Méthodes equals() et hashCode()
  • Méthode toString()
  • Méthode constructeur
• Les codes ci-dessus sont des codes qui doivent être écrits de manière répétée à chaque fois qu'une nouvelle classe est créée.

// 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;
    }
}

Comment réduire le code passe-partout

• Le code passe-partout est un code qui doit être écrit à plusieurs reprises. Ainsi, à mesure que la quantité de code augmente, la lisibilité du code peut diminuer.
• En Java, vous pouvez utiliser les méthodes suivantes pour réduire le code passe-partout.
  • Utilisez l'IDE (Integrated Development Environment) : le code Boilerplate peut être généré automatiquement à l'aide des fonctions fournies par l'IDE.
  • Utilisez la bibliothèque Lombok : vous pouvez utiliser la bibliothèque Lombok pour générer automatiquement la méthode Getter & Setter, la méthode equals() et hashCode(), la méthode toString(), la méthode constructeur, etc.
  • Utiliser le processeur d'annotation : le code standard peut être généré automatiquement à l'aide du processeur d'annotation.
  • Utiliser Template Engine : le code passe-partout peut être généré automatiquement à l'aide de Template Engine.
• En Java, vous pouvez utiliser la bibliothèque Lombok pour réduire le code Boilerplate comme indiqué ci-dessous.
  • À l'aide de @Data Annotation, vous pouvez créer automatiquement la méthode Getter & Setter, la méthode equals() et hashCode(), la méthode toString() et la méthode Constructor.
  • Vous pouvez réduire l'écriture de code simplement en utilisant @Data Annotation comme indiqué ci-dessous.

import lombok.Data;

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

• Selon le langage ou le framework, les méthodes permettant de réduire le code passe-partout peuvent varier. Trouvez des moyens de réduire le code passe-partout en utilisant les fonctionnalités fournies par le langage ou le framework que vous utilisez.