Número promedio de parámetros
| Sigla | OPavg |
| Aspecto | «Complejidad» |
| Se mide en | clase |
| Tipo de valor | media (número real, mínimo 0) |
| Dirección | más alto es peor |
| Stau Metro | AverageOperationParameters |
En pocas palabras
Suma los parámetros de todos los métodos de una clase y divide entre el número de métodos. Una clase cuyos métodos reciben de media 0,5 parámetros tiene interfaces pequeñas; una con media 4 obliga a quien la usa a pasar mucha información en cada llamada.
Qué mide
Es el «número de parámetros» (NP) resumido a nivel de clase: el estilo de las firmas de la clase
en un solo número. Sirve para comparar clases entre sí sin revisar cada método, y para encontrar las clases cuyos
métodos tienden a recibir muchos datos de fuera, que a menudo son clases de servicio que operan sobre datos que no
les pertenecen.
Cómo se calcula
Qué cuenta como «método de la clase» depende de la herramienta. No se ha encontrado una definición original publicada con este nombre; la de Stau Metro se detalla en «En las herramientas».
Ejemplo
class Account {
private long balance;
Account(long initial) { // constructor: 1 parámetro
balance = initial;
}
void deposit(long amount) { // 1 parámetro
balance += amount;
}
void transfer(Account to, long amount, String reference) { // 3 parámetros
balance -= amount;
to.deposit(amount);
}
long balance() { // 0 parámetros
return balance;
}
}
Parámetros: 1 + 1 + 3 + 0 = 5. Métodos (con el constructor): 4. OPavg = 5 / 4 = 1,25.
Cómo interpretarla
Stau Metro no le da umbrales de referencia, y no se ha encontrado ninguno publicado para la media. Si quieres una
referencia, los umbrales de NP por método (aviso por encima de 5 en Stau Metro, máximo de 7 en Checkstyle) dan una
idea de lo que ya es mucho para un método aislado; una media que se acerca a ellos es muy alta. Algunas pautas:
- Una media alta dice que la mayoría de los métodos reciben muchos datos. Merece la pena buscar grupos de parámetros que se repiten en varias firmas: son candidatos a un objeto parámetro o a campos de la propia clase.
- Una media baja no garantiza nada. Un método de doce parámetros entre diez getters da una media de alrededor de
1,1. Para encontrar ese método está
NP. - Las clases de valor y los
recordcon muchos campos suben la media por su constructor; las clases con muchos getters la bajan. Compara clases con responsabilidades parecidas.
Ojo. Como toda media, esconde los extremos. Úsala para comparar clases y
NPpara actuar sobre métodos.
Relación con otras métricas
- «Número de parámetros» (
NP): la métrica de método que esta promedia. - «Complejidad promedio de las operaciones» (
OCavg) y «tamaño promedio de las operaciones» (OSavg): las otras medias por método de una clase; juntas describen el método «típico» de la clase.
En las herramientas
Stau Metro (AverageOperationParameters, a nivel de clase). Divide la suma de parámetros entre el número de
métodos escritos en la propia clase, contando los constructores y los métodos abstractos. No cuenta los heredados
ni los que genera el compilador sin aparecer en el código: el constructor por defecto, los accesores de un record,
values() y valueOf() de un enumerado. Se calcula para las clases, incluidas las abstractas, los enumerados y los
record; no para las interfaces ni para las clases anónimas o locales. Cada clase anidada tiene su propio valor, y
sus métodos no entran en el de la clase que la contiene. Una clase sin ningún método escrito no tiene valor.
MetricsReloaded (OPavg). Divide igualmente la suma de parámetros de los métodos de la clase, constructores
incluidos, entre su número; a una clase sin métodos le asigna 0 en vez de dejarla sin valor.
Referencias
- MetricsReloaded (código fuente): https://github.com/BasLeijdekkers/MetricsReloaded
- Checkstyle, comprobación
ParameterNumber: https://checkstyle.sourceforge.io/checks/sizes/parameternumber.html