Complejidad ciclomática promedio
| Sigla | v(G)avg |
| Aspecto | «Complejidad» |
| Se mide en | paquete, módulo, proyecto |
| Tipo de valor | media (decimal, mínimo 1) |
| Dirección | más alto es peor |
| Familia | «Métricas de McCabe» |
| Stau Metro | AverageCyclomaticComplexityPackage, AverageCyclomaticComplexityModule, AverageCyclomaticComplexityProject |
En pocas palabras
Toma la complejidad ciclomática de cada método de un paquete, un módulo o el proyecto entero y hace la media. Dice cómo de complicado es, por término medio, un método de esa parte del código. Sirve para comparar paquetes o módulos de tamaños muy distintos.
Qué mide
El estilo de una parte del código en cuanto a lógica de decisión: si sus métodos tienden a ser lineales o a estar llenos de condiciones. Al ser una media, no depende del tamaño: un paquete de diez métodos y uno de mil se comparan directamente.
Cómo se calcula
Con la «complejidad ciclomática» de cada uno de los métodos del paquete, el módulo o el proyecto:
Es la media por método, no la media de las medias de cada clase: una clase con cien métodos pesa cien veces más que una con uno.
Ejemplo
Dos paquetes con la misma «complejidad ciclomática total»:
| Paquete | v(G) de sus métodos |
v(G)tot |
v(G)avg |
|---|---|---|---|
billing |
1, 1, 10 | 12 | 12 / 3 = 4.0 |
util |
2, 2, 2, 2, 2, 2 | 12 | 12 / 6 = 2.0 |
El total no los distingue; la media sí. Aun así, la media de billing no dice que su complejidad está en un solo
método: para eso hay que mirar los valores de v(G) por método.
Cómo interpretarla
Stau Metro no le da umbral de referencia. Una media cercana a 1 indica que casi ningún método toma decisiones (accesores, delegaciones), y cada punto más, una decisión más en el método típico.
- Comparar partes del proyecto: un paquete con una media claramente por encima de la del proyecto concentra la lógica de decisión. Puede ser lo esperado (el núcleo del dominio, un analizador) o una señal de diseño procedimental.
- Seguir la evolución: una media que sube en cada versión indica que los métodos crecen por dentro en lugar de repartirse.
Ojo. La media es muy sensible a la cantidad de métodos triviales. Un paquete lleno de getters y setters tiene una media baja aunque esconda métodos de complejidad 30. Las distribuciones de
v(G)son muy asimétricas, y para encontrar los problemas importan más los máximos que la media. Ver «agregar métricas».
Relación con otras métricas
- «Complejidad ciclomática» (
v(G)): la medida por método que se promedia, con el mismo recuento. - «Complejidad ciclomática total» (
v(G)tot): el numerador de esta media; juntas dicen si un total alto viene de muchos métodos o de métodos complejos. - «Número de métodos» (
METH): da una idea del tamaño del conjunto, pero no es el divisor de esta media: cuenta también los métodos abstractos y los de las clases anónimas y locales. - «Complejidad promedio de las operaciones» (
OCavg): la misma idea por clase, con un recuento que no incluye&&,||nicatch.
En las herramientas
Stau Metro (AverageCyclomaticComplexityPackage, AverageCyclomaticComplexityModule y
AverageCyclomaticComplexityProject). Divide la suma de la v(G) de los métodos entre el número de esos métodos,
con el mismo recuento y el mismo alcance que la métrica de método CyclomaticComplexity:
- entran todos los métodos no abstractos de los ficheros Java analizados, incluidos los constructores, los métodos
default,staticy privados de las interfaces, y el código de test; un métodonativecuenta con 1; - los métodos de las clases anónimas o locales declaradas dentro de un método no cuentan aparte: sus decisiones se suman al método que las contiene; los de las clases anónimas de un inicializador de campo y de los cuerpos de las constantes de un enumerado sí cuentan como métodos;
- a nivel de paquete entran solo las clases del propio paquete, no las de sus subpaquetes;
- un paquete o un módulo tiene valor desde su primer método contado; el proyecto tiene siempre su fila.
Así, v(G)avg es exactamente v(G)tot entre el número de métodos con valor de v(G) en ese paquete, módulo o
proyecto.
SonarQube. Su documentación de métricas no define una complejidad media; solo la complejidad ciclomática
(complexity), que para el conjunto del código es, según esa documentación, «básicamente la suma» de las
calculadas por función.
Referencias
- McCabe, T. J. (1976). «A Complexity Measure». IEEE Transactions on Software Engineering, SE-2(4), 308-320. https://ieeexplore.ieee.org/document/1702388
- SonarQube, definición de métricas: https://docs.sonarsource.com/sonarqube-server/latest/user-guide/code-metrics/metrics-definition/