Guía del aspecto: Diseño de paquetes
Este aspecto mira la estructura de un sistema un nivel por encima de las clases: cómo se reparten las dependencias entre paquetes y si van en la dirección correcta. Sus tres métricas son de Robert C. Martin (1994) y se leen juntas:
- la «abstracción» (
A): qué parte del paquete son interfaces y clases abstractas; - la «inestabilidad» (
I): qué parte de su acoplamiento es hacia fuera; - la «distancia a la secuencia principal» (
D): cuánto se aparta el paquete del equilibrio entre las dos anteriores.
La pregunta que contestan es: ¿los paquetes de los que depende mucho código son los que se pueden extender sin tocarlos? Un paquete del que dependen muchos otros es caro de cambiar, porque cualquier cambio se propaga. Si además es concreto, no hay forma de ampliarlo sin modificarlo. Martin propone que la abstracción acompañe a la estabilidad: cuanto más dependen de un paquete, más abstracto debería ser.
Para quien empieza. Aquí «estable» no quiere decir «que funciona bien» ni «que cambia poco», sino «difícil de cambiar porque mucho código depende de él». Y ninguna de las tres métricas se mide en clases sueltas: todas son de paquete.
Por dónde empezar
- Antes de nada, los ciclos. Mira el «número de dependencias cíclicas»
(
Cyclic) de los paquetes; Stau Metro da error por encima de 0. Si los paquetes forman ciclos, no se pueden ordenar por estabilidad y el resto de la lectura pierde parte de su sentido. Esa métrica está en el aspecto «Acoplamiento». - La distancia (
D). Es la que da una alarma: Stau Metro avisa por encima de 0,7, valor tomado de la regla por defecto de NDepend. Es también la métrica de este aspecto que el catálogo de Stau Metro marca como esencial. AeIde los paquetes señalados. La distancia no dice hacia qué lado se aparta el paquete, y los arreglos son opuestos. Hay que mirar las dos coordenadas.
Las métricas y sus ingredientes
Las tres primeras son las del aspecto. Las demás pertenecen a «Acoplamiento», pero son las que hay que
abrir para entender un valor de I o de D.
| Métrica | Sigla | Qué dice | Dirección | Stau Metro |
|---|---|---|---|---|
| «Abstracción» | A |
clases abstractas e interfaces entre el total de clases del paquete, de 0 a 1 | informativa | sí |
| «Inestabilidad» | I |
Ce / (Ca + Ce), de 0 (solo dependen de él) a 1 (solo depende él) |
informativa | sí |
| «Distancia a la secuencia principal» | D |
|A + I - 1|, de 0 (equilibrado) a 1 (en un extremo) |
más alto es peor; aviso > 0,7 | sí |
| «Acoplamientos aferentes» | Ca |
clases de fuera que dependen del paquete: su responsabilidad | informativa | sí |
| «Acoplamientos eferentes» | Ce |
clases del paquete que dependen de fuera: su exposición | informativa | sí |
| «Número de paquetes dependientes» | PDpt |
lo mismo que Ca, contado en paquetes (el Ca de JDepend) |
informativa | sí |
| «Número de dependencias de paquete» | PDcy |
lo mismo que Ce, contado en paquetes (el Ce de JDepend) |
informativa | sí |
| «Número de dependencias cíclicas» | Cyclic |
con cuántos paquetes forma ciclo | más alto es peor; error > 0 | sí |
| «Orden de nivel» | Level |
en qué piso del grafo de paquetes está | informativa | sí |
| «Cohesión relacional» | H |
relaciones internas por tipo: si el paquete es una unidad | intermedia | no |
Cómo se leen juntas
Cada paquete es un punto en un plano con I en el eje horizontal y A en el vertical. La recta , que va
de (I = 0, A = 1) a (I = 1, A = 0), es la secuencia principal: los paquetes que cumplen la propuesta de
Martin caen cerca de ella. D es lo lejos que queda cada uno. Las dos esquinas alejadas tienen nombre (la página de
la «distancia» las dibuja):
I |
A |
Dónde está | Lectura |
|---|---|---|---|
| cerca de 0 | cerca de 1 | sobre la secuencia | contratos estables de los que depende mucho código: el caso ideal de un núcleo |
| cerca de 1 | cerca de 0 | sobre la secuencia | código concreto que nadie usa desde fuera (interfaz de usuario, aplicación): se cambia sin romper nada |
| cerca de 0 | cerca de 0 | zona de dolor | código concreto del que depende mucho código: cada cambio se propaga y no hay por dónde extenderlo |
| cerca de 1 | cerca de 1 | zona de inutilidad | abstracciones de las que no depende nadie: contratos sin clientes |
Por eso D sola no basta. Un D de 0,9 puede ser un paquete de modelo en la zona de dolor (arreglo: que los
clientes dependan de interfaces, o separar lo que cambia de lo que no) o un paquete de interfaces sin uso en la de
inutilidad (arreglo: comprobar si sobran). Y un D de 0 no prueba nada: un paquete con A = 0,5 e I = 0,5 está
sobre la recta tenga el contenido que tenga.
La dirección de las dependencias. La inestabilidad da además una regla que no depende de umbrales: el
principio de dependencias estables pide que cada paquete dependa de paquetes más estables que él, es decir, con
I menor. Se comprueba flecha a flecha: si un paquete con I = 0,2 depende de uno con I = 0,9, esa dependencia
va en contra de la estabilidad. El ejemplo de la tienda de la página de la
«inestabilidad», con shop.web (1) que depende de shop.service (0,5) y
de shop.model (0), cumple la regla; la «distancia» calcula, con los mismos
paquetes, la D de cada uno.
Ciclos y niveles. Un ciclo entre paquetes no puede cumplir la regla anterior: siguiendo sus flechas se vuelve
al punto de partida, así que no todas pueden ir hacia paquetes más estables. El
«orden de nivel» complementa la lectura: los paquetes de nivel bajo, de los que
depende el resto, deberían ser también los de I baja.
Ca y Ce: de dónde sale la inestabilidad
I se calcula con los dos recuentos del aspecto Acoplamiento, y lo que cuenten decide el número:
- Martin contaba clases.
Caes el número de clases de fuera que dependen de clases del paquete;Ce, el de clases del paquete que dependen de clases de fuera. Es lo que hace Stau Metro. - JDepend cuenta paquetes. Su
Cay suCeson lo que aquí se llamaPDptyPDcy. La fórmula deIes la misma, pero el resultado no. - NDepend, por ensamblado, cuenta en
Calos tipos de fuera que dependen de tipos de dentro y enCelos tipos de fuera que se usan, incluidos los de ensamblados de terceros.
En Stau Metro, Ca, Ce, I, A y D comparten estas reglas: solo cuentan las clases Java de producción del
ámbito analizado (ni las de test, ni las de bibliotecas, ni las de Kotlin), cada clase anidada con nombre cuenta como
clase propia y las anónimas y locales como parte de la que las contiene, y cada paquete se mide sin sus subpaquetes.
Un paquete sin Ca ni Ce no tiene I ni D; A sí tiene valor aunque el paquete esté aislado. Las reglas
completas están en cada página.
Ojo.
IyDdependen del ámbito del análisis. Si se analiza solo una parte del proyecto, los paquetes que la usan desde fuera no cuentan y un paquete parece menos estable de lo que es.
Qué no miden
- La frecuencia de cambio. La estabilidad de Martin es estructural: dice lo caro que sería cambiar un paquete, no si cambia. Un paquete concreto del que depende todo y que nunca cambia (tipos de valor, constantes, excepciones) está en la zona de dolor sin doler. Las métricas de «Evolución del código» sí ven los cambios.
- El peso de las clases.
Acuenta clases: una interfaz de un método y una clase concreta de dos mil líneas pesan igual. Un paquete puede tenerA= 0,5 con casi todo su código en la parte concreta. - La cohesión del paquete. Que un paquete esté sobre la secuencia principal no dice si sus clases tienen algo que ver entre sí; eso lo mira la «cohesión relacional», que Stau Metro no calcula.
- Los paquetes pequeños. En un paquete de tres clases, una sola mueve
Aen un tercio. Los valores se dispersan mucho, y un umbral pensado para ensamblados .NET, como el 0,7 de NDepend, es solo una orientación para un paquete Java.
Para profundizar
Los principios detrás. Martin presentó las métricas en «OO Design Quality Metrics: An Analysis of Dependencies» (1994), sobre categorías de clases, grupos de clases muy cohesionadas que en Java suelen corresponderse con paquetes. El principio de dependencias acíclicas lo presentó en «Granularity» (1996), y los tres aparecen en Agile Software Development (2002):
- el principio de dependencias acíclicas: el grafo de dependencias entre paquetes no debe tener ciclos (lo mide
Cyclic); - el principio de dependencias estables: depender en la dirección de la estabilidad (lo comprueba
I, flecha a flecha); - el principio de abstracciones estables: un paquete debe ser tan abstracto como estable (lo mide
D).
Si se cumplen los dos últimos, las dependencias apuntan hacia paquetes cada vez más abstractos, que es la versión a escala de paquete del principio de inversión de dependencias.
Dos distancias. Martin definió primero la distancia perpendicular a la recta, , que va de 0 a unos 0,707, y después la normalizada, , de 0 a 1, que llamó . JDepend, NDepend y Stau Metro calculan la normalizada. Las dos ordenan los paquetes igual, pero los umbrales de una no valen para la otra.
Qué esperaba Martin. No dio un umbral. Proponía revisar los paquetes con D lejos de 0 y esperaba que, en un
diseño que siguiera sus principios, la media y la varianza de D sobre todos los paquetes fueran cercanas a 0. Mirar
la distribución de D en todo el sistema dice más que mirar un paquete suelto.
Limitaciones conocidas. Además de las de la sección anterior: la definición de «dependencia» varía entre
herramientas (tipos de campos, llamadas, herencia, anotaciones), así que Ca y Ce no son comparables entre ellas;
y la métrica supone que todo paquete debería estar en la recta, cuando un núcleo concreto y muy estable es a veces la
mejor opción.
Referencias
- Martin, R. C. (1994). «OO Design Quality Metrics: An Analysis of Dependencies». Artículo fechado el 14 de agosto de 1994.
- Martin, R. C. (1996). «Granularity». The C++ Report.
- Martin, R. C. (2002). Agile Software Development: Principles, Patterns, and Practices. Prentice Hall.
- JDepend, documentación: https://github.com/clarkware/jdepend/blob/master/docs/JDepend.html
- NDepend, definición de métricas: https://www.ndepend.com/docs/code-metrics
- NDepend, regla ND1407: https://www.ndepend.com/default-rules/NDepend-Rules-Explorer.html?ruleid=ND1407