Factor de ocultación de atributos
| Sigla | AHF |
| Aspecto | «Encapsulación» |
| Se mide en | proyecto |
| Tipo de valor | proporción, que se muestra como porcentaje (0 % a 100 %) |
| Dirección | más alto es mejor |
| Origen | Fernando Brito e Abreu y Rogério Carapuça, 1994 |
| Familia | «Métricas MOOD» |
| Stau Metro | AttributeHidingFactorProject |
En pocas palabras
Dice qué parte de los campos del proyecto está escondida del resto de clases. Si todos los campos son private,
vale 100 %: ninguna otra clase puede tocarlos. Si todos son public en clases públicas, vale 0 %. Lo normal es
aspirar a un valor alto.
Qué mide
Mide el uso de la ocultación de información en el estado de los objetos. Un campo oculto solo lo manipulan los métodos de su clase, de modo que la clase puede cambiar su representación interna sin romper a nadie. Un campo visible es parte del contrato: cualquier clase que lo vea puede depender de él.
Es una métrica de sistema: da un único número para todo el proyecto. Sirve para comparar el estilo de dos proyectos o la evolución de uno, no para encontrar la clase culpable.
Para quien empieza. En Java, la visibilidad de un campo la deciden su modificador (
private, ninguno,protected,public) y la de su clase. Un campopublicdentro de una clase sin modificador solo lo ven las clases de su paquete.
Cómo se calcula
En las propuestas originales (Brito e Abreu y Carapuça, 1994; Brito e Abreu, Goulão y Esteves, 1995) la división es binaria: cada clase tiene atributos visibles y ocultos , y
donde es el número total de clases y , los atributos definidos (no heredados) en . En la
correspondencia con C++ de 1995, los visibles son los miembros de datos de la sección public y los ocultos, los de
private y protected.
Las herramientas para lenguajes con más niveles de visibilidad usan una formulación graduada: cada atributo pesa según la fracción de las otras clases que lo ven,
Un campo privado tiene y cuenta como totalmente oculto; uno público de una clase pública tiene . Entre medias quedan los de paquete y los protegidos. Es la formulación que documenta, por ejemplo, Project Analyzer, y la que usa Stau Metro.
Ejemplo
Tres clases en dos paquetes, cada una en su fichero (, así que cada campo puede ser visto por como mucho 2 clases):
// paquete p
public class Account {
private int balance; // V = 0/2: no lo ve nadie
protected String owner; // V = 2/2: Audit (paquete) y SavingsAccount (subclase)
public static final int MAX = 10; // V = 2/2: público en clase pública
int version; // V = 1/2: solo Audit, del mismo paquete
}
// paquete p
class Audit { }
// paquete q
public class SavingsAccount extends p.Account {
private double rate; // V = 0/2
}
Ocultación de cada campo, : 1 + 0 + 0 + 0,5 + 1 = 2,5. Hay 5 campos: .
Cómo interpretarla
Un AHF alto significa que la mayoría de los campos están ocultos; uno bajo, que muchos son ampliamente visibles.
Brito e Abreu, Goulão y Esteves (1995) la tratan como una métrica con solo límite inferior: lo ideal sería que todos
los atributos estuvieran ocultos (la biblioteca MotifApp de su muestra llegaba al 100 %) y los valores muy bajos
deberían llamar la atención. Como umbral inicial propusieron el extremo inferior del intervalo de confianza al 90 %
de la media de su muestra de cinco bibliotecas C++: 70,2 %. Esa cifra se obtuvo con la definición binaria, en la
que protected cuenta como oculto; con la definición graduada un campo protegido cuenta como visible en parte, así
que el mismo código da un valor menor.
Stau Metro no tiene umbral de referencia para esta métrica.
Qué hacer con un valor bajo: localiza las clases con campos públicos o de paquete. Los candidatos habituales son
clases de datos con campos públicos (en Java moderno, un record resuelve muchos de esos casos con campos privados
y accesores) y campos protected que las subclases usan directamente en lugar de a través de métodos.
Cuándo un valor bajo es aceptable. Las constantes (public static final) son campos visibles, y una clase de
constantes o un enumerado con muchas constantes baja AHF sin exponer estado mutable. La métrica no distingue un
campo mutable de una constante.
Para profundizar
Qué cuenta como clase. El denominador depende de cuántas clases hay. Incluir o no interfaces, clases anidadas o código de test cambia el peso de cada visibilidad de paquete, porque un paquete con muchas clases «ve» más que uno con pocas.
Una métrica de nivel de sistema. AHF es una media sobre todos los campos del proyecto. Un valor aceptable no
impide que una clase concreta exponga todo su estado, y una sola clase de constantes grande puede hundir el valor de
un proyecto bien encapsulado.
Tamaño. En la muestra de 1995, AHF fue una de las dos métricas MOOD (con MIF) que se correlacionaron
fuertemente con el tamaño (entre −0,74 y −0,81 con el número de clases, métodos, atributos y líneas); los autores lo
atribuyeron más probablemente al tamaño pequeño de la muestra que a un defecto de la definición.
Relación con otras métricas
- «Factor de ocultación de métodos» (
MHF): la misma idea aplicada a los métodos, con la misma fórmula. - «Factor de herencia de atributos» (
AIF): solo se heredan los campos no privados, así que unAHFmuy alto limita lo queAIFpuede valer. - «Ratio de encapsulación» (
E_RAT): mide la encapsulación de clases dentro de un paquete por el uso real, no por la visibilidad declarada. - «Tamaño de la clase (atributos)» (
CSA): el número de campos por clase, la base del denominador.
En las herramientas
Stau Metro (AttributeHidingFactorProject, a nivel de proyecto). Usa la formulación graduada. Para cada campo
declarado en una clase del ámbito analizado, cuenta cuántas otras clases pueden verlo:
| Visibilidad efectiva | Otras clases que lo ven |
|---|---|
campo private, o clase private |
ninguna |
campo protected, o clase protected |
las demás clases de su paquete más las subclases de otros paquetes (cada clase una vez) |
campo public (o de interfaz) en una clase public |
todas las demás: |
el resto (de paquete, o public en una clase de paquete) |
las demás clases de su paquete |
- son todas las clases Java del ámbito: también interfaces, enumerados, records, anotaciones, clases anidadas y de test. Las clases anónimas y locales no cuentan como clases, ni sus campos como atributos, ni como subclases.
- Las subclases son las directas e indirectas que están en el ámbito analizado; las interfaces que heredan no cuentan como subclases.
- Las constantes de un enumerado son campos
publicy cuentan como atributos: en un enumeradopublic, las ven todas las demás clases. Los campos de una interfaz se tratan comopublic, con la visibilidad de la propia interfaz. - Los componentes de un record no cuentan como campos; sí los campos
staticque declare su cuerpo. - Sin campos, o con una sola clase, no hay valor.
Project Analyzer (Aivosto, para Visual Basic). Documenta AHF = 1 − AttributesVisible, donde la visibilidad de
cada atributo es el número de otras clases en las que es visible dividido entre , con los privados
completamente ocultos.
MetricsReloaded (plugin de IntelliJ IDEA). Describe AHF como la proporción de clases, aparte de la que lo
define, desde las que es visible un campo medio, y remite a Brito e Abreu para la definición.
Referencias
- Brito e Abreu, F. y Carapuça, R. (1994). «Object-Oriented Software Engineering: Measuring and Controlling the Development Process». 4th International Conference on Software Quality, McLean (Virginia). https://doi.org/10.5281/zenodo.1217609
- 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
- Harrison, R., Counsell, S. J. y Nithi, R. V. (1998). «An Evaluation of the MOOD Set of Object-Oriented Software Metrics». IEEE Transactions on Software Engineering, 24(6), 491-496. https://doi.org/10.1109/32.689404
- 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