Guía del aspecto: Duplicación
El aspecto de duplicación responde a una pregunta: ¿cuántas veces está escrita la misma cosa? Cada copia de un fragmento es un sitio más donde corregir el mismo defecto, y un sitio más que se puede olvidar al hacer un cambio. El problema no es la copia en sí, sino que las copias diverjan sin que nadie lo haya decidido.
La idea tiene nombre desde The Pragmatic Programmer de Hunt y Thomas (1999): el principio DRY (Don't Repeat Yourself). Thomas aclaró después que DRY trata del conocimiento del sistema, que debe tener una representación única y autorizada, y que leerlo solo como «no dupliques código» se queda corto. Las métricas de este aspecto miden la parte que se ve: el texto repetido.
Para quien empieza. Un bloque copiado al que luego se le cambian los nombres de las variables sigue siendo una copia. Los buenos detectores lo encuentran igual.
Por dónde empezar
El aspecto tiene una sola métrica en esta referencia:
| Métrica | Nivel | Stau Metro | Qué dice |
|---|---|---|---|
| «Densidad de líneas duplicadas» | fichero, directorio o paquete, proyecto | no | Porcentaje de las líneas que forman parte de algún bloque duplicado |
La densidad sirve para comparar y seguir la tendencia, pero para actuar hace falta la lista de grupos de clones que da el detector: qué bloques se repiten, cuántas veces y dónde. Un 10 % formado por un bloque repetido cuarenta veces y un 10 % de pequeños parecidos dispersos piden cosas distintas.
Los tipos de clon
A los fragmentos repetidos se les llama clones. La clasificación más usada distingue cuatro tipos, que la «página de la métrica» explica con un ejemplo en Java:
| Tipo | Qué cambia entre las copias | Cómo se detecta |
|---|---|---|
| 1 | solo espacios y comentarios | comparando tokens, como hace por defecto PMD CPD |
| 2 | además, nombres, literales y tipos | comparando tokens sin mirar identificadores ni literales (opciones de PMD CPD en Java) |
| 3 | además, sentencias añadidas, quitadas o cambiadas | depende de un umbral de parecido que fija cada herramienta |
| 4 | todo menos el comportamiento | hay que comparar lo que hace el código, no su texto |
Cuanto más alto el tipo, más difícil es detectarlo. Los tipos 1 y 2 tienen límites claros; desde el 3, el resultado depende de la herramienta.
Cómo leer el número
El número es del detector, no del código. La densidad cambia con los tipos de clon que se detectan y con el tamaño mínimo de un bloque: SonarQube exige en Java al menos 10 sentencias seguidas, y PMD CPD pide que se fije un mínimo de tokens. Dos herramientas no dan la misma densidad, ni una misma herramienta con otra configuración.
No hay un umbral con respaldo empírico. Los estudios que recogen Roy, Zibran y Koschke (2014) sitúan el código clonado de un sistema típico entre el 9 % y el 17 %, con casos del 5 % al 50 %. Sirve como orientación, no como límite.
Mira dónde, qué y si cambia. La duplicación dentro de un fichero se quita con un método; entre módulos puede pedir una biblioteca común. Unificar lógica de negocio repetida merece la pena; el código repetitivo que impone el lenguaje o el framework, a menudo no. Y un clon que nadie toca no genera inconsistencias.
Ojo. No toda duplicación es un error. Kapser y Godfrey (2008) describen patrones de clonación con razones legítimas, y la página de la métrica recoge los casos en que un valor alto es aceptable, como el código generado o los tests que repiten datos para que cada uno se lea solo.
Cómo se combina
- Con el historial. Los clones son peligrosos cuando cambian. Un par de ficheros con mucho «acoplamiento de cambio» y sin dependencia en el código merece una búsqueda de duplicados, y un clon dentro de un «punto caliente» se paga en cada cambio. Más en la «guía de evolución».
- Con los defectos. Juergens et al. (2009) encontraron que los cambios inconsistentes entre clones eran frecuentes y que causaban defectos; ver la «densidad de defectos».
- Con la mantenibilidad. El «índice de mantenibilidad» no ve la duplicación; el modelo de Heitlager, Kuipers y Visser (2007) y la «deuda técnica» la tratan como un factor propio. Más en la «guía de mantenibilidad».
- Con el tamaño. La duplicación infla las «líneas de código»; restarle las líneas duplicadas da una idea del tamaño «único» del sistema.
En Stau Metro. El plugin no tiene detector de clones y ninguna de sus métricas mide la duplicación. Sus «líneas de código» por paquete, módulo y proyecto pueden servir de denominador si las líneas duplicadas vienen de otra herramienta, siempre que las dos cuenten las líneas igual.
Qué no mide
- La duplicación de conocimiento que no se parece en el texto. La misma regla de negocio escrita en Java y en SQL, o un clon de tipo 4, no aparece en un detector por texto ni por tokens.
- Cuál es el original. Todas las copias cuentan igual, incluida la primera.
- Si las diferencias son intencionadas. En los tipos 2 y 3, decidir si unificar exige leer el código.
- Si los clones ya han divergido. Eso lo dice el seguimiento de los clones a lo largo de las versiones, no la densidad de una versión.
Referencias
- Hunt, A. y Thomas, D. (1999). The Pragmatic Programmer: From Journeyman to Master. Addison-Wesley.
- Venners, B. (2003). «Orthogonality and the DRY Principle: A Conversation with Andy Hunt and Dave Thomas, Part II». Artima, 10 de marzo de 2003. https://www.artima.com/articles/orthogonality-and-the-dry-principle
- Kapser, C. y Godfrey, M. W. (2008). «"Cloning Considered Harmful" Considered Harmful: Patterns of Cloning in Software». Empirical Software Engineering, 13, 645-692.
- Juergens, E., Deissenboeck, F., Hummel, B. y Wagner, S. (2009). «Do Code Clones Matter?». Proceedings of the 31st International Conference on Software Engineering (ICSE 2009), 485-495. https://arxiv.org/abs/1701.05472
- Heitlager, I., Kuipers, T. y Visser, J. (2007). «A Practical Model for Measuring Maintainability». 6th International Conference on the Quality of Information and Communications Technology (QUATIC 2007), 30-39.
- Roy, C. K., Zibran, M. F. y Koschke, R. (2014). «The Vision of Software Clone Management: Past, Present, and Future». Ponencia invitada, CSMR-WCRE 2014, 18-33.
- SonarQube, definición de métricas (duplicaciones): https://docs.sonarsource.com/sonarqube-server/latest/user-guide/code-metrics/metrics-definition/
- PMD, «Finding duplicated code with CPD»: https://docs.pmd-code.org/latest/pmd_userdocs_cpd.html