Un guide solide des principes SOLID

1. Introduction

Dans ce didacticiel, nous discuterons des principes SOLID de la conception orientée objet.

Tout d'abord, nous allons commencer par explorer les raisons de leur apparition et pourquoi nous devrions les considérer lors de la conception de logiciels. Ensuite, nous décrirons chaque principe avec un exemple de code pour souligner le point.

2. La raison des principes SOLID

Les principes SOLID ont été conceptualisés pour la première fois par Robert C. Martin dans son article de 2000, Design Principles and Design Patterns. Ces concepts ont ensuite été développés par Michael Feathers, qui nous a présenté l'acronyme SOLID. Et au cours des 20 dernières années, ces 5 principes ont révolutionné le monde de la programmation orientée objet, changeant la façon dont nous écrivons des logiciels.

Alors, qu'est-ce que SOLID et comment cela nous aide-t-il à écrire un meilleur code? En termes simples, les principes de conception de Martin et Feathers nous encouragent à créer des logiciels plus faciles à maintenir, compréhensibles et flexibles . Par conséquent, au fur et à mesure que nos applications grandissent, nous pouvons réduire leur complexité et nous éviter bien des maux de tête plus tard!

Les 5 concepts suivants composent nos principes SOLID:

  1. S Ingle Responsabilité
  2. O stylo / fermé
  3. Substitution de L iskov
  4. Je nterface Ségrégation
  5. D ependency Inversion

Bien que certains de ces mots puissent sembler intimidants, ils peuvent être facilement compris avec quelques exemples de code simples. Dans les sections suivantes, nous allons approfondir la signification de chacun de ces principes, avec un exemple Java rapide pour illustrer chacun d'eux.

3. Responsabilité unique

Commençons par le principe de la responsabilité unique. Comme on pouvait s'y attendre, ce principe stipule qu'une classe ne devrait avoir qu'une seule responsabilité. De plus, il ne devrait avoir qu'une seule raison de changer.

Comment ce principe nous aide-t-il à créer de meilleurs logiciels? Voyons quelques-uns de ses avantages:

  1. Test - Une classe avec une responsabilité aura beaucoup moins de cas de test
  2. Couplage inférieur - Moins de fonctionnalités dans une seule classe auront moins de dépendances
  3. Organisation - Les classes plus petites et bien organisées sont plus faciles à rechercher que les classes monolithiques

Prenons, par exemple, une classe pour représenter un livre simple:

public class Book { private String name; private String author; private String text; //constructor, getters and setters }

Dans ce code, nous stockons le nom, l'auteur et le texte associé à une instance d'un livre .

Ajoutons maintenant quelques méthodes pour interroger le texte:

public class Book { private String name; private String author; private String text; //constructor, getters and setters // methods that directly relate to the book properties public String replaceWordInText(String word){ return text.replaceAll(word, text); } public boolean isWordInText(String word){ return text.contains(word); } }

Maintenant, notre classe Livre fonctionne bien et nous pouvons stocker autant de livres que nous le souhaitons dans notre application. Mais à quoi sert le stockage des informations si nous ne pouvons pas afficher le texte sur notre console et le lire?

Jetons la prudence au vent et ajoutons une méthode d'impression:

public class Book { //... void printTextToConsole(){ // our code for formatting and printing the text } }

Ce code enfreint cependant le principe de responsabilité unique que nous avons décrit précédemment. Pour corriger notre désordre, nous devons implémenter une classe distincte qui ne concerne que l'impression de nos textes:

public class BookPrinter { // methods for outputting text void printTextToConsole(String text){ //our code for formatting and printing the text } void printTextToAnotherMedium(String text){ // code for writing to any other location.. } }

Impressionnant. Non seulement nous avons développé une classe qui décharge le livre de ses tâches d'impression, mais nous pouvons également tirer parti de notre classe BookPrinter pour envoyer notre texte à d'autres médias.

Qu'il s'agisse de courrier électronique, de journalisation ou de toute autre chose, nous avons une classe distincte dédiée à ce problème.

4. Ouvert pour extension, fermé pour modification

Maintenant, place au «O» - plus formellement connu sous le nom de principe ouvert-fermé . En termes simples, les classes doivent être ouvertes pour l'extension, mais fermées pour modification. Ce faisant, nous nous empêchons de modifier le code existant et de provoquer de nouveaux bogues potentiels dans une application par ailleurs heureuse.

Bien sûr, la seule exception à la règle concerne la correction de bogues dans le code existant.

Explorons le concept plus en détail avec un exemple de code rapide. Dans le cadre d'un nouveau projet, imaginez que nous ayons implémenté une classe Guitar .

Il est à part entière et possède même un bouton de volume:

public class Guitar { private String make; private String model; private int volume; //Constructors, getters & setters }

We launch the application, and everyone loves it. However, after a few months, we decide the Guitar is a little bit boring and could do with an awesome flame pattern to make it look a bit more ‘rock and roll'.

At this point, it might be tempting to just open up the Guitar class and add a flame pattern – but who knows what errors that might throw up in our application.

Instead, let's stick to the open-closed principle and simply extend our Guitar class:

public class SuperCoolGuitarWithFlames extends Guitar { private String flameColor; //constructor, getters + setters }

By extending the Guitar class we can be sure that our existing application won't be affected.

5. Liskov Substitution

Next up on our list is Liskov substitution, which is arguably the most complex of the 5 principles. Simply put, if class A is a subtype of class B, then we should be able to replace B with A without disrupting the behavior of our program.

Let's just jump straight to the code to help wrap our heads around this concept:

public interface Car { void turnOnEngine(); void accelerate(); }

Above, we define a simple Car interface with a couple of methods that all cars should be able to fulfill – turning on the engine, and accelerating forward.

Let's implement our interface and provide some code for the methods:

public class MotorCar implements Car { private Engine engine; //Constructors, getters + setters public void turnOnEngine() { //turn on the engine! engine.on(); } public void accelerate() { //move forward! engine.powerOn(1000); } }

As our code describes, we have an engine that we can turn on, and we can increase the power. But wait, its 2019, and Elon Musk has been a busy man.

We are now living in the era of electric cars:

public class ElectricCar implements Car { public void turnOnEngine() { throw new AssertionError("I don't have an engine!"); } public void accelerate() { //this acceleration is crazy! } }

By throwing a car without an engine into the mix, we are inherently changing the behavior of our program. This is a blatant violation of Liskov substitution and is a bit harder to fix than our previous 2 principles.

One possible solution would be to rework our model into interfaces that take into account the engine-less state of our Car.

6. Interface Segregation

The ‘I ‘ in SOLID stands for interface segregation, and it simply means that larger interfaces should be split into smaller ones. By doing so, we can ensure that implementing classes only need to be concerned about the methods that are of interest to them.

For this example, we're going to try our hands as zookeepers. And more specifically, we'll be working in the bear enclosure.

Let's start with an interface that outlines our roles as a bear keeper:

public interface BearKeeper { void washTheBear(); void feedTheBear(); void petTheBear(); }

As avid zookeepers, we're more than happy to wash and feed our beloved bears. However, we're all too aware of the dangers of petting them. Unfortunately, our interface is rather large, and we have no choice than to implement the code to pet the bear.

Let's fix this by splitting our large interface into 3 separate ones:

public interface BearCleaner { void washTheBear(); } public interface BearFeeder { void feedTheBear(); } public interface BearPetter { void petTheBear(); }

Now, thanks to interface segregation, we're free to implement only the methods that matter to us:

public class BearCarer implements BearCleaner, BearFeeder { public void washTheBear() { //I think we missed a spot... } public void feedTheBear() { //Tuna Tuesdays... } }

And finally, we can leave the dangerous stuff to the crazy people:

public class CrazyPerson implements BearPetter { public void petTheBear() { //Good luck with that! } }

Going further, we could even split our BookPrinter class from our example earlier to use interface segregation in the same way. By implementing a Printer interface with a single print method, we could instantiate separate ConsoleBookPrinter and OtherMediaBookPrinter classes.

7. Dependency Inversion

The principle of Dependency Inversion refers to the decoupling of software modules. This way, instead of high-level modules depending on low-level modules, both will depend on abstractions.

To demonstrate this, let's go old-school and bring to life a Windows 98 computer with code:

public class Windows98Machine {}

But what good is a computer without a monitor and keyboard? Let's add one of each to our constructor so that every Windows98Computer we instantiate comes pre-packed with a Monitor and a StandardKeyboard:

public class Windows98Machine { private final StandardKeyboard keyboard; private final Monitor monitor; public Windows98Machine() { monitor = new Monitor(); keyboard = new StandardKeyboard(); } }

This code will work, and we'll be able to use the StandardKeyboard and Monitor freely within our Windows98Computer class. Problem solved? Not quite. By declaring the StandardKeyboard and Monitor with the new keyword, we've tightly coupled these 3 classes together.

Not only does this make our Windows98Computer hard to test, but we've also lost the ability to switch out our StandardKeyboard class with a different one should the need arise. And we're stuck with our Monitor class, too.

Let's decouple our machine from the StandardKeyboard by adding a more general Keyboard interface and using this in our class:

public interface Keyboard { }
public class Windows98Machine{ private final Keyboard keyboard; private final Monitor monitor; public Windows98Machine(Keyboard keyboard, Monitor monitor) { this.keyboard = keyboard; this.monitor = monitor; } }

Here, we're using the dependency injection pattern here to facilitate adding the Keyboard dependency into the Windows98Machine class.

Let's also modify our StandardKeyboard class to implement the Keyboard interface so that it's suitable for injecting into the Windows98Machine class:

public class StandardKeyboard implements Keyboard { }

Now our classes are decoupled and communicate through the Keyboard abstraction. If we want, we can easily switch out the type of keyboard in our machine with a different implementation of the interface. We can follow the same principle for the Monitor class.

Excellent! We've decoupled the dependencies and are free to test our Windows98Machine with whichever testing framework we choose.

8. Conclusion

In this tutorial, we've taken a deep dive into the SOLID principles of object-oriented design.

Nous avons commencé par un bref historique de SOLID et les raisons pour lesquelles ces principes existent.

Lettre par lettre, nous avons décomposé la signification de chaque principe avec un exemple de code rapide qui le viole. Nous avons ensuite vu comment corriger notre code et le faire adhérer aux principes SOLID.

Comme toujours, le code est disponible sur sur GitHub.