Ratio de encapsulación
| Sigla | E_RAT |
| Aspecto | «Encapsulación» |
| Se mide en | paquete, módulo |
| Tipo de valor | proporción, que se muestra como porcentaje (0 % a 100 %) |
| Dirección | informativa: ni alto ni bajo es mejor |
| Origen | herramienta MetricsReloaded; no se ha encontrado una definición en la literatura académica |
| Stau Metro | EncapsulationRatioPackage, EncapsulationRatioModule |
En pocas palabras
De las clases de un paquete (o de un módulo), ¿cuántas usa solo el propio paquete? Si ninguna clase de fuera usa ninguna de las suyas, vale 100 %; si el resto del proyecto usa todas, 0 %. Separa las clases que forman la cara pública del paquete de las que son detalle interno.
Qué mide
Mide la encapsulación a escala de paquete o de módulo, por el uso real y no por la visibilidad declarada. Un paquete bien encapsulado ofrece unas pocas clases al resto del sistema y esconde detrás las que hacen el trabajo: esas otras se pueden cambiar, renombrar o borrar sin tocar nada fuera del paquete.
Las métricas de ocultación MOOD («AHF», «MHF») miran los
modificadores de los miembros. E_RAT mira las clases y si alguien de fuera las usa: una clase public que solo se
usa dentro de su paquete cuenta como encapsulada.
Cómo se calcula
Para un paquete o un módulo :
La herramienta que la definió, MetricsReloaded, la describe así: la proporción de clases encapsuladas entre todas las clases del paquete (o del módulo), donde una clase está encapsulada si no se usa fuera de él. Qué cuenta como clase y como «uso» queda a cada herramienta.
Ejemplo
Cinco clases en dos paquetes, cada una en su fichero:
// paquete shop
public class OrderService { // la usa web.OrderController: externa
private final TaxTable taxes = new TaxTable();
}
public class TaxTable { } // solo la usa OrderService, del mismo paquete: interna
class PriceRules { } // de paquete: interna sin más comprobación
public class LegacyExporter { } // no la usa nadie: interna
// paquete web
public class OrderController { // no la usa nadie: interna
private shop.OrderService service;
}
shop: 3 internas de 4 clases, . web: 1 de 1, .
Fíjate en LegacyExporter: cuenta como interna porque nada la usa, aunque es pública. Y en web, que vale 100 %
porque nadie usa su controlador; es lo esperable en una capa superior.
Cómo interpretarla
Un valor alto dice que la mayoría de las clases del paquete no se usan desde fuera: el paquete expone poco y puede cambiar por dentro con libertad. Pero también sale alto con código muerto, porque una clase que nadie usa cuenta como interna. Y sale alto, de forma natural, en las capas superiores (controladores, puntos de entrada, main), a las que nadie del proyecto llama.
Un valor bajo dice que el resto del proyecto usa directamente muchas de sus clases. Es lo esperable en un paquete de API, de modelo compartido o de utilidades; es una señal de alarma en un paquete que debería ser un detalle interno de otro.
MetricsReloaded considera que el valor «debería ser bastante alto» en los paquetes y «próximo al 100 %» en los módulos. Stau Metro la trata como informativa y no tiene umbral de referencia para ella.
Qué hacer con un valor bajo inesperado: mira qué clases se usan desde fuera y desde dónde. Si se usan para
llegar a otras (navegar por el modelo, construir objetos), una fachada o una interfaz pública reducida suele
bastar. En el nivel de módulo, cuando el módulo del IDE corresponde a un módulo de Java, las clases que se usan
desde fuera dicen qué paquetes hay que exportar en su module-info.java.
Relación con otras métricas
- «Acoplamientos aferentes» (
Ca): cuántas clases de fuera dependen del paquete.E_RATmira el otro lado: cuántas de sus clases reciben esas dependencias. - «Número de paquetes dependientes» (
PDpt): desde cuántos paquetes se usa el paquete. - «Inestabilidad» (
I) y «abstracción» (A): un paquete muy usado desde fuera (bajoE_RAT) suele ser estable, y conviene que sea abstracto. - «Número de dependientes» (
Dpt): por clase; las clases con dependientes fuera del paquete son las que restan enE_RAT. - «Factor de ocultación de métodos» (
MHF) y «de atributos» (AHF): la encapsulación de los miembros, por visibilidad declarada. - «Número de clases de producción» (
Cp): casi la misma población que el denominador;Cpcuenta además las clases anónimas y locales, queE_RATdeja fuera.
En las herramientas
Stau Metro (EncapsulationRatioPackage por paquete, EncapsulationRatioModule por módulo). El paquete no
incluye sus subpaquetes: una referencia desde un subpaquete cuenta como externa.
- Son clases del paquete o del módulo sus clases Java de producción con nombre, también las anidadas, las interfaces, los enumerados, los records y las anotaciones. No cuentan las clases de test, ni las anónimas, ni las locales.
- Una clase es interna si ninguna referencia desde fuera de su paquete (o módulo) la usa. Se ignoran las
referencias desde código de test, desde comentarios Javadoc o KDoc y desde los
import. - Cuentan las referencias desde código Kotlin y desde ficheros
package-info.java(una anotación de paquete usa la anotación). En el nivel de paquete solo cuentan las referencias desde código; en el de módulo, también las de otros ficheros, como XML. - En el nivel de paquete, una clase
privateo de paquete es interna sin más comprobación. - Se buscan las referencias en todo el proyecto, no solo en el ámbito analizado.
- Un paquete o módulo sin clases de producción, por ejemplo uno que solo tiene tests, no tiene valor.
MetricsReloaded (plugin de IntelliJ IDEA). Define E_RAT para paquetes y módulos como la proporción de clases
encapsuladas, las que no se usan fuera del paquete o del módulo.
Referencias
- MetricsReloaded, descripciones de
EncapsulationRatioPackageyEncapsulationRatioModule: https://github.com/BasLeijdekkers/MetricsReloaded - Wikipedia, «Encapsulation (computer programming)»: https://en.wikipedia.org/wiki/Encapsulation_(computer_programming)