-
Notifications
You must be signed in to change notification settings - Fork 0
/
hexagonal.html
433 lines (414 loc) · 22.7 KB
/
hexagonal.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
<!doctype html>
<html lang="fr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<title>Architecture Hexagonale</title>
<link rel="stylesheet" href="css/reveal.css">
<link rel="stylesheet" href="css/theme/irun.css">
<!-- Theme used for syntax highlighting of code -->
<link rel="stylesheet" href="lib/css/zenburn.css">
<!-- Printing and PDF exports -->
<script>
var link = document.createElement('link');
link.rel = 'stylesheet';
link.type = 'text/css';
link.href = window.location.search.match(/print-pdf/gi) ? 'css/print/pdf.css' : 'css/print/paper.css';
document.getElementsByTagName('head')[0].appendChild(link);
</script>
</head>
<body>
<div class="reveal">
<div class="slides">
<section>
<h1>Architecture Hexagonale</h1>
<aside class="notes">
<p>L’objectif ici n’est pas de vendre l’architecture Hexagonale comme la solution ultime à tous les
maux mais de présenter
des problèmes d’architecture courants et comment l’archi Hexa peut aider à les résoudre.
</p>
</aside>
</section>
<section>
<section data-markdown>
<script type="text/template">
## Les difficultés de la modélisation
* Choix techniques précipités
* Immobilisme technique
* Testabilité compliquée et mal dirigée
Notes:
1. Des choix techniques fait en début de projet, au moment où l’on a le moins de connaissance,
Un contexte qui fait qu’il faut prendre des décisions rapidement
2. Il est difficile de changer les choix techniques une fois qu’ils sont faits, nécessité de retester tout un ensemble
technique, cela induit des risques de régression. <br>
Plus l’application grandit plus les modifications techniques sont lourdes et complexes
3. Le fait que le métier et l’infra logicielle soit confondus et fortement couplés induit une testabilité réduite. Les tests
sont souvent longs à s’exécuter et compliqués à mettre en place à cause du grand nombre de prérequis des dépendances d’infra.
</script>
</section>
<section>
<h2>Architecture en Couches</h2>
<div style="display: grid;grid-gap: 10px;">
<div class="fragment" style="grid-column: 1 / 2;grid-row: 1;">
<img src="img/hexagonal/couches.png" />
</div>
<div style="grid-column: 2 / 2;grid-row: 1;font-size:60%;">
<ul>
<li class="fragment">Généralement les couches supérieures ne connaissent pas les
implémentations des couches inférieures</l i>
<li class="fragment">Intuitivement, on pourrait penser que la logique métier se trouve
dans la couche service</li>
<li class="fragment">Mais, généralement le métier est dispersé entre la couche
service et persistance</li>
</ul>
</div>
</div>
<aside class="notes">
<p>Généralement la couche service ne contient que des services sans état, qui manipulent des
Entités issues de la couche
de persistance</p>
<p>Selon les frameworks, les Entités de la couche de persistance sont couvertes d’annotations
qui induisent des dépendances.</p>
</aside>
</section>
<section>
<h2>Les principes SOLID</h2>
<ul>
<li><strong class="fragment highlight-red">S</strong> <em>Single responsability principe</em>
</li>
<li><strong class="fragment highlight-red">O</strong> <em>Open/closed principe</em></li>
<li><strong class="fragment highlight-red">L</strong> <em>Liskov substitution principle</em>
</li>
<li><strong class="fragment highlight-red">I</strong> <em>Interface segregation principle</em>
</li>
<li><strong class="fragment highlight-red">D</strong> <em>Dependency inversion principle</em>
</li>
</ul>
<div class="fragment" style="font-size: 60%;">
<a href="https://www.youtube.com/watch?v=IkMqG-dsD20">Software Craftsmanship Tidbit - Uncle Bob
Martin - Being Professional</a><br />
<a
href="https://storage.i-run.fr/index.php/apps/files/?dir=/Service-Info/Ressources/Bouquins%20OReilly&fileid=480967#pdfviewer">Coder
Proprement</a>
</div>
<aside class="notes">
<ul>
<li>une classe, une fonction ou une méthode doit avoir une et une seule responsabilité</li>
<li>Une classe, une méthode, un module doit pouvoir être étendu, supporter différentes
implémentations (Open for extension)
sans pour cela devoir être modifié (closed for modification).</li>
<li>une instance de type T doit pouvoir être remplacée par une instance de type G, tel que
G sous-type de T,
sans que cela ne modifie la cohérence du programme</li>
<li>préférer plusieurs interfaces spécifiques pour chaque client plutôt qu'une seule
interface générale</li>
<li>il faut dépendre des abstractions, pas des implémentations</li>
</ul>
<p>SOLID est un acronyme représentant cinq principes de bases pour la programmation orientée
objet,
introduits par Michael Feathers et Robert C. Martin au début des années 2000</p>
</aside>
</section>
<section>
<h3>Principe d’inversion des dépendances</h3>
<div style="display: grid;grid-gap: 10px;">
<div class="fragment" style="grid-column: 1 / 2;grid-row: 1;">
<img src="img/hexagonal/normal-dependencies.png" />
</div>
<div class="fragment" style="grid-column: 2 / 2;grid-row: 1;font-size:60%;">
<img src="img/hexagonal/inversed-dependencies.png" />
</div>
</div>
<aside class="notes">
<p>Grace à ça, A et B peuvent être déployés séparément.</p>
<p>B vient se brancher à A</p>
<p>A peut avoir plusieurs dépendances de ce genre</p>
</aside>
</section>
</section>
<section>
<section>
<em>l’architecture hexagonale à la rescousse...</em>
</section>
<section>
<p>idée simple : isoler le métier des détails techniques de l’implémentation</p>
<img class="fragment" style="height: 400px" src="img/hexagonal/outside_inside1.png" />
</section>
<section>
<p>le métier ne dépend de rien</p>
<img class="fragment" style="height: 300px" src="img/hexagonal/adapters2.png" />
<p class="fragment">toutes les dépendances vont de l’extérieur vers l’intérieur</p>
<p class="fragment">une couche d’adaptation fait le lien entre les mondes</p>
</section>
<section>
<h3>Un modèle agnostique</h3>
<ul>
<li class="fragment">pas de framework</li>
<li class="fragment">pas de base de données</li>
<li class="fragment">pas d’accès réseau</li>
<li class="fragment">pas d’accès disque/IO</li>
</ul>
<p class="fragment">Il ne doit JAMAIS y avoir dans le domaine, de référence vers l’infrastructure</p>
</section>
<section>
<h3>Les Ports</h3>
<p style="font-size:90%;">Le domaine expose des interfaces qui ont un sens métier.</p>
<div style="display: grid;grid-auto-columns: 50%;grid-gap: 10px;font-size: 70%;">
<figure class="fragment" style="grid-column: 1 / 2;grid-row: 1;">
<img src="img/hexagonal/apis2.png" />
<figcaption>Application Provider Interfaces</figcaption>
</figure>
<figure class="fragment" style="grid-column: 2 / 2;grid-row:1;">
<img src="img/hexagonal/spis1.png" />
<figcaption>Service Provider Interfaces</figcaption>
</figure>
</div>
<p class="fragment">Ces interfaces faisant partie du domaine, elles doivent avoir un sens métier</p>
</section>
<section>
<h3>Une infra qui s’adapte</h3>
<div style="display: grid;grid-gap: 10px;">
<div class="fragment" style="grid-column: 1 / 2 span;grid-row: 1 / 2;">Si on change de base de
données, on change l’adaptateur et on ne touche pas au métier</div>
<figure class="fragment" style="grid-column: 1 / 2;grid-row: 2 / 2;"><img
src="img/hexagonal/dip1.png" /></figure>
<figure class="fragment" style="grid-column: 2 / 2;grid-row: 2 / 2;"><img
src="img/hexagonal/dip2.png" /></figure>
</div>
<aside class="notes">
<p>Pour les composants qui appellent notre métier, c’est facile. Ils n’ont qu’à contacter nos
API. Mais quid des fournisseurs que notre métier va avoir besoin de contacter ?</p>
<p>Comment faire en sorte que notre modèle n’en ait pas connaissance ?</p>
<p>On utilise l’injection de dépendances.</p>
</aside>
</section>
<section>
<h3>On y gagne ...</h3>
<ul>
<li class="fragment">Une testabilité du métier accrue</li>
<li class="fragment">Une pérennisation du métier face aux changements techniques</li>
<li class="fragment">Une capacité à livrer de la valeur rapidement</li>
</ul>
<aside class="notes">
<ul>
<li>Démarrage rapide, démo facile a atteindre puisque pas de dépendances extérieure</li>
<li>On peut facilement remplacer une BDD par un fichier plat</li>
<li>Les choix techniques sont repoussés au moment où on en sait plus</li>
<li>On se concentre sur les besoins client (métier), feedback plus rapide</li>
</ul>
</aside>
</section>
</section>
<section>
<section>
<h3>Concrètement,</h3>
<p class="fragment">Anatomie d’un projet maven<br />
<img src="img/hexagonal/maven-logo.png" alt="" /></p>
<p class="fragment" style="font-size: 0.7em;"><em>...au sein d’une architecture modulaire
évolutive</em></p>
</section>
<section>
<h3>Anatomie d’un module</h3>
<h4>module-domain</h4>
<ul>
<li class="fragment">Contient toute la partie métier du code du module sous forme de services
</li>
<li class="fragment">Aucune dépendances de frameworks</li>
<li class="fragment">Des dépendances d’outils comme guava, SLF4j, ...</li>
<li class="fragment">Contient les interfaces de Ports</li>
</ul>
</section>
<section>
<h3>Anatomie d’un module</h3>
<h4>module-infra</h4>
<ul>
<li class="fragment">Peut dépendre des frameworks (Spring pour I-RUN)</li>
<li class="fragment">Contient les adapters qui implémentent les Ports déclarés dans le domaine
</li>
<li class="fragment">
<p>Contient la configuration qui permet d’injecter les Services du domaine</p>
<pre><code class="java" style="font-size: 0.6em;line-height: 1em;">
@Configuration
public class ReviewConfiguration {
@Bean
ReviewService reviewService(ReviewDatabaseAccessPorts reviewConfigurationPersistencePort) {
return new ReviewServiceImpl(reviewConfigurationPersistencePort);
}
}
</code></pre>
</li>
</ul>
<aside class="notes">
<h4>A noter:</h4>
<ul>
<li>La configuration n'est pas le seul moyen de faire pour injecter les services</li>
<li>On peut utiliser l’héritage avec l’annotation `@Service`</li>
<li>Cela permet d’avoir un comportement plus fin que le `@Bean`</li>
<li>Avec les traitements standard de Spring sur ces annotations</li>
</ul>
</aside>
</section>
<section>
<h3>Anatomie d’un module</h3>
<p style="font-size: 0.7em;">Pour les besoins de notre architecture modulaire, deux autres
sous-modules s’ajoutent au domaine et à l’infra.</p>
<ul>
<li class="fragment"><strong>module-api</strong>
<p style="font-size: 0.7em;">C’est les classes d’API du module. Tout ce qui est visible
depuis l’extérieur du module.
Pas de logique, pas de code. Peu voire pas de dépendances (guava & reactor pour les
Immutable et Flux).</p>
</li>
<li class="fragment"><strong>module-db</strong>
<p style="font-size: 0.7em;">Qui contient le DSL si le module accède à une base de données
</p>
</li>
</ul>
</section>
<section>
<h3>Anatomie d’un module</h3>
<pre><code class="bash" style="font-size: 0.6em;line-height: 1.1em;">
.
├── pom.xml
├── ${module}-api
│ ├── pom.xml
│ ├── src
│ │ ├── main
│ │ │ ├── java
│ │ │ │ └── fr.irun.${module}.api
│ │ │ │ ├── exceptions
│ │ │ │ ├── model
│ │ │ │ ├── Service1Api.java # Interface des services implémenté dans le domaine
│ │ │ │ └── Service2Api.java
│ │ │ └── resources
│ │ └── test
│ │ ├── java
│ │ │ └── fr.irun.${module}.api
│ │ └── resources
│ └── target
├── ${module}-domain
│ ├── pom.xml
│ ├── src
│ │ ├── main
│ │ │ ├── java
│ │ │ │ └── fr.irun.${module}.domain
│ │ │ │ ├── exceptions # Seulement les exceptions interne
│ │ │ │ ├── model # Seulement les POJO interne
│ │ │ │ ├── ports
│ │ │ │ └── services
│ │ │ └── resources
│ │ └── test
│ │ ├── java
│ │ │ └── fr.irun.${module}.domain
│ │ └── resources
│ └── target
└── ${module}-infra
├── pom.xml
├── src
│ ├── main
│ │ ├── java
│ │ │ └── fr.irun.${module}.infra
│ │ │ ├── components
│ │ │ ├── config
│ │ │ ├── controllers
│ │ │ ├── listeners
│ │ │ ├── model
│ │ │ ├── persistence
│ │ │ └── services
│ │ └── resources
│ └── test
│ ├── java
│ │ └── fr.irun.${module}.infra
│ └── resources
└── target
</code></pre>
</section>
</section>
<section>
<section>
<h2>Retour d’expérience</h2>
<ul>
<li>Comment ce type d’architecture a été accueillie au sein d’I-RUN ?</li>
<li>Quels ont été les difficultés ?</li>
<li>Qu’est-ce qu’on en a tiré ?</li>
<li>Si c’était à refaire ?</li>
</ul>
</section>
<section>
<h3>Retour d’expérience: Au début</h3>
<ul>
<li>Présentations</li>
<li>Séances de Mob programming</li>
<li>Sentiment d’over-engineering</li>
<li>Équipe de développeurs sceptique</li>
</ul>
</section>
<section>
<h3>Retour d’expérience: Difficultés</h3>
<ul>
<li>Compliqué de séparer le domaine de l’infra conceptuellement</li>
<li>Sur les premiers dev le domaine ne fait que passe-plat entre Controllers et Ports</li>
<li>Revues laborieuses</li>
<li>Dépassement des délais estimés</li>
<li>Suivi serré des développements nécessaires</li>
</ul>
</section>
<section>
<h3>Retour d’expérience: Avantages</h3>
<ul>
<li>Cadre bien défini et clair</li>
<li>Facilité à faire évoluer le code</li>
<li>Facilité à tester le code</li>
<li>Relativement simple à mettre en place avec Spring</li>
</ul>
</section>
<section>
<h3>Retour d’expérience: Aujourd’hui</h3>
<ul>
<li>Un module complexe développé selon l’archi Hexagonale</li>
<li>Module intégré au legacy I-RUN (WebApp Tomcat)</li>
<li>Des évolutions développées simplement, dans les délais et sans régression</li>
<li>Une équipe conquise par cette architecture</li>
<li>L’équipe front met en place une architecture similaire</li>
</ul>
</section>
</section>
<section>
<h2>TL;DR</h2>
<div style="display: grid;grid-auto-columns: 50%;grid-gap: 10px;font-size: 70%;">
<ul style="grid-column: 1 / 2;grid-row: 1;">
<li class="fragment">Isolation du métier</li>
<li class="fragment">pas d’infra dans le domaine</li>
<li class="fragment">des interfaces avec du sens métier</li>
<li class="fragment">privilégier les types fort au String</li>
<li class="fragment">pas d’infra dans le domaine</li>
</ul>
<figure style="grid-column: 2 / 2;grid-row: 1;">
<img src="img/hexagonal/clean-architecture.png" />
</figure>
<div>
</section>
</div>
</div>
<script src="lib/js/head.min.js"></script>
<script src="js/reveal.js"></script>
<script>
// More info about config & dependencies:
// - https://github.com/hakimel/reveal.js#configuration
// - https://github.com/hakimel/reveal.js#dependencies
Reveal.initialize({
controls: true,
progress: true,
history: true,
center: true,
transition: 'slide', // none/fade/slide/convex/concave/zoom
dependencies: [
{ src: 'plugin/markdown/marked.js' },
{ src: 'plugin/markdown/markdown.js' },
{ src: 'plugin/notes/notes.js', async: true },
{ src: 'plugin/highlight/highlight.js', async: true, callback: function () { hljs.initHighlightingOnLoad(); } }
]
});
</script>
</body>
</html>