Cette m\u00e9trique est bas\u00e9e sur :<\/p>\n
- \n
- A: Assignation d’une valeur \u00e0 une variable.<\/li>\n
- B: Branche, appel d’une function ou d’un nouvel objet.<\/li>\n
- C: Condition, un test.<\/li>\n<\/ul>\n
J’ai t\u00e9l\u00e9charg\u00e9 le plugin ABC depuis cette page<\/a> sur le site d’eXcentia, et l’ai install\u00e9 dans mon environnement Sonar.<\/p>\n
Ensuite, j’ai cr\u00e9\u00e9 une classe \u2018TestAssignment.java\u2019 compos\u00e9 de 50 assignations comme celles-ci:<\/p>\n
int var1=0;<\/address>\nint var2=0;<\/address>\n\u2026<\/address>\nJ’ai lanc\u00e9 une analyse Sonar depuis Jenkins (si vous souhaitez tenter par vous-m\u00eames, vous pouvez vous r\u00e9f\u00e9rer \u00e0 certains posts ant\u00e9rieurs tels que celui-ci<\/a>).<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABC1Class-300x165.jpg\" "\\"ABC1Class\\"")
<\/a> Voici le r\u00e9sultat : un unique \u00e9difice pour une classe unique. Et voici les valeurs obtenues :<\/p>\n- \n
- ABC = 50, correspondant aux 50 assignations que nous avons cr\u00e9\u00e9es.<\/li>\n
- LOC = 55, correspondant aux 50 assignations et quelques lignes suppl\u00e9mentaires afin de d\u00e9clarer la classe et son unique m\u00e9thode.<\/li>\n
- Complexity = 1, le minimum possible puisqu’il n’y a aucune complexit\u00e9.<\/li>\n<\/ul>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABC1Measure.jpg\" "\\"ABC1Measure\\"")
<\/a><\/p>\nEnsuite, j’ai cr\u00e9\u00e9 une nouvelle classe \u2018TestCondition.java\u2019 avec le code suivant:<\/p>\n
public class TestCondition {<\/address>\n int var1=0;<\/address>\n public TestCondition() {<\/address>\n if (this.var1 = 0){<\/address>\n this.var1 = 1;<\/address>\n }<\/address>\n else{<\/address>\n this.var1 = 2;<\/address>\n }<\/address>\n…<\/address>\net le test dans ce code dupliqu\u00e9 8 fois, afin d’obtenir aproximativement le m\u00eame nombre de lignes de code que la classe pr\u00e9c\u00e9dente TestAssignment. A noter que nous aurons \u00e9galement 25 assignations: 3 dans chaque test x 8 duplications du test = 24 + 1 correspondant \u00e0 la d\u00e9claration initiale de la variable var1.<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABC2Class-300x135.jpg\" "\\"ABC2Class\\"")
<\/a>J’obtiens maintenant deux \u00e9difices, de la m\u00eame taille puisque ces deux classes ont (presque) le m\u00eame nombre de LOC mais l’une est en rouge puisque son niveau de CC par m\u00e9thode est \u00e9lev\u00e9.<\/p>\nCependant, la m\u00e9trique ABC pour cette nouvelle classe n’est que tr\u00e8s l\u00e9g\u00e8rement sup\u00e9rieure aux 25 assignations dans son code, ce qui montre que la complexit\u00e9 ne p\u00e8se pas beaucoup dans le r\u00e9sultat.<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABC2Measure.jpg\" "\\"ABC2Measure\\"")
<\/a><\/p>\nComme vous pouvez l’imaginer, j’ai ensuite cr\u00e9\u00e9 une troisi\u00e8me classe \u2018TestBranch.java\u2019 avec 50 instructions ‘new’ :<\/p>\n
TestCondition myCondition1 = new TestCondition();<\/address>\nTestCondition myCondition2 = new TestCondition();<\/address>\n…<\/address>\nTestCondition myCondition50 = new TestCondition();<\/address>\n <\/address>\n![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABC3Class-300x149.jpg\" "\\"ABC3Class\\"")
<\/a>La hauteur reste la m\u00eame, mais maitenant la valeur ABC est la plus importante puisque nous avons 50 assignations qui accompagnent les 50 traitements de type ‘Branch’.<\/p>\nCependant, la m\u00e9trique ABC n’a pas doubl\u00e9 para rapport \u00e0 la classe TestAssignement. Cette derni\u00e8re comporte 50 assignations pour une valeur ABC de 50, alors que la classe TestBranch a 50 assignations ET 50 ‘branches’, mais une valeur ABC l\u00e9g\u00e8rement au-dessus de 70.<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABC3Measure.jpg\" "\\"ABC3Measure\\"")
<\/p>\nDonc, que pouvons nous dire au sujet de cette m\u00e9trique ABC?<\/p>\n
Tout d’abord, nous pouvons voir diff\u00e9rentes valeurs pour ces trois classes comportant un m\u00eame nombre de LOC. Donc la m\u00e9trique ABC est bien ind\u00e9pendante du nombre de lignes de code.<\/p>\n
Cela dit, je ne suis pas certain qu’on puisse l’utiliser comme une mesure de la productivit\u00e9 ou de l’effort de maintenance puisque que nous pouvons constater que le A de Assignment p\u00e8se beaucoup dans son calcul. Le C de Condition est clairement sous-\u00e9valu\u00e9. Or il est \u00e9vident que l’effort n\u00e9cessaire pour effectuer une modification dans une structure de 8 ‘if-else’ est plus \u00e9lev\u00e9 que pour introduire une modification dans une s\u00e9quence de 50 assignations. D’autant que les conditions seront le plus souvent imbriqu\u00e9es (un if dans un if dans un autre if, etc.)<\/p>\n
Et la plupart du temps, un branchement occasionnera de nouvelles assignations. Et nous pouvons voir \u00e9galement que ajouter 50 branches \u00e0 50 assignations ne double pas le r\u00e9sultat par rapport \u00e0 50 assignations sans aucun branchement. Ceci est d\u00fb \u00e0 la formule de calcul de la m\u00e9trique ABC. Alors qu’en fait, je pense que l’effort du programmeur sera multipli\u00e9 par bien plus de deux.<\/p>\n
Aussi, quel usage pouvons nous faire de la m\u00e9trique ABC ? A cause de la pr\u00e9dominance du A de Assignment et de la sous-\u00e9valuation du C de Condition et, dans une moindre mesure, du B de Branch, je pense que cette m\u00e9trique est plus orient\u00e9e ‘donn\u00e9es’ que ‘logique’. Ce qui n’est pas un probl\u00e8me, puisque nous b\u00e9n\u00e9ficions d\u00e9j\u00e0 de la Complexit\u00e9 Cyclomatique pour \u00e9valuer la complexit\u00e9 fonctionnelle.<\/p>\n
Donc j’ai cr\u00e9\u00e9 une nouvelle mod\u00e9lisation d’une City avec:<\/p>\n
- \n
- La hauteur toujours bas\u00e9e sur le nombre de LOC.<\/li>\n
- La largeur bas\u00e9e sur le nombre d’assignations, le A de la m\u00e9trique ABC.<\/li>\n
- La couleur bas\u00e9e sur la valeur globale de la m\u00e9trique, de 1 (vert) \u00e0 100 (rouge).<\/li>\n<\/ul>\n
Voici ce que j’obtiens pour les trois classes de mon test :<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABCCity.jpg\" "\\"ABCCity\\"")
<\/a><\/p>\nLes trois \u00e9difices ont toujours la m\u00eame hauteur.<\/p>\n
Le plus petit en vert est la classe TestCondition avec une largeur de 25 correspondant \u00e0 ses 25 assignations et une couleur correspondant \u00e0 sa valeur ABC de 26.2, donc sous-\u00e9valuant le C de Condition.<\/p>\n
Les deux autres blocks correspondent aux classes TestAssignment et TestBranch avec une m\u00eame largeur de 50 correspondant au nombre d’assignations mais le building TestBranch est plus rouge que celui pour TestAssignment \u00e0 cause des traitements de branchement.<\/p>\n
Cette repr\u00e9sentation visuelle permet de mieux comprendre comment utiliser la m\u00e9trique ABC. Je ne l’utiliserais pas pour mesurer l’effort de maintenance mais plut\u00f4t l’orientation ou le poids des donn\u00e9es dans un objet, en prenant en compte la largeur de chaque \u00e9difice, et une mesure globale du risque pour ce composant, bas\u00e9e sur sa couleur. Un composant sera risqu\u00e9 soit parce qu’il pr\u00e9sente une certaine complexit\u00e9 ou plus probablement un couplage important en plus de son poids en structures de donn\u00e9es.<\/p>\n
Le plugin ABC de eXcentia vient avec son propre widget (nous avons vu dans notre post pr\u00e9c\u00e9dent<\/a> comment l’ajouter dans notre dashboard Sonar afin de le personnaliser) :<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABCWidget1.jpg\" "\\"ABCWidget\\"")
<\/a><\/p>\nNous pouvons voir diff\u00e9rents nombres pour la m\u00e9trique ABC:<\/p>\n
- \n
- Un total de 134.9 sur l’ensemble de l’application.<\/li>\n
- Une moyenne de 45 par classe, ce qui repr\u00e9sente un risque mod\u00e9r\u00e9 au niveau d’une classe.<\/li>\n
- Une moyenne de 45 par m\u00e9thode, ce qui repr\u00e9sente un risque plus \u00e9lev\u00e9 et un refactoring devrait \u00eatre envisag\u00e9 pour les 2 m\u00e9thodes avec une valeur ABC sup\u00e9rieure \u00e0 45.<\/li>\n<\/ul>\n
Donc ce widget est en ligne avec l’utilisation que nous recommandons pour la m\u00e9trique ABC, bas\u00e9e sur le risque d’introduire un d\u00e9faut lorsqu’une modification est effectu\u00e9e sur un composant.<\/p>\n
Et si je souhaite une meilleure appr\u00e9ciation de ce risque, le plugin ABC me permet d’effectuer un drill-down.<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABC4Class.jpg\" "\\"ABC4Class\\"")
<\/a>Ici, j’ai s\u00e9lectionn\u00e9 l’\u00e9difice le plus \u00e0 risque dans ma mod\u00e9lisation de City, correspondant \u00e0 la classe TestBranch, avec ses diff\u00e9rentes valeurs.<\/p>\nIl me suffit de cliquer sur son nom pour descendre jusqu’\u00e0 un onglet sp\u00e9cifique \u00e0 la m\u00e9trique et aux mesures ABC pour cet objet.<\/p>\n
![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABCOnglet.jpg\" "\\"ABCOnglet\\"")
<\/a><\/p>\n![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABCSessionUsuario.jpg\" "\\"ABCSessionUsuario\\"")
<\/a><\/p>\n![\"\"](\"http:\/\/qualilogy.com\/wp-content\/uploads\/2012\/03\/ABCSessionUsuarioMeasure1.jpg\" "\\"ABCSessionUsuarioMeasure\\"")
<\/a>Un drill-down sur cette classe montre la pr\u00e9sence de 71 Branchs et 112 Conditions dans son code. Cela confirme la sur\u00e9valuation des Assignments dans la valeur globale de la m\u00e9trique ABC.<\/p>\n