Distancia a la secuencia principal
| Sigla | D |
| Aspecto | «Diseño de paquetes» |
| Se mide en | paquete |
| Tipo de valor | número entre 0 y 1 (Stau Metro lo muestra como decimal) |
| Dirección | más alto es peor |
| Umbrales de referencia | aviso por encima de 0,7 (Stau Metro, tomado de la regla por defecto de NDepend) |
| Origen | Robert C. Martin, 1994 |
| Familia | «Métricas de paquetes de Martin» |
| Stau Metro | Distance |
En pocas palabras
Un paquete del que depende mucho código debería estar hecho sobre todo de interfaces, para poder ampliarlo sin tocarlo. Un paquete del que no depende nadie puede ser concreto, porque cambiarlo no rompe nada. Esta métrica dice cuánto se aparta un paquete de ese reparto: 0 es un paquete equilibrado; 1, uno que está en el peor de los extremos.
Qué mide
El encaje entre dos propiedades de un paquete que Martin propone mantener ligadas:
- su «inestabilidad» (
I), de 0 (todos dependen de él, él de nadie) a 1 (al revés); - su «abstracción» (
A), de 0 (todo concreto) a 1 (todo interfaces y clases abstractas).
El principio de abstracciones estables de Martin pide que un paquete sea tan abstracto como estable. Un
paquete estable (I cerca de 0) es caro de cambiar, así que debe ser abstracto para poder extenderse sin
modificarse; uno inestable (I cerca de 1) puede ser concreto. Los paquetes que cumplen el principio caen cerca de
la recta , que Martin llamó secuencia principal. La distancia mide lo lejos que queda cada paquete de
esa recta.
Las dos esquinas alejadas de la recta tienen nombre propio (así las llama, por ejemplo, la documentación de NDepend):
- Zona de dolor (
AyIcerca de 0): un paquete concreto del que depende mucho código. Cualquier cambio se propaga y no hay abstracciones por las que extenderlo. Los paquetes de utilidades y de modelo de datos suelen caer aquí. - Zona de inutilidad (
AyIcerca de 1): abstracciones de las que no depende nadie. Contratos sin clientes, a menudo restos de un diseño anterior o código muerto.
En el diagrama, el eje horizontal es I y el vertical A. La secuencia principal es la diagonal que va de arriba a
la izquierda (A = 1, I = 0) a abajo a la derecha (A = 0, I = 1). La esquina inferior izquierda es la zona de
dolor; la superior derecha, la de inutilidad. Los puntos son los paquetes del ejemplo de abajo.
Cómo se calcula
Vale entre 0 (el paquete está sobre la secuencia principal) y 1 (está en una de las dos esquinas). Es la forma normalizada. Martin (1994) definió primero la distancia perpendicular a la recta, , que va de 0 a unos 0,707, y a continuación esta versión normalizada, 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.
Como depende de I, no está definida para un paquete sin acoplamientos con otros paquetes.
Ejemplo
Los tres paquetes de la tienda del ejemplo de la «inestabilidad»: shop.model tiene dos clases
concretas (Order, Item) que usan los otros dos paquetes; shop.service tiene una interfaz (PaymentGateway) y
una clase concreta (OrderService); shop.web, dos clases concretas que usan a los demás y que nadie usa.
| Paquete | A |
I |
D |
|
|---|---|---|---|---|
shop.model |
0 / 2 = 0 | 0 / 3 = 0 | -1 | 1 |
shop.service |
1 / 2 = 0,5 | 1 / 2 = 0,5 | 0 | 0 |
shop.web |
0 / 2 = 0 | 2 / 2 = 1 | 0 | 0 |
shop.model está de lleno en la zona de dolor y supera el umbral de aviso de 0,7. Es un caso corriente y no siempre
grave: un modelo de datos sencillo, que casi nunca cambia, puede vivir ahí sin problemas. Si cambiara a menudo, la
salida sería que los demás paquetes dependieran de interfaces del modelo en lugar de sus clases, o separar la parte
estable de la que cambia.
shop.web está sobre la secuencia principal aunque es totalmente concreto: nadie depende de él, así que no necesita
abstracciones.
Cómo interpretarla
Stau Metro avisa por encima de 0,7. El valor viene de la regla por defecto de NDepend, que considera
problemáticos los ensamblados .NET con distancia normalizada mayor que 0,7. Un paquete Java es una unidad más pequeña
que un ensamblado y sus valores se dispersan más; tómalo como orientación. Martin no dio un umbral: proponía revisar
cualquier paquete 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.
Qué hacer con un valor alto. Primero mira en qué zona está el paquete, porque los arreglos son opuestos:
- Zona de dolor (
AeIbajos). Introduce interfaces y haz que los clientes dependan de ellas, o reduce quién depende del paquete moviendo a otro sitio lo que solo usan unos pocos. Si el paquete es estable de verdad (no cambia), el valor alto es tolerable: el dolor solo aparece al cambiarlo. - Zona de inutilidad (
AeIaltos). Comprueba si las abstracciones tienen implementaciones y clientes. Si no, suele sobrar código.
Cuándo un valor alto es aceptable. Paquetes de constantes, de excepciones, de tipos de valor o de utilidades
muy estables suelen dar valores altos sin causar problemas. Lo mismo ocurre con un paquete de pocas clases, donde
una sola clase mueve mucho A o I.
Ojo. Que
Dsea 0 no significa que el paquete esté bien diseñado: un paquete conA = 0,5eI = 0,5está sobre la secuencia principal tenga el contenido que tenga. La métrica solo dice si abstracción y estabilidad van acompasadas.
Para profundizar
Qué hay detrás. El razonamiento combina dos principios de Martin: el de dependencias estables (depender en la dirección de la estabilidad) y el de abstracciones estables (ser tan abstracto como estable). Si los dos se cumplen, 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.
Limitaciones.
- Cuenta clases, no peso.
Apone en pie de igualdad una interfaz de un método y una clase de miles de líneas. - Depende del ámbito.
CayCesolo ven las clases analizadas; cambiar el ámbito mueve laIy, con ella, laDde cada paquete. - Supone que todo paquete debería estar en la recta. Un paquete estable y concreto que nunca cambia (tipos de valor, constantes) está en la zona de dolor sin doler. La métrica no sabe con qué frecuencia cambia un paquete; las métricas de «evolución» sí.
- No ve los ciclos. Si los paquetes forman ciclos, la estabilidad pierde parte de su significado: conviene revisar antes las «dependencias cíclicas».
Relación con otras métricas
- «Abstracción» (
A) e «inestabilidad» (I): se calcula a partir de ellas; para saber en qué zona está un paquete hay que mirarlas por separado. - «Acoplamientos aferentes» (
Ca) y «eferentes» (Ce): los recuentos de los que saleI. - «Número de dependencias cíclicas» (
Cyclic) y «orden de nivel» (Level): miran la estructura de dependencias entre paquetes desde otro ángulo, el de los ciclos y las capas.
En las herramientas
Stau Metro (Distance, a nivel de paquete). Calcula con la «inestabilidad» y la
«abstracción» del paquete, con sus mismas reglas: solo clases Java de producción del ámbito
analizado, clases anidadas como clases propias, anónimas y locales dentro de la que las contiene, y cada paquete sin
sus subpaquetes. Un paquete que no depende de otros del ámbito ni es usado por ellos no tiene valor, porque su I
no está definida. Así, un paquete de interfaces aislado, que ni usa ni es usado por ningún otro, no aparece, aunque
sea un caso claro de abstracciones sin uso: solo cae en la zona de inutilidad, y recibe valor, si depende de algún
paquete del ámbito.
JDepend. Su documentación define D como la distancia perpendicular de un paquete a la recta , con
rango de 0 (sobre la secuencia principal) a 1. Ese rango es el de la distancia normalizada, no el de la
perpendicular, que no pasa de unos 0,707. Cuenta Ca y Ce en paquetes, no en clases, así que su I y su D pueden diferir de
las de Stau Metro para el mismo código.
NDepend (.NET, por ensamblado). Calcula la distancia normalizada a la recta , con rango de 0 a 1, y
considera que un valor por encima de 0,7 puede ser problemático. Su informe sitúa cada ensamblado en el gráfico de
abstracción frente a inestabilidad, con la zona de dolor (I y A cerca de 0) y la de inutilidad (los dos cerca de
1).
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. (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
- Wikipedia, «Software package metrics»: https://en.wikipedia.org/wiki/Software_package_metrics