AL5L Architecture logicielle. Séance 2 Design patterns et qualité de code

Transcription

1 AL5L Architecture logicielle Séance 2 Design patterns et qualité de code Sébastien Combéfis lundi 24 novembre 2014

2 Ce(tte) œuvre est mise à disposition selon les termes de la Licence Creative Commons Attribution Pas d Utilisation Commerciale Pas de Modification 4.0 International.

3 Objectifs Découvrir en détails plusieurs design patterns Comprendre un design pattern Identifier quand et comment appliquer un design pattern Comprendre et utiliser des critères de qualité de code Évaluer la qualité d un code Réfactorer un code en vue de l améliorer 3

4 Première partie Design patterns

5 Design pattern Un design pattern est une solution à un problème commun Solution répétable à appliquer en design de logiciel Il s agit d un modèle qui décrit comment résoudre le problème Il ne s agit pas de code tout fait à simplement importer Accélère le développement logiciel Solution testée et prouvée adaptée pour chaque problème 5

6 Catégories I Trois catégories principales et 23 patterns Établies par le Gang of Four (GoF) en Patterns de construction (Creational) Instanciation de classes 2 Patterns structuraux (Structural) Composition de classes et d objets 3 Patterns comportementaux (Behavioural) Communication entre objets 6

7 Catégories II Les 23 patterns du GoF Construction Structurel Comportemental Abstract factory Adapter Chain of responsibility Builder Bridge Command Factory method Composite Interpreter Prototype Decorator Iterator Singleton Facade Mediator Flyweight Memento Proxy Observer State Strategy Template method Visitor 7

8 Les design patterns vous simplifient la vie! 8

9 Trois exemples Pattern Builder Construction d objets complexes Pattern Facade Interface client pour un sous-système Pattern Template Squelette d algorithme 9

10 Le pattern Builder Séparation de la construction d un objet et de son implémentation Builders Director Builder Builder 1 Builder 2... Product 1 Product

11 Contexte et application Algorithme de création d un objet complexe Indépendant de comment les objets sont assemblés Processus de construction générique Sur base d une classe abstraite 11

12 Acteurs Builder Classe abstraite pour la création de parties du produit ConcreteBuilder Construit et assemble les parties du produit Director Construit un objet en utilisant l interface Builder Product L objet complexe en cours de construction 12

13 Exemple I p u b l i c f i n a l c l a s s SebBurgerMenu private s t a t i c enum S i z e SMALL, MEDIUM, LARGE ; private s t a t i c enum Burger CLASSIC, CHEESE, BACON ; private s t a t i c enum Drink COCA, SPRITE, FANTA ; private s t a t i c enum D e s s e r t CHURROS, DONUT ; p r i v a t e f i n a l S i z e s i z e ; p r i v a t e f i n a l Burger b u r g e r ; p r i v a t e f i n a l Drink d r i n k ; p r i v a t e f i n a l D e s s e r t d e s s e r t ; p u b l i c s t a t i c f i n a l c l a s s B u i l d e r //... p r i v a t e SebBurgerMenu ( B u i l d e r b u i l d e r ) s i z e = b u i l d e r. s i z e ; b u r g e r = b u i l d e r. b u r g e r ; d r i n k = b u i l d e r. d r i n k ; d e s s e r t = b u i l d e r. d e s s e r t ; 13

14 Exemple II p u b l i c s t a t i c f i n a l c l a s s B u i l d e r // R e q u i r e d p r i v a t e f i n a l S i z e s i z e ; p r i v a t e f i n a l Burger b u r g e r ; p r i v a t e f i n a l Drink d r i n k ; // O p t i o n a l p r i v a t e D e s s e r t d e s s e r t ; p u b l i c B u i l d e r ( S i z e s i z e, Burger burger, Drink d r i n k ) t h i s. s i z e = s i z e ; t h i s. b u r g e r = b u r g e r ; t h i s. d r i n k = d r i n k ; p u b l i c B u i l d e r d e s s e r t ( D e s s e r t d e s s e r t ) t h i s. d e s s e r t = d e s s e r t ; r e t u r n t h i s ; p u b l i c SebBurgerMenu b u i l d ( ) r e t u r n new SebBurgerMenu ( t h i s ) ; 14

15 Exemple III p u b l i c s t a t i c v o i d main ( S t r i n g [ ] a r g s ) // Simple menu avec f r i t e s, burger et boisson SebBurgerMenu menu = new SebBurgerMenu. B u i l d e r ( S i z e. SMALL, Burger. CHEESE, Drink. SPRITE ). b u i l d ( ) ; System. out. p r i n t l n ( menu ) ; // Menu avancé avec un d e s s e r t en p l u s SebBurgerMenu. Builder b u i l d e r = new SebBurgerMenu. Builder ( S i z e. LARGE, Burger.BACON, Drink.COCA ) ; b u i l d e r. d e s s e r t ( D e s s e r t.donut) ; System. out. p r i n t l n ( b u i l d e r. b u i l d ( ) ) ; 15

16 Le pattern Facade Point d entrée unifié pour accéder aux fonctionnalités offertes par un sous-système Client Client Subsystem class Subsystem class Subsystem class Subsystem class Subsystem 16

17 Le pattern Facade Point d entrée unifié pour accéder aux fonctionnalités offertes par un sous-système Client Client Facade Subsystem class Subsystem class Subsystem class Subsystem class Subsystem 16

18 Contexte et application Interface simplifiée d un sous-système pour certains clients Le sous-système reste complètement accessible L implémentation peut changer, mais l interface reste stable La façade fait le lien avec des interfaces du sous-système Diminuer le couplage avec le sous-système Couplage avec les clients ou avec d autres sous-systèmes 17

19 Acteurs Facade Connait les classes responsables des requêtes Délégue les requêtes clients aux objets appropriés Classes du sous-système Ne savent pas qu elles sont derrière une façade Gèrent les requêtes transmises par le façade Implémentent les fonctionnalités du sous-système 18

20 Le pattern Template Définir le squelette d un algorithme et définir certaines opérations dans des sous-classes Client Abstract Concrete 1 Concrete 2 19

21 Contexte et application Plusieurs algorithmes avec des parties variables Factorisation de parties communes dans une sous-classe On remonte les parties communes dans la classe mère Impose un contrôle sur la liberté des sous-classes Par la définition de «hook» 20

22 Acteurs Abstract class Définit des opérations primitives abstraites Définit le squelette d un algorithme, basé sur les primitives Concrete class Implémente les opérations primitives 21

23 Exemple I c l a s s S o r t e r : metaclass = ABCMeta # Trie l e tableau tab d e f s o r t ( s e l f, tab ) : w h i l e not s e l f. _ i s S o r t e d ( tab ) : f o r i i n range ( l e n ( tab ) 1 ) : i f ( s e l f. _compare ( tab [ i ], tab [ i + 1 ] ) > 0 ) : s e l f. _swap ( tab, i, i + 1) # I n t e r v e r t i t l e s v a l e u r s d i n d i c e i e t j dans tab d e f _swap ( s e l f, tab, i, j ) : tab [ i ], tab [ j ] = tab [ j ], tab [ i ] # Teste s i l e t a b l e a u tab e s t t r i é d e f _ i s S o r t e d ( s e l f, tab ) : f o r i i n range ( l e n ( tab ) 1 ) : i f s e l f. _compare ( tab [ i ], tab [ i + 1 ] ) > 0 : r e t u r n F a l s e r e t u r n True # Compare x e t y # <0 s i x v i e n t avant y # >0 s i x v i e n t a p r è s y # =0 s i n o d e f _compare ( s e l f, x, y ) : pass 22

24 Exemple II # T r i par o r d r e c r o i s s a n t c l a s s A s c S o r t e r ( S o r t e r ) : d e f _compare ( s e l f, x, y ) : r e t u r n x y # T r i par o r d r e d é c r o i s s a n t c l a s s D e s c S o r t e r ( S o r t e r ) : d e f _compare ( s e l f, x, y ) : r e t u r n y x i f name == " main " : tab = [ 7, 2, 9, 5] p r i n t ( tab ) s o r t e r = A s c S o r t e r ( ) s o r t e r. s o r t ( tab ) p r i n t ( tab ) s o r t e r = D e s c S o r t e r ( ) s o r t e r. s o r t ( tab ) p r i n t ( tab ) 23

25 Autres patterns GoF patterns Concurrency patterns Patterns utilisés lors de la programmation multithread (Double-checking locking, Lock, Monitor, Thread pool...) Architectural patterns Patterns avec une portée plus large que les design patterns (Interceptor, MVC, n-tier, Active record...) 24

26 Deuxième partie Qualité de code

27 Refactoring I Transformation de code qui préserve son comportement A change made to the internal structure of software to make it easier to understand and cheaper to modify without changing its observable behaviour Martin Fowler Objectifs Rendre plus facile l ajout de nouveau code Améliorer le design du code existant Mieux comprendre un code Rendre le code moins ennuyeux 26

28 Refactoring II 27

29 Refactoring III Ne faire du refactoring que sur du code fonctionnel et testé Jeux de tests pour s assurer que le refactoring n a rien altéré Les problèmes de design proviennent de code......dupliqué...pas clair...compliqué 28

30 Code smell Les 22 code smells de Fowler et Beck Alternative classes with Long method different interfaces Comments Long parameter list Data class Message chains Data clumps Middle man Divergent change Parallel inheritance hierarchies Duplicated code Primitive obsession Feature envy Refused bequest Inappropriate intimacy Shotgun surgery Incomplete library class Speculative generality Large class Switch statements Lazy class Temporary field 29

31 Bien commenter son code! 30

32 Choisir ses noms 31

33 Duplicated code Deux formes de code dupliqué Duplication explicite de code identique Structure ou processus similaire Solutions Template design pattern Chain constructor... 32

34 Exemple p u b l i c f i n a l c l a s s Contact // I n s t a n c e v a r i a b l e s p r i v a t e String firstname ; p r i v a t e S t r i n g lastname ; p r i v a t e Address address ; // C o n s t r u c t o r s p u b l i c Contact ( S t r i n g l a s t n a m e ) t h i s. l a s t n a m e = l a s t n a m e ; p u b l i c Contact ( String firstname, String lastname ) t h i s. f i r s t n a m e = f i r s t n a m e ; t h i s. l a s t n a m e = l a s t n a m e ; p u b l i c Contact ( S t r i n g f i r s t n a m e, S t r i n g lastname, Address a d d r e s s ) t h i s. f i r s t n a m e = f i r s t n a m e ; t h i s. l a s t n a m e = l a s t n a m e ; t h i s. a d d r e s s = a d d r e s s ; 33

35 Après refactoring p u b l i c f i n a l c l a s s Contact p r i v a t e String firstname ; p r i v a t e S t r i n g lastname ; p r i v a t e Address address ; p u b l i c Contact ( S t r i n g l a s t n a m e ) t h i s ( n u l l, lastname, n u l l ) ; p u b l i c Contact ( String firstname, String lastname ) t h i s ( f i r s t n a m e, lastname, n u l l ) ; p u b l i c Contact ( S t r i n g f i r s t n a m e, S t r i n g lastname, Address a d d r e s s ) t h i s. f i r s t n a m e = f i r s t n a m e ; t h i s. l a s t n a m e = l a s t n a m e ; t h i s. a d d r e s s = a d d r e s s ; 34

36 Long method Méthode dont le corps comporte beaucoup d instructions Ne possède pas une seule fonctionnalité Limite la réutilisabilité Difficile à comprendre Solutions Compose method Extract method... 35

37 Exemple i n t main ( ) i n t data [ 1 5 ] ; // I n i t i a l i s a t i o n i n t i ; f o r ( i = 1 ; i <= 1 5 ; i ++) data [ i 1 ] = 42; // A f f i c h a g e p r i n t f ( " [ " ) ; i n t j ; f o r ( j = 0 ; j < 1 5 ; j ++) i f ( j == 14) p r i n t f ( "%d ", data [ j ] ) ; e l s e p r i n t f ( "%d, ", data [ j ] ) ; p r i n t f ( " ] \ n " ) ; r e t u r n 0 ; 36

38 Après refactoring v o i d f i l l T a b ( i n t data, i n t N, i n t v a l u e ) i n t i ; f o r ( i = 0 ; i < N; i ++) data [ i ] = v a l u e ; v o i d p r i n t T a b ( i n t data, i n t N) p r i n t f ( "[%d ", tab [ 0 ] ) ; i n t j ; f o r ( j = 1 ; j < N; j ++) p r i n t f ( ", %d ", data [ j ] ) ; p r i n t f ( " ] \ n " ) ; i n t main ( ) i n t N = 1 5 ; i n t data [N ] ; f i l l T a b ( data, N, 4 2 ) ; printtab ( data, N ) ; r e t u r n 0 ; 37

39 Large class Grosse classe... God Class Trop de variables d instance Trop de responsabilités Solutions Extract class Extract subclass... 38

40 Exemple c l a s s Student d e f i n i t i a l i z e ( f i r s t n a m e, lastname, day, month, year, s t u d y y e a r, c o u r s e s l i s t f i r s t n a m e = f i r s t n a m = l a s t n a m = = = y e a s t u d y y e a r = s t u d y y e a c o u r s e l i s t = c o u r s e s l i s t end d e f p r i n t n a m e puts "#@ firstname #@lastname " end d e f b i r t h y e a end d e f age end d e f i s r e g i s t e r e d ( c o u r s e c o u r s e l i s t. i n c l u d e? c o u r s e end end 39

41 Après refactoring I c l a s s Date d e f i n i t i a l i z e ( day, month, y e a r = = = y e a r end a t t r _ r e a d e r end : y e a r c l a s s Person d e f i n i t i a l i z e ( f i r s t n a m e, lastname, b i r t h d a t e f i r s t n a m e = f i r s t n a m = l a s t n a m b i r t h d a t e = b i r t h d a t e end d e f p r i n t n a m e puts "#@ firstname #@lastname " end d e f age birthdate. year end end 40

42 Après refactoring II c l a s s Student < Person d e f i n i t i a l i z e ( f i r s t n a m e, lastname, b i r t h d a t e, s t u d y y e a r, c o u r s e s l i s t ) s u p e r ( f i r s t n a m e, lastname, b i r t h d a t e s t u d y y e a r = s t u d y y e a c o u r s e l i s t = c o u r s e s l i s t end a t t r _ r e a d e r : c o u r s e s l i s t d e f i s r e g i s t e r e d ( c o u r s e c o u r s e l i s t. i n c l u d e? c o u r s e end end 41

43 Refactoring et développement agile Itérations courtes : développement, test, refactoring... Le refactoring ne doit pas affecter les fonctionnalités existantes Idéalement, tests après chaque transformation du code 42

44 Exemple I <html> <head>< t i t l e>mon A p p l i c a t i o n</ t i t l e></ head> <body> <h1>a c c u e i l</h1> <u l> < l i ><a h r e f=" page1. htm">page 1</a></ l i > < l i ><a h r e f=" page2. htm">page 2</a></ l i > < l i ><a h r e f=" page3. htm">page 3</a></ l i > </ u l> </ body> </ html> <html> <head>< t i t l e>mon A p p l i c a t i o n</ t i t l e></ head> <body> <h1>page 1</h1> <u l> < l i ><a h r e f=" page1 1.htm">Page 1</a></ l i> < l i ><a h r e f=" page1 2.htm">Page 2</a></ l i> </ u l> </ body> </ html> 43

45 Exemple II <html> <head>< t i t l e>a c c u e i l</ t i t l e></ head> < s c r i p t type=" t e x t / j a v a s c r i p t " s r c=" j q u e r y min. j s "></ s c r i p t> < s c r i p t type=" t e x t / j a v a s c r i p t " s r c=" s c r i p t. j s "></ s c r i p t> <body> <u l i d=" menu1 "> < l i ><a h r e f=" page1. htm">page 1</a></ l i > < l i ><a h r e f=" page2. htm">page 2</a></ l i > < l i ><a h r e f=" page3. htm">page 3</a></ l i > </ u l> <u l i d=" menu2 " s t y l e=" d i s p l a y : none "> < l i ><a h r e f=" page1 1.htm">Page 1</a></ l i> < l i ><a h r e f=" page1 2.htm">Page 2</a></ l i> </ u l> </ body> </ html> $ ( f u n c t i o n ( ) $ ( # menu1 li a:nth - child (1) ). c l i c k ( f u n c t i o n ( ) $ ( # menu1 ). h i d e ( ) ; $ ( # menu2 ). show ( ) ; ) ; ) ; 44

46 Exemple III <html> <head>< t i t l e>a c c u e i l</ t i t l e></ head> < s c r i p t type=" t e x t / j a v a s c r i p t " s r c=" j q u e r y min. j s "></ s c r i p t> < s c r i p t type=" t e x t / j a v a s c r i p t " s r c=" s c r i p t. j s "></ s c r i p t> <body> <u l i d="menu"></ u l> </ body> </ html> " data " : [ "id" : " menu1 ", " content " : [ " name " : " Page 1", " url " : " page1. html ", " name " : " Page 2", " url " : " page2. html ", " name " : " Page 3", " url " : " page3. html " ], "id" : " menu2 ", " content " : [ " name " : " Page 1", " url " : " page1-1. html ", " name " : " Page 2", " url " : " page1-2. html " ] ] $ ( f u n c t i o n ( ) $. getjson ( "data.json ", f u n c t i o n ( data ) //... $ ( # menu ). html ( c o n t e n t ) ; ) ; ) ; 45

47 Troisième partie Gestion de projet

48 L outil Trello 47

49 Crédits Photos des livres depuis Amazon 48