Perfil de criterios de calidad (mantenibilidad)
| Sigla | QCP_MAINT |
| Aspecto | «Complejidad» |
| Se mide en | método |
| Tipo de valor | puntuación (entero, mínimo 2): una suma ponderada de otras medidas |
| Dirección | informativa: ni alto ni bajo es mejor |
| Stau Metro | QCPMaintainability |
En pocas palabras
Junta en un solo número el tamaño de un método, cuántas sentencias y decisiones tiene, cuánto se anidan y cuántos
saltos (break, continue) hace. El tamaño pesa mucho más que lo demás. La idea es que un método que puntúa alto en
todo eso a la vez cuesta más de modificar. Es una de las tres puntuaciones «QCP».
Qué mide
Como las otras dos QCP, es una métrica sintética: suma medidas ya conocidas con pesos fijos. Según la documentación de la herramienta donde aparece, su intención es estimar la dificultad de mantener un método. Los ingredientes son:
- la «longitud de Halstead» (
N), el número total de operadores y operandos del método, que pesa el triple; - el «número de sentencias ejecutables» (
EXEC); - el «número de sentencias de control» (
CONTROL); - la profundidad máxima de anidamiento (
NEST), cercana a la «profundidad de anidamiento»; - el número de puntos de decisión (
V), una variante de la «complejidad ciclomática», que pesa el doble; - el «número de sentencias de ramificación» (
BRANCH).
Cómo se calcula
No se ha encontrado una publicación original que defina el perfil; la fórmula es la que documenta MetricsReloaded.
CONTROL, EXEC y V se cuentan igual que en el
«perfil de corrección». Los otros tres términos, en Stau Metro:
| Término | Qué cuenta |
|---|---|
N |
La longitud de Halstead del método: todas las apariciones de operadores y operandos |
NEST |
La mayor profundidad de estructuras anidadas. Abren un nivel if (un else if no abre otro), los bucles, switch (sentencia o expresión), try, synchronized y los bloques { } sueltos; no lo abren el bloque de un grupo case ni el de una regla ->, ni las lambdas, ni las clases anónimas o locales |
BRANCH |
1 por cada continue, cada break con etiqueta y cada break sin etiqueta que sale de un bucle; el break que cierra un case no cuenta |
Todo se mide sobre el método completo, incluidas las lambdas y las clases anónimas o locales que contenga.
Ejemplo
El mismo método que en el «perfil de corrección»:
int countDown(int n) {
int steps = 0; // EXEC +1
while (n > 0) { // CONTROL +1, V +1, NEST 1
if (n == 13) { // CONTROL +1, V +1, NEST 2
break; // CONTROL +1, BRANCH +1 (sale del while)
}
n--; // EXEC +1
steps++; // EXEC +1
}
return steps; // EXEC +1
}
N= 21: 12 apariciones de operadores (inttres veces,=,while,>,if,==,break,--,++,return) y 9 de operandos (stepstres veces,0dos,ntres,13una).EXEC= 4,CONTROL= 3,NEST= 2,V= 3,BRANCH= 1.
Total: 3 · 21 + 4 + 3 + 2 + 2 · 3 + 1 = 63 + 16 = 79.
Fíjate en que aporta 63 de los 79 puntos. En la práctica, QCP_MAINT ordena los métodos casi como lo haría su
longitud de Halstead.
Cómo interpretarla
Stau Metro la trata como informativa y no le da umbrales: no hay ninguno publicado. Sirve para ordenar los métodos de un mismo proyecto y para descomponer: ante un valor alto, mira qué término lo empuja. Casi siempre será , es decir, el método es largo; si no lo es, el valor viene del anidamiento o de la lógica de decisión, y merece más atención.
Qué hacer: lo mismo que con un método largo o anidado. Extrae métodos, aplana el anidamiento con cláusulas de guarda
y sustituye los break y continue de los bucles por condiciones explícitas o por métodos que devuelven pronto.
Ojo. Las tres QCP usan pesos distintos; sus valores no se comparan entre sí.
Para profundizar
Origen y validación. La referencia más antigua localizada es la documentación de MetricsReloaded, que la
describe como «una métrica sintética, diseñada para estimar la dificultad de mantenimiento de un método», con la
fórmula QCP_MAINT = (3*N) + EXEC + CONTROL + NEST + (2*V(g)) + BRANCH. No se ha encontrado ninguna publicación que
justifique los pesos ni ningún estudio que relacione la puntuación con el esfuerzo de mantenimiento.
Dominio del tamaño. crece con cada operador y cada operando, de modo que es, con diferencia, el término más
grande; multiplicado por 3, la puntuación es sobre todo una medida de tamaño. Los términos de estructura (NEST,
BRANCH) son números pequeños que apenas mueven el total.
Términos que se solapan. Un break dentro de un bucle suma en N (la palabra clave es un operador), en
CONTROL y en BRANCH. Un if suma en N, en CONTROL, dos veces en y puede subir NEST.
Relación con otras métricas
- «Perfil de criterios de calidad (corrección)» (
QCP_CRCT) y «(fiabilidad)» (QCP_RLBTY): las otras dos puntuaciones del perfil, con los mismos ingredientes y otros pesos. - «Longitud de Halstead» (
N): el término dominante. - «Número de sentencias de ramificación» (
BRANCH), «de control» (CONTROL) y «ejecutables» (EXEC): tres ingredientes, contados igual que en esas métricas. - «Profundidad de anidamiento» (
NBD): mide lo mismo queNESTcon otra regla para lambdas y clases internas, así que los dos valores pueden diferir. - «Complejidad ciclomática» (
v(G)): el término de decisiones es una variante suya sin&&,||nicatch. - «Índice de mantenibilidad» (
MI): la métrica compuesta de mantenibilidad más conocida, también construida con Halstead y McCabe.
En las herramientas
Stau Metro (QCPMaintainability, a nivel de método). Aplica la fórmula con las reglas de arriba. No se calcula
para los métodos abstractos ni para los métodos sin cuerpo de una interfaz; los métodos native sí reciben valor.
Los constructores cuentan como métodos. Lo que contienen las lambdas y las clases anónimas o locales del método se
suma al método, y esos métodos internos no tienen valor propio.
NEST no es exactamente el valor de la métrica NBD: NBD sí abre un nivel en el cuerpo de una lambda y en una clase
local o anónima. En un método sin lambdas ni clases internas los dos coinciden.
MetricsReloaded (QCP_MAINT). Misma fórmula. Como en QCP_CRCT, su término de decisiones suma también el grupo
de default de un switch clásico; en sus recuentos no entran las expresiones switch, las reglas ->, yield ni
las guardas when, y su N no incluye los operadores de asignación. Su NEST abre además un nivel en el bloque con
llaves de un grupo case. Su documentación dice que las puntuaciones más bajas son mejores.
Referencias
- MetricsReloaded, descripción de la métrica y código fuente: https://github.com/BasLeijdekkers/MetricsReloaded
- Halstead, M. H. (1977). Elements of Software Science. Elsevier North-Holland.