Tamaño promedio de las operaciones
| Sigla | OSavg |
| Aspecto | «Tamaño» |
| Se mide en | clase |
| Tipo de valor | media (decimal, mínimo 0) |
| Dirección | más alto es peor |
| Stau Metro | AverageOperationSize |
En pocas palabras
Divide el número de sentencias de una clase entre el número de sus métodos. Responde a una pregunta sencilla: ¿los métodos de esta clase suelen ser cortos o largos? Una media alta indica métodos largos, que cuesta más entender y probar.
Qué mide
El tamaño típico de un método dentro de una clase. No dice cuánto código tiene la clase (para eso están el «número de métodos» o las «líneas de código»), sino cómo se reparte entre sus métodos: una clase con diez métodos de tres sentencias y otra con dos métodos de quince pueden tener un tamaño total parecido, pero la segunda es más difícil de seguir.
Ojo. A pesar de la palabra «tamaño», esta métrica cuenta sentencias, no líneas. Una sentencia repartida en cinco líneas cuenta 1; cinco sentencias en una línea, 5.
Cómo se calcula
Reglas que fijan el código y los tests de Stau Metro:
- El denominador cuenta los métodos y constructores que tienen cuerpo. Los métodos abstractos (y los
native) no entran. - El numerador cuenta las sentencias dentro de esos métodos, a cualquier profundidad. No cuentan las llaves de un
bloque ni la sentencia vacía (
;), y sí las demás sentencias, anidadas o no. - Las sentencias de las lambdas y de las clases anónimas o locales declaradas dentro de un método se suman a ese método; los métodos de esas clases no se cuentan como métodos aparte.
- Las sentencias fuera de un método no cuentan: ni las de los bloques de inicialización (
{ … },static { … }) ni las de una lambda que inicializa un campo. - Las clases anónimas o locales que están fuera de un método (en un inicializador de campo, en un bloque de inicialización o en el cuerpo de una constante de enumerado) no aportan ni métodos ni sentencias a la clase.
- Una clase anidada con nombre tiene su propio valor y no suma a la que la contiene. Los métodos
defaultde una interfaz anidada tampoco suman. - Una clase sin ningún método con cuerpo no tiene valor (no se divide entre cero).
Ejemplo
class Invoice {
private final double rate;
Invoice(double rate) { this.rate = rate; } // 1 sentencia
double total(List<Double> amounts) {
double sum = 0; // 1
for (double a : amounts) { // 1 (el for mejorado)
sum += a * rate; // 1 (las llaves no cuentan)
}
return sum; // 1
} // total del método: 4
void reset() { } // 0 sentencias
}
Hay tres métodos con cuerpo (el constructor, total y reset) y 1 + 4 + 0 = 5 sentencias: OSavg = 5 / 3 ≈ 1,67.
Un for clásico pesa más de lo que parece: en for (int i = 0; i < n; i++) total += i; hay cuatro sentencias en
el árbol sintáctico, el propio for, la declaración int i = 0, la actualización i++ y el cuerpo.
Cómo interpretarla
Stau Metro no trae umbral de referencia para esta métrica. Úsala de forma relativa: compara clases de un mismo proyecto y busca las que se alejan de la media del resto.
- Alta: los métodos tienden a ser largos. Suele mejorar extrayendo métodos.
- Baja: métodos cortos. Es lo habitual en clases con muchos métodos de acceso. Una media muy baja en una clase con mucha lógica puede indicar, en cambio, que la lógica está dispersa en muchos fragmentos diminutos.
La media oculta los valores extremos: una clase con nueve métodos de una sentencia y uno de cien da una media de 10,9 que no describe a ninguno. Léela siempre junto al «tamaño máximo de las operaciones».
Relación con otras métricas
- «Tamaño máximo de las operaciones» (
OSmax): el mismo recuento, pero el máximo en lugar de la media. Se leen juntas. - «Número de sentencias» (
STAT): el numerador es la suma de su valor por método en los métodos de la clase. ElSTATde la clase puede ser mayor, porque suma también las sentencias de los bloques de inicialización y de las clases anónimas de los campos. - «Número de métodos» (
METH): se parece al denominador, pero a nivel de paquete, módulo y proyecto. - «Complejidad promedio de las operaciones» (
OCavg): la media de la complejidad en lugar del tamaño; Stau Metro aplica a ambas las mismas reglas sobre qué métodos y clases anónimas entran. - «Líneas de código» (
LOC): la medida de tamaño en líneas, con otra unidad.
En las herramientas
Stau Metro (AverageOperationSize, a nivel de clase). Se calcula para las clases con nombre, incluidas las
abstractas, los enumerados y los records, y no para las interfaces. Las clases anónimas y locales no tienen fila
propia. Los constructores cuentan como métodos (también el constructor compacto de un record; los que genera el
compilador no, porque no tienen cuerpo en el fuente). Un for clásico aporta hasta tres sentencias por sí mismo (él,
su inicialización y su actualización, si las tiene), más las de su cuerpo; un for mejorado, una.
La unidad es la sentencia, no la línea: la ayuda del plugin lo advierte. Los valores no son comparables con los de una herramienta que mida el tamaño medio de un método en líneas.
MetricsReloaded (OSavg). Su descripción la define como el tamaño medio, en sentencias, de los métodos no
abstractos de la clase, sin contar los heredados, y su código cuenta las sentencias igual (sin bloques ni sentencias
vacías). El alcance es otro: los métodos de las clases anónimas, también las de los campos, cuentan como métodos de la
clase que las contiene, y las sentencias de los bloques de inicialización suman al numerador. Las clases locales
tienen valor propio.
Referencias
- MetricsReloaded, descripción de Average operation size: https://github.com/BasLeijdekkers/MetricsReloaded/blob/master/stockmetrics/metricsDescriptions/metricsDescriptions/AverageOperationSize.html
- MetricsReloaded, código del cálculo: https://github.com/BasLeijdekkers/MetricsReloaded/blob/master/stockmetrics/src/com/sixrr/stockmetrics/classCalculators/AverageOperationSizeCalculator.java