Guía del aspecto: Encapsulación
El aspecto responde a una pregunta: ¿cuánto del estado y del comportamiento interno queda escondido detrás de la interfaz pública? Lo que está escondido se puede cambiar sin avisar a nadie. Lo que está a la vista es parte del contrato: cualquier clase que lo vea puede depender de ello, y cambiarlo obliga a revisar a todas.
La idea viene de la ocultación de información de Parnas (1972): empezar por una lista de las decisiones de diseño
difíciles o que probablemente cambien, y diseñar cada módulo para que esconda una de ellas a los demás. En Java las
herramientas para hacerlo son los modificadores de acceso (private, sin modificador, protected, public) en
clases y miembros, y la elección de qué clases de un paquete usa el resto del código.
Las tres métricas del aspecto miran esto desde dos ángulos:
- la visibilidad declarada: qué parte de los campos y de los métodos del proyecto podrían ver las demás clases,
según sus modificadores (
AHFyMHF, de la familia MOOD); - el uso real: qué parte de las clases de un paquete o un módulo no usa nadie de fuera (
E_RAT).
Para quien empieza. Que un campo sea
privateno basta para que esté encapsulado. Si la clase tiene ungetX()que devuelve el objeto interno y unsetX()que lo sustituye, cualquiera puede leerlo y cambiarlo. Las métricas de este aspecto miran los modificadores y las referencias, no lo que hacen los métodos.
Por dónde empezar
- «Factor de ocultación de atributos» (
AHF): qué parte de la visibilidad posible de los campos queda oculta. Es la más fácil de leer: lo deseable es un valor alto, y cualquier caída llama a buscar campos públicos o de paquete. - «Factor de ocultación de métodos» (
MHF): lo mismo con los métodos. Aquí no se busca el 100 %: una clase tiene que ofrecer algo. - «Ratio de encapsulación» (
E_RAT), por paquete: qué clases son la cara pública del paquete y cuáles son detalle interno. Es la única del aspecto que señala un sitio concreto del código.
Todas las métricas del aspecto
| Métrica | Sigla | Nivel | Qué cuenta | Dirección | Stau Metro |
|---|---|---|---|---|---|
| «Factor de ocultación de atributos» | AHF |
proyecto | parte de la visibilidad posible de los campos que queda oculta a las demás clases | más alto es mejor | sí |
| «Factor de ocultación de métodos» | MHF |
proyecto | lo mismo para los métodos, constructores incluidos | más alto es mejor | sí |
| «Ratio de encapsulación» | E_RAT |
paquete, módulo | proporción de las clases que no se usan desde fuera del paquete o del módulo | informativa | sí |
Stau Metro calcula las tres y no tiene umbral de referencia para ninguna. AHF y MHF pertenecen a las
«métricas MOOD»; E_RAT viene de la herramienta MetricsReloaded y su página no ha encontrado
una definición en la literatura académica.
Visibilidad declarada frente a uso real
AHF y MHF se calculan igual. En la forma graduada que usa Stau Metro, cada miembro pesa según la fracción de
las otras clases del proyecto que pueden verlo: un miembro private no lo ve ninguna y cuenta como oculto del
todo; uno public de una clase public lo ven todas; los de paquete y los protected quedan entre medias, según
cuántas clases tenga su paquete y cuántas subclases tenga su clase. La métrica es la media de la parte oculta. Los
detalles (qué cuenta como clase, enumerados, records, métodos generados) están en cada página.
E_RAT no se basa en los modificadores, sino en las referencias. Para cada clase de producción de un paquete busca
referencias desde fuera del paquete; si no hay ninguna, la clase cuenta como encapsulada. Una clase public que
solo se usa dentro de su paquete suma igual que una de paquete.
Las dos vistas contestan cosas distintas:
AHF, MHF |
E_RAT |
|
|---|---|---|
| Qué mira | modificadores de campos y métodos | referencias desde fuera hacia las clases |
| Unidad | miembro | clase |
| Dónde se mide | proyecto | paquete, módulo |
| Qué dice | cuánto podría depender el resto del código de los detalles | cuánto depende de hecho de las clases del paquete |
| Qué no ve | si alguien usa de verdad lo visible | si las clases usadas exponen demasiado |
Cómo se combinan
AHF y MHF juntas. Los umbrales de 1995 (ver «Para profundizar») reflejan el reparto esperado: AHF muy
alto (casi todos los campos privados) y MHF bastante más bajo (cada clase publica unos pocos métodos y oculta los
auxiliares). Si MHF supera a AHF, el proyecto deja sus campos más a la vista que sus métodos, y merece una
mirada.
Con la herencia. Lo privado no se hereda. Un AHF alto limita lo que puede valer el
«factor de herencia de atributos» (AIF), y un MHF alto,
el «de métodos» (MIF); un método privado tampoco se puede
sobrescribir, así que no entra en el «factor de polimorfismo» (PF).
Los campos protected son el punto de fricción: en la forma graduada cuentan como visibles en parte, y cada uno es
parte del contrato con todas las subclases (ver «Herencia y polimorfismo»).
E_RAT con el acoplamiento y el diseño de paquetes. Las clases que restan en E_RAT son, a grandes rasgos,
aquellas de las que dependen las clases que cuentan los
«acoplamientos aferentes» (Ca) del paquete, y los
«paquetes dependientes» (PDpt) dicen desde dónde. No coinciden del
todo: en Stau Metro, E_RAT busca referencias en todo el proyecto, también desde Kotlin, y Ca y PDpt solo
cuentan clases Java del ámbito analizado. Un paquete con muchos usuarios de fuera tiene un Ca alto, que lo acerca al
extremo estable de la «inestabilidad», y un paquete estable conviene que
sea abstracto: es la lectura de la «abstracción» de Martin (ver
«Diseño de paquetes»).
Las dos escalas a la vez. Un AHF alto con E_RAT bajo en muchos paquetes describe un proyecto de miembros
bien escondidos y clases muy expuestas: cada clase guarda su estado, pero el resto del código conoce demasiadas
clases. El remedio es otro (fachadas, interfaces públicas reducidas, clases de paquete) que el de un AHF bajo
(campos privados y accesores).
Qué no miden
-
Los accesores que lo exponen todo. Un campo privado cuenta como oculto en
AHFaunque la clase tenga un getter que devuelve la referencia interna y un setter que la sustituye:public class Team { private List<String> members = new ArrayList<>(); // AHF: oculto del todo public List<String> getMembers() { return members; } // MHF: visible; entrega la lista interna public void setMembers(List<String> m) { members = m; } // MHF: visible }Quien llame a
getMembers().clear()vacía el equipo sin pasar porTeam. Ninguna de las tres métricas lo ve. -
La mutabilidad. Las métricas no distinguen una constante
public static finalde un campo que cualquiera puede reasignar. Una clase de constantes grande bajaAHFsin exponer ningún estado que cambie. -
Si la visibilidad es necesaria.
AHFyMHFcuentan lo declarado: un métodopublical que nadie llama desde fuera cuenta como visible. La revisión MOOD2 propuso factores de efectividad de la ocultación para medir eso; la página deMHFlos menciona. -
Lo que pasa en una clase concreta.
AHFyMHFson medias de todo el proyecto. Un valor aceptable no impide que una clase exponga todo su estado. -
Por qué una clase no se usa.
E_RATcuenta como encapsulada una clase que nadie usa, así que el código muerto sube el valor. Y en Stau Metro no cuenta las referencias desde el código de test.
Para profundizar
Binaria o graduada. La definición original de Brito e Abreu reparte los miembros en visibles y ocultos; en su
correspondencia con C++ de 1995, protected contaba como oculto. La forma graduada, que documentan herramientas
como Project Analyzer y usa Stau Metro, da a cada miembro un peso entre 0 y 1. Con ella un miembro protegido cuenta
como visible en parte, así que el mismo código da valores más bajos que con la definición binaria.
Umbrales de 1995. Brito e Abreu, Goulão y Esteves (1995) propusieron umbrales iniciales a partir de cinco
bibliotecas de clases de C++: AHF de al menos 70,2 %, sin límite superior, y MHF entre 10,4 % y
28,7 %. Se calcularon con la definición binaria y sobre bibliotecas cuya razón de ser es ofrecer una API, así
que no se trasladan sin más a una aplicación Java medida con la forma graduada.
Evidencia. Es escasa. Según el resumen de Project Analyzer, Brito e Abreu y Melo (1996) asociaron un MHF mayor
con menos defectos y menos retrabajo en ocho sistemas pequeños construidos con los mismos requisitos. En la muestra
de 1995, AHF se correlacionó fuertemente con el tamaño, y los autores lo atribuyeron más probablemente a lo pequeño
de la muestra. Para E_RAT no hay estudios: su página no encontró una definición académica.
El consejo práctico. Bloch lo resume en dos consejos de Effective Java (3.ª edición, 2018): «Minimize the
accessibility of classes and members» y «In public classes, use accessor methods, not public fields». El primero es
lo que premian AHF, MHF y, a escala de paquete, E_RAT; el segundo explica por qué un AHF alto se consigue
con accesores, y por qué eso no basta (ver «Qué no miden»). El mismo libro incluye «Minimize mutability», que es la
parte de la encapsulación que ninguna de estas métricas mide.
Referencias
- Parnas, D. L. (1972). «On the Criteria To Be Used in Decomposing Systems into Modules». Communications of the ACM, 15(12), 1053-1058. https://doi.org/10.1145/361598.361623
- Brito e Abreu, F., Goulão, M. y Esteves, R. (1995). «Toward the Design Quality Evaluation of Object-Oriented Software Systems». 5th International Conference on Software Quality, Austin (Texas). https://doi.org/10.5281/zenodo.1217073
- Brito e Abreu, F. y Melo, W. (1996). «Evaluating the Impact of Object-Oriented Design on Software Quality». Proceedings of the 3rd International Software Metrics Symposium (METRICS'96), 90-99. https://doi.org/10.1109/METRIC.1996.492446
- Aivosto, Project Analyzer, «MOOD and MOOD2 metrics»: https://www.aivosto.com/project/help/pm-oo-mood.html
- MetricsReloaded, código fuente y descripciones: https://github.com/BasLeijdekkers/MetricsReloaded
- Bloch, J. (2018). Effective Java, 3.ª edición. Addison-Wesley. Items 15, 16 y 17.