L'objectif de ce cours de 5 jours est de former les développeurs et les étudiants en informatique aux design patterns en programmation orientée objet. À la fin du cours, les participants devraient être capables de reconnaître, comprendre et appliquer divers design patterns dans leurs projets de développement logiciel.
Compétences visées :
- Être capable de comprendre et d'identifier les situations où des design patterns peuvent être appliqués.
- Être capable de mettre en œuvre les design patterns Singleton, Factory, Builder, State, et Observer en Java ou PHP.
- Être capable de choisir judicieusement un design pattern pour résoudre un problème de conception logicielle spécifique.
Compétences techniques :
- Maîtrise des bases de la programmation orientée objet en Java ou PHP.
- Compréhension des principes SOLID de conception de logiciels.
- Aptitude à refactoriser le code pour intégrer des design patterns.
Objectifs pédagogiques :
- Introduire le travail en mode projet pour l'application de design patterns.
- Promouvoir l'autonomie dans la résolution de problèmes de conception logicielle.
- Fournir une compréhension pratique des avantages et des inconvénients de chaque design pattern abordé.
Le cours va s’articuler comme suit :
- Exposition d’une problématique de code
- Prendre connaissance du design pattern grâce au site d’Alexander Shvets : Refactorig Guru.
- Résoudre la problématique en appliquant le patron de conception dans les deux langage choisi.
Vous travaillez pour l'entreprise Neufplate™ .
C'est votre 1ᵉʳ jour, vous travaillez en tant que développeur chez Neufplate™ et vous avez envie de faire vos preuves.
Armé de vos connaissances, vous avez à cœur de programmer de la façon la plus propre possible.
C'est pourquoi, dès que possible, vous utilisez les design patterns et autres bonne pratique de développement.
L'entreprise vous lance un challenge de taille :
En effet, jusqu'à maintenant, l'entreprise se contentait de simplement voler les illustrations des autres, mais on lui a récemment appris que cette pratique est en fait illégale.
C'est alors que Neufplate™ à une idée totalement inédite !
Elle va générer des avatars unique de façon aléatoire en fonction d'une chaine de caractères appelée seed.
Avec un peu de chance, elle pourra même vendre ses avatars comme s'ils étaient cotés en bourse.
Pour cette première mission, vous avez repéré sur internet un site qui permet de générer des avatars. Vous devez donc faire une classe qui fera des appels à cette API de façon régulière.
Voici la documentation de l’api : https://avatars.dicebear.com/docs
L’objectif est de créer une classe DiceBearApi avec une méthode getRandomAvatar() qui permet d’afficher une url qui ressemble à :
https://avatars.dicebear.com/api/:sprites/:seed.svg
Le type de sprite doit être human par défaut à l’initialisation de la classe.
Par la suite il pourrat être modifié comme bon nous semble.
Ainsi, tous les appels à la classe DiceBearClient doivent retourner le même type de sprite.
La classe DiceBearApi peut être appelé de n’importe ou sans initialisation et sans aucun paramêtre.
L’élement ‘seed’ quant à lui est alétoirement généré à chaque appel de la fonction GetRandomAvatar().
Utilisez le design pattern du singleton pour résoudre ce problème.
Le résultat attendu est simplement l'affichage de l'url dans un terminal.
Voila un exemple de résultat attendu :
System.out.println(DiceBearClient.getRandomAvatarUrl()); // https://avatars.dicebear.com/api/human/0.9817086718703704.svg
// Version de base
DiceBearClient.getInstance().spriteType = "avataaars";
//Version de ouf
DiceBearClient.getInstance().setSpriteType(SpriteType.AVATAAARS);
System.out.println(DiceBearClient.getRandomAvatarUrl()); // https://avatars.dicebear.com/api/avataaars/0.12462390433499249.svgecho DiceBearClient::getRandomAvatarUrl(); //https://avatars.dicebear.com/api/avataaars/634dc4a687a3c.svg
// Version de base
DiceBearClient::getInstance()->setSpriteType("human");
//Version de ouf
DiceBearClient::getInstance()->setSpriteType(SpriteType::Human);
echo DiceBearClient::getRandomAvatarUrl();La 1er version de votre générateur d’avatar vous convenait très bien jusque la. Mais elle à tellement de succès que l’on vous demande si il est possible d'ajouter d’autre fournisseur d’avatar.
Nous ne pouvons pas ajouter du code à la classe déjà existante car ce n’est pas la même API et que ne nous voulons pas complexifier le code existant.
En utilisant le patron de conception Factory vous devez créer le code qui permettra indifféremment de généré un avatar quel que soit le fournisseur que l’ont choisi.
Voici la documentation de la nouvelle api : https://robohash.org/
L’objectif est de créer une classe RobotHashClient qui est un singleton avec une méthode getRandomAvatar() qui permet d’afficher une url qui ressemble à :
https://robohash.org/:seed.png
Puis de créer les classes factories qui vont permettre de consuitruire n'importe quel type d'avatar. Voici à quoi peut ressembler l'appel à une des factories :
$avatar = new DiceBearAvatar(SpriteType::FEMALE);
$avatar->generate();
echo $avatar->url;
$avatar = new RobotHashAvatar();
$avatar->generate();
echo $avatar->url;Avatar avatarDiceBear = new DiceBearAvatar(SpriteType.FEMALE);
avatarDiceBear.generate();
System.out.println(avatarDiceBear.url);
Avatar avatarRobot = new RobotHashAvatar();
avatarRobot.generate();
System.out.println(avatarRobot.url);Voici l'interface commune aux deux clients :
interface AvatarClientInterface {
public function getRandomAvatarUrl(): string;
}public interface AvatarClientInterface {
public String getRandomAvatarUrl();
}A chaque nouvel avatar crée une url unique est générée.
💡 Astuce ! La classe Avatar doit ressembler à :
public abstract class Avatar {
public String url;
public void generate() {
AvatarClientInterface client = getClient();
this.url = client.getRandomAvatarUrl();
}
protected abstract AvatarClientInterface getClient();
}abstract class Avatar
{
public string $url;
public function generate(): void {
$client = $this->getClient();
$this->url = $client->getRandomAvatarUrl();
}
protected abstract function getClient(): AvatarClientInterface;
}Vous décidez de créer des profils utilisateurs afin de mieux trairer les demande de génération d'avatar. En effet l'entreprise Neufplate™ soit conserver une trace des avatars générés par utilisateur.
Mais en plus, le pôle marketing à quelques exigeance :
- Tous les champs sont optionnels sauf le nom et le prénom !
- Un utlisateur doit avoir soit un numéro de téléphone soit une adresse mail
Si l'une de ces deux conditions n'est pas rempli alors la création d'un utilisateur est impossible.
public class User {
protected String firstName;
protected String lastName;
protected List<Avatar> avatar = new ArrayList<>();
protected String phone;
protected String address;
protected String email;
}class User {
public string $firstname;
public string $lastname;
public array $avatar;
public string $phone;
public string $email;
public string $address;
}Utilisez le design pattern builder pour résoudre ce problème. Voici le résultat attendu :
User user = new UserBuilder()
.addNames("John", "Doe")
.addAddress("Fake address 1234")
.addPhone("0685858585")
.build();$builder = new UserBuilder();
$user = $builder
->addNames('John', 'Doe')
->addAddress("Fake address 1234")
->addEmail("[email protected]")
->build();💡 Astuce ! Voici l'interface Builder :
public interface Builder {
public Builder addNames(String firstname, String lastname);
public Builder addEmail(String email);
public Builder addPhone(String phone);
public Builder addAddress(String address);
}interface Builder
{
public function addNames(string $firstname, string $lastname): Builder;
public function addEmail(string $email): Builder;
public function addPhone(string $phone): Builder;
public function addAddress(string $address): Builder;
}Ps : Ne pas utiliser de Director, dans notre cas ce n'est pas nécéssaire.
Le pole marketing est conquis ! Les ventes explosent !
Mais les ambitions de Neufplate™ sont illimitée. On vous demande d'aller encors plus loin.
Votre supérieur l'Architect Growth Hacker Marketing Account Manager Stagiaire a une idée !
Pour rendre votre produit plus sexy vous allez lancer l'entreprise dans le monde magique des NFT. De plus, il est grand temps de passer à l'étape supérieur et de réfléchir comment produire en masse.
Voici vos objectifs :
- Créer une classe
Nft - Donner un nom a vos Nft grâce à une api client
- Générer un hash unique SHA-1 qui commence par
0000en fonction du nom généré - Créer un avatar qui aura pour seed le hash précédement crée
- Orchestrer tout cela grâce au design pattern d'état
- Attribuer un
Nftà un utilisateur - Lancer la génération de
Nft
public class Nft {
public String title;
public String hash;
public Avatar avatar;
}class Nft
{
public string $title;
public string $hash;
public Avatar $avatar;
}Voici une superbe API pour générer des titres : https://corporatebs-generator.sameerkumar.website/
La classe (le singleton) s'appellera CorporateBsClient.
Pour vous aider voici comment faire des appels réseaux en fonction du langage :
En PHP :
private function makeRequest(): string {
return file_get_contents(self::apiUrl);
}
private static function parseJson(string $json) {
$decoded_json = json_decode($json, false);
return $decoded_json->phrase;
}En Java :
private String makeRequest() {
try {
URL url = new URL(apiUrl + "/");
HttpURLConnection con = (HttpURLConnection) url.openConnection();
con.setRequestMethod("GET");
int status = con.getResponseCode();
BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuilder content = new StringBuilder();
while ((inputLine = in.readLine()) != null) {
content.append(inputLine);
}
in.close();
con.disconnect();
return content.toString();
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private static String parseJson(String json) {
Pattern phrasePattern = Pattern.compile("\"phrase\":\"(.*)\"");
Matcher phraseMatcher = phrasePattern.matcher(json);
if(phraseMatcher.find()) {
return phraseMatcher.group(1);
}
return null;
}Pour rappel la société Neufplate™ a décidé qu'il y aurait collision si le hash commence par 0000.
Exemple de méthode permettant de générer un hash en SHA-1 en fonction d'un input de type String :
En Java :
static String sha1(String input){
String sha1 = null;
try {
MessageDigest digest = MessageDigest.getInstance("SHA-1");
digest.reset();
digest.update(input.getBytes(StandardCharsets.UTF_8));
sha1 = String.format("%040x", new BigInteger(1, digest.digest()));
} catch (NoSuchAlgorithmException e) {
throw new RuntimeException(e);
}
return sha1;
}En PHP :
sha1(string $input)Pour générer une chaine de caractère qui sera ensuite servira pour le hash, la société Neufplate™ décide du formalisme suivant :
sha1(nonce + "#" + title);Un nonce est un nombre utilisé en criptographie pour faire varier le hash tout en gardant une partie fixe (ici le titre). L'idée est d'initialiser le nonceà 0 puis de créer le hash de nonce + "#" + title si le hash ne commmence pas par 0000 alors il suffira d'incrémenter le nonce de 1. Recommencer le processus jusqu'a avoir une collision.
Tester ce code la ou vous voulez pour l'instant, il ira plus tard dans une classe d'état.
N'oubliez pas d'ajouter une méthode getAvatarFromHash(String hash); à l'interface AvatarClientInterface.
Puis ajoutez une méthode supplémentaire à votre classe Avatar permettant de générer un avatar à partir d'un hash.
public void generate() {
AvatarClientInterface client = getClient();
this.url = client.getRandomAvatarUrl();
}
public void generate(String hash) {
//...Do stuff...//
}La classe Provider permettra de sélectionner très simplement le fournisseur de l'avatar que l'on souhaite.
Il s'utilisera dans l'avenir de cette façon :
Provider provider = new Provider(ProviderType.ROBOTHASH, SpriteType.DEFAULT);
Nft nft = neufplate.process(user, settings);$provider = new Provider(ProviderType::DICEBEAR, SpriteType::BOTTTS);
$nft = $neufplate->process($user, $provider);Voila à quoi ressemble une partie de la classe Provider :
public class Provider {
public ProviderType providerType;
public SpriteType spriteType;
/* Some stuff */
}class Provider
{
public ProviderType $type;
public SpriteType $spriteType;
/* Some stuff */
}Encore plus tard voici comment le provider sera utilisé grâce du pattern d'état dans le state GeneratingState :
@Override
public String onGenerating() {
/* Some Stuff ... */
switch (this.neufplate.settings.providerType) {
case DICEBEAR -> {
SpriteType spriteType = this.neufplate.settings.spriteType;
avatar = new DiceBearAvatar(spriteType);
}
case ROBOTHASH -> avatar = new RobotHashAvatar();
}
/* Some Stuff ... */
} public function onGenerating(): ?string
{
/* Some Stuff ... */
switch ($this->neufplate->provider->type) {
case ProviderType::DICEBEAR:
$avatar = new DiceBearAvatar();
break;
case ProviderType::ROBOTHASH:
$avatar = new RobotHashAvatar();
}
/* Some Stuff ... */
}Il faudra néanmoins modifier nos classe d'Avatarpour quelles prennent en compte la possibilité d'avoir un `SpriteType``
public class DiceBearAvatar extends Avatar {
private final SpriteType spriteType;
public DiceBearAvatar(SpriteType spriteType) {
/* Some Stuff ... */
}
@Override
protected AvatarClientInterface getClient() {
/* Some Stuff ... */
client.setSpriteType(this.spriteType);
/* Some Stuff ... */
}
}class DiceBearAvatar extends Avatar
{
private SpriteType $spriteType;
public function __construct(SpriteType $spriteType = SpriteType::DEFAULT)
{
/* Some Stuff ... */
}
protected function getClient(): AvatarClientInterface
{
/* Some Stuff ... */
$client->setSpriteType($this->spriteType);
/* Some Stuff ... */
}
}Voici l'ordre des états :
TitlingState: Qui générère un titre via l'API BullshitCorporateMakingCollisionState: Qui s'occupe de faire une collisionGeneratingState: Qui génère un avatar via le hash de la collision
Avec les méthodes abstraites leurs correspondant :
public abstract function onTitling() : ?string;
public abstract function onMakingCollision() : ?string;
public abstract function onGenerating() : ?string;public abstract String onTitling();
public abstract String onMakingCollision();
public abstract String onGenerating();Pour vous aider vous trouverez ci-dessous un exemple de la classe Neufplate qui servira de base pour l'implémentation du design pattern.
public class Neufplate {
public Nft nft;
public Provider provider;
public User user;
private State state;
public Neufplate(//...//) {
//...Do stuff..//
this.state = new TitlingState(this);
}
public void changeState(State state) {
this.state = state;
}
public State getState() {
return this.state;
}
public Nft process(User forUser, Provider withAvatarProvider) {
this.nft = new Nft();
this.user = forUser;
this.provider = withAvatarProvider;
this.state = new TitlingState(this);
this.state.onTitling();
this.state.onMakingCollision();
this.state.onGenerating();
//...Do or return stuff...//
}
//...Some others methods...//
}class Neufplate
{
public State $state;
public Nft $nft;
public Provider $provider;
public User $user;
public function process(User $user, Provider $provider): Nft {
$this->nft = new Nft();
$this->user = $user;
$this->provider = $provider;
$this->state = new TitlingState($this);
$this->state->onTitling();
$this->state->onMakingCollision();
$this->state->onGenerating();
//...Do or return stuff...//
}
public function changeState(State $state) {
$this->state = $state;
}Faites en sorte qu'a cette étape vous puissiez toujours choisir quel type de fournisseur d'avatar vous voulez.
Changer la classe User : En effet elle ne contiendra finalement pas d'avatars mais bel et bien une liste de Nft.
A la fin du processus de fabrication ajouter le Nft à la liste des Nft déjà possédé par un utilisateur.
Faites en sorte que la console affiche de façon lisible un utilisateur ainsi que la list des Nft dont il dispose.
Voici le code a appeler pour lancer la génération de Nft. A chaque appel de la fonction process(...) un nouvel Nft est ajouté à l'utilisateur.
Provider provider = new Provider(ProviderType.DICEBEAR, SpriteType.BOTTTS);
Neufplate neufplate = new Neufplate();
neufplate.process(user, provider);$provider = new Provider(ProviderType::DICEBEAR, SpriteType::BOTTTS);
$neufplate = new Neufplate();
$nft = $neufplate->process($user, $provider);Ce code est à ajouter dans votre classe main en Java, ou index / app en PHP. Il sert à lancer la création de votre NFT.
Catastrophe ! Les possesseurs de Nft sont en pleine révolte ! En effet ils ne peuvent pas prouver de façon non équivoque qu'ils sont bien les propriétaires légitimes des Nft qu'ils possèdent. "Sans certificat de propriété plus rien n'a de sens !" nous apprends le CEO de Neufplate™ !
- Ajoutez la propriétée nonce a votre classe
Nftelle sera de typeLong - Créez une méthode qui affichera le "certificat de propriété" du
Nft(nonce + "#" + title). - En utilisant le design pattern observer faire en sorte d'envoyer un mail ou un SMS à l'utilisateur dès que le certifcat est disponible.
- Enfin, envoyer un mail ou un SMS quand le
Nftest généré.
En Java :
Pour vous aider voici à quoi ressemble l'interface EventListener :
public interface EventListener {
void update(String eventType, Nft nft);
}Il y aura deux classe de ...NotificationListener l'une appelée EmailNotificationListener prenant en paramètre un email.
L'autre appelée SmsNotificationListener prenant en paramètre un numéro de téléphone.
Voici le genre d'output que doivent produire les classe de ...NotificationListener :
System.out.println("SMS à " + phoneNumber + ": Voici votre certificat de propriété : " + nft.nonce);Et voici la classe
public class EventManager {
Map<String, List<EventListener>> listeners = new HashMap<>();
public EventManager(String... operations) {
for (String operation : operations) {
this.listeners.put(operation, new ArrayList<>());
}
}
public void subscribe(String eventType, EventListener listener) {
List<EventListener> users = listeners.get(eventType);
users.add(listener);
}
public void unsubscribe(String eventType, EventListener listener) {
List<EventListener> users = listeners.get(eventType);
users.remove(listener);
}
public void unsubscribeFromAllListener(String eventType) {
List<EventListener> users = listeners.get(eventType);
users.clear();
}
public void notify(//...To do...//) {
List<EventListener> listenersForOneEvent = listeners.get(//...To do...//);
for (EventListener listener : listenersForOneEvent) {
listener.update(//...To do...//);
}
}
}Astuce : C'est la méthode process() de la classe Neufplate qui doit inscrire l'utilisateur à l'EventManager.
En php :
C'est la classe State qui devra implémenter SplSubject
Avec comme attribut :
private SplObjectStorage $observers;Et on le construit comme cela :
$this->observers = new SplObjectStorage();Avec les méthodes suivantes :
public function attach(SplObserver $observer): void
{
$this->observers->attach($observer);
}
public function detach(SplObserver $observer): void
{
$this->observers->detach($observer);
}
public function notify(): void
{
/** @var SplObserver $observer */
foreach ($this->observers as $observer) {
$observer->update($this);
}
}Voici le genre d'output que doivent produire les classe de ...NotificationListener :
public function update(SplSubject $subject): void {
echo "SMS à " . $this->user->phone . ": Voici votre certificat de propriété : " . $this->nft->nonce . PHP_EOL;
}N'oubliez pas d'instancier vos observeurs dans les classes d'états qui déclancherons les notifications :
$this->attach(new EmailNotificationListener($this->neufplate->user, $this->neufplate->nft));En utilisant le design pattern decorator faites en sorte de pouvoir calculer le prix de revient d'un Nft.
Il faudra ajouter deux attribut à la classe Nft pour connaitre l'heure de début et de fin de génération du Nft
Puis ensuite ajoutez une marge de : 🔥🔥 100000% 🔥🔥.
Enfin calculez le prix en TTC sachant que la TVA en France est de 20%
Pour vous aider voici la classe abstraite Price :
public abstract class Price {
public double baseValue = 0d;
public abstract double calculate();
}abstract class Price
{
public float $baseValue;
public abstract function calculate(): float;
}Voici la classe concrète de Price :
public class NftPrice extends Price {
private final int computerPrice = 4000;
private final int screenTimeAverageByDay = 5;
private final int computerLifetimeInYears = 3;
private final double timeElapsedInSecond;
public NftPrice(long startTime, long endTime) {
/... Do stuff .../
}
@Override
public double calculate() {
/... Do stuff .../
this.baseValue = price;
return price;
}
}class NftPrice extends Price
{
private const computerPrice = 4000;
private const screenTimeAverage = 5;
private const computerLifetimeInYears = 3;
private int $timeElapsedInSecond;
public function __construct($startTime, $endTime)
{
/... Do stuff .../
}
public function calculate(): float
{
/... Do stuff .../
$this->baseValue = $price;
return $price;
}
}Il y aura deux classes de "décoration" :
ExcludingTaxesPriceDecoratorqui calcule le prix de vente duNftIncludingTaxesPriceDecoratorqui augmente le prix du taux de la TVA actuelle.
Enfin ajoutez une méthode à la classe Nft qui permet de calculer le prix TTC du Nft :
public double getPrice() {
Price costPrice = new NftPrice(this.startTime, this.endTime);
costPrice.calculate();
Price exclTax = new ExcludingTaxesPriceDecorator(costPrice);
exclTax.calculate();
Price inclTax = new IncludingTaxesPriceDecorator(exclTax);
inclTax.calculate();
return inclTax.baseValue;
}public function getPrice(): float
{
$costPrice = new NftPrice($this->startTime, $this->endTime);
$costPrice->calculate();
$exclTax = new ExcludingTaxesPriceDecorator($costPrice);
$exclTax->calculate();
$inclTax = new IncludingTaxesPriceDecorator($exclTax);
$inclTax->calculate();
return $inclTax->baseValue;
}Choisir un design qui n'a pas encore été fait ni présenté puis prenez 5 min (avec ou sans dispo) pour le présenter au reste de classe. N'oubliez pas de répondre aux questions suivantes :
- Quand et pourquoi utiliser ce design pattern ?
- Explication de son fonctionnement. (Avec un peu de code)
- Il y a t-il des grosses différences d'implémentation entre Java / Php / ou Kotlin ?
- Avantages
- Inconvénients
Uitlisez les webhooks Discord pour envoyer vos Nft.