Complejidad ponderada de los métodos
| Sigla | WMC |
| Aspecto | «Complejidad» |
| Se mide en | clase |
| Tipo de valor | recuento (entero, mínimo 0) |
| Dirección | más alto es peor |
| Umbrales de referencia | aviso por encima de 31, error por encima de 47 (Stau Metro) |
| Origen | Shyam R. Chidamber y Chris F. Kemerer, 1994 |
| Familia | «Métricas de Chidamber y Kemerer» |
| Stau Metro | WeightedMethodComplexity |
En pocas palabras
Suma lo complicados que son todos los métodos de una clase. Una clase con muchos métodos sencillos y una con pocos métodos llenos de decisiones pueden dar el mismo número: las dos dan mucho trabajo. Cuanto más alto, más cuesta entender la clase, probarla y cambiarla sin romper nada.
Qué mide
El volumen de lógica de una clase: cuántos métodos tiene y cuánta decisión hay dentro de cada uno. Es la primera de las seis métricas de Chidamber y Kemerer (CK).
Chidamber y Kemerer la justificaban con tres ideas:
- el número de métodos y su complejidad predicen el tiempo y el esfuerzo que cuesta desarrollar y mantener la clase;
- cuantos más métodos tiene una clase, mayor es el impacto potencial sobre sus subclases, que los heredan;
- las clases con muchos métodos tienden a ser específicas de una aplicación, y se reutilizan peor.
Para quien empieza. «Ponderada» quiere decir que cada método no cuenta 1, sino lo que pesa su complejidad. Si todos los métodos pesaran 1,
WMCsería simplemente el número de métodos.
Cómo se calcula
Para una clase con métodos y complejidades :
Chidamber y Kemerer dejaron sin definir a propósito cómo se mide la complejidad de cada método, para que la métrica sirviera con cualquier medida. Si todas valen 1, . En la práctica hay dos lecturas:
- ponderación unitaria: , y
WMCes el número de métodos de la clase; - ponderación ciclomática: es la «complejidad ciclomática» del método. Es la más extendida; la usan, por ejemplo, PMD y la herramienta CK.
Se cuentan los métodos declarados en la clase, no los heredados. Qué pasa con los constructores, los métodos abstractos, las clases anidadas o las anónimas depende de la herramienta.
Ejemplo
Con las reglas de Stau Metro, que cuentan if, bucles, ? : y grupos de case, pero no &&, || ni catch:
class Account {
private int balance;
Account(int initial) { // 1
balance = initial;
}
void withdraw(int amount) { // 1
if (amount <= 0 || amount > balance) { // +1 if (el || no suma)
throw new IllegalArgumentException();
}
balance -= amount;
}
String describe() { // 1
return switch (Integer.signum(balance)) {
case -1 -> "negative"; // +1
case 0 -> "empty"; // +1
default -> "positive"; // default no suma
};
}
}
WMC = 1 (constructor) + 2 (withdraw) + 3 (describe) = 6. Con ponderación unitaria daría 3. Con la
v(G) de cada método, que sí cuenta el ||, la suma sería 7.
Cómo interpretarla
Stau Metro usa como referencia aviso por encima de 31 y error por encima de 47, y los presenta como los
valores «alto» y «muy alto» que dan Lanza y Marinescu (2006) para Java. PMD usa también 47 como valor «muy alto»
de WMC en su regla GodClass, con cita a ese libro, y calcula ese WMC sumando la complejidad ciclomática de
los métodos, con && y ||. El recuento de Stau Metro, sin &&, || ni catch, da valores iguales o más bajos,
así que con él esos umbrales se superan algo menos a menudo.
Un valor alto puede venir de dos sitios, y el remedio es distinto:
- Muchos métodos sencillos. Mira el «número de operaciones» (
CSO) y la «complejidad promedio de las operaciones» (OCavg). Si la media es baja, la clase hace demasiadas cosas: divídela por responsabilidades. La «falta de cohesión» suele señalar por dónde. - Pocos métodos muy complejos. Mira la
«complejidad máxima de las operaciones» (
OCmax). Si un método concentra casi todo, el problema es ese método: extrae partes, no clases.
Cuándo un valor alto es aceptable. Un analizador sintáctico, una máquina de estados o una clase que traduce
códigos tienen una lógica que no mejora al repartirla en clases artificiales. Una clase generada por una
herramienta tampoco se mantiene a mano. Y la métrica no ve la calidad de los nombres ni de la estructura: dos clases
con el mismo WMC pueden ser muy distintas de leer.
Ojo. No compares
WMCentre herramientas sin saber qué ponderación usa cada una. Con ponderación unitaria una clase de 40 métodos triviales vale 40; con ponderación ciclomática, una clase de 10 métodos también puede valer 40.
Para profundizar
Una métrica de tamaño con otro nombre. Con ponderación unitaria WMC es el número de métodos; con ponderación
ciclomática, es en buena parte el tamaño lógico de la clase, y hereda la fuerte correlación de v(G) con las
líneas de código. Conviene leerla junto a las «líneas de código» antes de concluir que
una clase es «compleja» y no simplemente «grande».
Suma frente a media. La suma no distingue una clase de cincuenta métodos de complejidad 1 de una de cinco
métodos de complejidad 10. Por eso tiene sentido leer WMC junto a la media (OCavg) y al máximo (OCmax).
En las estrategias de detección. Lanza y Marinescu combinan WMC con otras métricas para detectar defectos de
diseño. La regla GodClass de PMD, que sigue ese libro, señala una clase con WMC muy alto, mucho acceso a datos
de otras clases y baja «cohesión estrecha» (TCC). Ver
«Lanza y Marinescu: estrategias de detección».
Herencia. CK cuentan solo los métodos declarados en la clase. Una subclase pequeña de una jerarquía enorme
tiene un WMC bajo, aunque para entenderla haya que leer también lo heredado. La
«profundidad del árbol de herencia» (DIT) es la que mira esa dimensión.
Relación con otras métricas
- «Complejidad ciclomática» (
v(G)): la medida de cada método que se suma, en la ponderación más habitual (Stau Metro usa un recuento algo distinto; ver «En las herramientas»). - «Complejidad promedio de las operaciones» (
OCavg):WMCdividida por el número de métodos con cuerpo, en Stau Metro con el mismo recuento. - «Complejidad máxima de las operaciones» (
OCmax): el método que más aporta aWMC. - «Tamaño de la clase (operaciones)» (
CSO): el recuento de métodos de la clase. Se parece a unaWMCcon ponderación unitaria, pero en Stau MetroCSOcuenta también los métodos heredados yWMCsolo los declarados en la clase. - «Respuesta para la clase» (
RFC) y «acoplamiento entre objetos» (CBO): las otras métricas de CK que se suelen leer junto aWMC. - «Complejidad ciclomática total» (
v(G)tot): la misma idea de suma, por paquete, módulo o proyecto.
En las herramientas
Stau Metro (WeightedMethodComplexity, a nivel de clase). Suma, por cada método escrito en la clase que no sea
abstracto, 1 más 1 por cada if, for, for mejorado, while, do … while, operador ? :, grupo de case de
un switch con dos puntos o regla de uno con flechas (sin contar default) y guarda when. No cuenta los
operadores && y || ni los catch, a diferencia de su v(G), así que el WMC de una clase puede ser menor que la
suma de la v(G) de sus métodos. Además:
- entran los constructores; un método
native, que no tiene cuerpo, suma 1; los métodos abstractos no suman; - solo entran los métodos de la propia clase: los de sus clases anidadas no suman aquí, y cada clase anidada con nombre tiene su propio valor;
- las decisiones de las lambdas y de las clases anónimas o locales declaradas dentro de un método cuentan para ese método; las clases anónimas y locales no tienen valor propio;
- no cuentan los inicializadores de campos (tampoco los métodos de una clase anónima creada en uno), los bloques de inicialización ni los cuerpos de las constantes de un enumerado;
- se calcula para clases, también abstractas, enumerados y registros, pero no para interfaces; los métodos que el
compilador genera en enumerados y registros (
values(), los accesores implícitos) no cuentan; - una clase sin métodos vale 0.
PMD. Su métrica WMC es la suma del CYCLO de las operaciones de la clase, con las mismas opciones que
CYCLO. Según su código, CYCLO suma 1 por cada if, bucle, ? :, case que no sea default, catch y
throw, y por cada && y || de la condición de una sentencia de control (la opción ignoreBooleanPaths los
deja fuera). La regla GodClass señala una clase cuando su WMC llega a 47, su acceso a datos ajenos (ATFD)
pasa de 5 y su TCC queda por debajo de 1/3.
ckjm. Da a cada método complejidad 1: su WMC es el número de métodos de la clase.
CK (herramienta de Aniche para Java). Su documentación define WMC como la complejidad de McCabe: el número de
instrucciones de ramificación de la clase.
MetricsReloaded (complemento para IntelliJ IDEA). Su código fuente suma 1 por método no abstracto y 1 por cada
if, bucle, ? : y grupo de etiquetas de un switch con dos puntos, también el de default; no cuenta las
reglas con flecha, ni &&, || ni catch.
Referencias
- Chidamber, S. R. y Kemerer, C. F. (1994). «A Metrics Suite for Object Oriented Design». IEEE Transactions on Software Engineering, 20(6), 476-493. https://doi.org/10.1109/32.295895
- Lanza, M. y Marinescu, R. (2006). Object-Oriented Metrics in Practice. Springer. https://doi.org/10.1007/3-540-39538-5
- PMD, reglas de diseño para Java: https://docs.pmd-code.org/latest/pmd_rules_java_design.html
- PMD, código de la regla
GodClassy de las métricas de Java: https://github.com/pmd/pmd - ckjm, descripción de las métricas: https://www.spinellis.gr/sw/ckjm/doc/metric.html
- CK, documentación: https://github.com/mauricioaniche/ck
- MetricsReloaded, código fuente: https://github.com/BasLeijdekkers/MetricsReloaded