Ejercicio 1.2: Ejecución de una revisión del código y aplicación de un arreglo rápido
En este ejercicio se da por supuesto que se ha terminado el Ejercicio 1.1: Importación de los recursos necesarios. En el ejercicio, primero se lee un caso de ejemplo de un usuario. A continuación, se asume el papel del desarrollador de software descrito en el caso de ejemplo del usuario.
Caso de ejemplo de un usuario
Un gran grupo de desarrolladores dispersados geográficamente está codificando una aplicación de software nueva. Resulta importante que los desarrolladores efectúen rutinariamente revisiones del código para comprobar los problemas en el código que están desarrollando.
Uno de los desarrolladores desea llevar a cabo una revisión del código para ver qué tal lo está haciendo en general. Para revisar código que se acaba de generar con el fin de garantizar que se siguen las recomendaciones para varias áreas, el desarrollador lleva a cabo una revisión automatizada rápida del código. Esta revisión aplica varias categorías de reglas suministradas al código. Cada categoría de reglas comprueba la calidad del código en un área específica, como por ejemplo el rendimiento.
Cuando finaliza la revisión del código, aparece una lista de los hallazgos. Cada hallazgo representa una cadena de caracteres de código que no sigue estrictamente una regla aplicada. Uno de los hallazgos tiene disponible un arreglo rápido, de manera que el desarrollador aplica la solución automatizada y corrige el problema de inmediato.
En la primera parte del ejercicio, se realizan las tareas siguientes para llevar a cabo una revisión del código:
- Seleccionar una revisión del código para llevarla a cabo.
- Ver las reglas aplicadas en la revisión del código.
- Elegir el código en el que se debe llevar a cabo la revisión.
- Llevar a cabo la revisión del código.
- Ver los hallazgos de la revisión del código.
- Seleccionar un hallazgo para ver la información siguiente:
- Código fuente.
- Descripción, ejemplos y soluciones.
Seguidamente, para aplicar un arreglo rápido a un hallazgo detectado en la revisión del código llevará a cabo las tareas siguientes:
- Reconocer cuándo hay disponible un arreglo rápido para un hallazgo.
- Ver una lista de los cambios que realizará el arreglo rápido en el código.
- Visualizar previamente el código original y el transformado antes de aplicar el arreglo rápido.
- Aplicar el arreglo rápido para transformar el código.
- Obtener una confirmación después de aplicar el arreglo rápido.
Ejercicio
Selección de una revisión del código
Para seleccionar una revisión rápida del código:
- En la barra de herramientas de la visión Revisión del código, pulse el icono Gestionar reglas,
.

- En la lista Selección de una revisión del código, pulse Revisión rápida del código. Aparecen las carpetas de las reglas de la revisión del código selecciona, tal como muestra la captura de pantalla siguiente:

- Para ver una de las reglas que se aplicarán en la revisión del código, expanda la carpeta Recomendaciones de J2SE y, a continuación, la subcarpeta Nulo. La carpeta Nulo muestra una regla con un nivel de gravedad de problema, tal como se aprecia en la captura de pantalla siguiente:

Como revisión, los iconos del nivel de gravedad aparecen en la ilustración siguiente:

- Pulse Aceptar para elegir la Revisión rápida del código.
Selección de una base de código para revisar
Para seleccionar el proyecto como base de código para revisar:
- En la barra de herramientas de la vista Revisión del código, pulse el icono Revisión (
) > Proyectos > Revisar CodeReview_Examples.
Ejecución de una revisión del código
Tras seleccionar la base de código que se ha de revisar, se lleva a cabo la revisión del código. Puede realizar un seguimiento del estado comprobando la barra de progreso de la esquina inferior derecha que aparece en la vista.
Visualización de los hallazgos de revisión del código
Cuando se termina la revisión del código, los hallazgos aparecen en la vista Revisión del código, tal como muestra la captura de pantalla siguiente:

La vista Revisión del código proporciona la información siguiente:
- Estadísticas de revisión del código: La línea que está por encima de los hallazgos muestra información de la revisión de código más reciente: tipo, ámbito, número de reglas y de archivos incluidos así como número y gravedad de hallazgos.
- Hallazgos de la revisión del código: Los hallazgos de la revisión del código aparecen listados en la vista Revisión del código, dentro de carpetas. Cada nombre de carpeta indica la categoría de reglas aplicadas y el número de hallazgos.
Obtención de más información de un hallazgo de la revisión del código
Para obtener más información de un hallazgo de la revisión del código:
- En la vista Revisión del código, desplácese hasta la carpeta Recomendaciones de J2SE: Comparación. A continuación, expanda la carpeta para que aparezcan los hallazgos, tal como muestra la captura de pantalla siguiente:

- Los primeros hallazgos comienzan en EqualsHashCode_Example.java. La regla que se ha aplicado aparece después del hallazgo:
Ignorar siempre java.lang.Object.equals() y java.lang.Object.hashCode()
- Efectúe una doble pulsación sobre el primer hallazgo. Los detalles sobre este hallazgo aparecerán en dos lugares, tal como se indica a continuación y en la captura de pantalla:
- Código fuente: Muestra el código en el que se produce el hallazgo y resalta la ubicación exacta del mismo.
- Vista Detalles de revisión del código: Describe el hallazgo más detalladamente y proporciona ejemplo y soluciones para corregirlo.

Selección de un hallazgos que tiene un arreglo rápido
Según los iconos, se puede decir que ambos hallazgos de la carpeta Recomendaciones: Comparación tienen un arreglo rápido. Como revisión, los iconos de los arreglos rápidos aparecen en la ilustración siguiente:

- Efectúe una pulsación con el botón derecho del ratón sobre el primer hallazgo de la lista, tal como muestra la captura de pantalla siguiente.
- La opción del menú emergente Arreglo rápido varía en función de la solución. Para el hallazgo que ha seleccionado, el arreglo es implementar hashCode y equal.

- Pulse Arreglo rápido: Implementar hashCode y equals.
Aplicación del arreglo rápido
El arreglo rápido para el hallazgo seleccionado es implementar hashCode y equals.
Para revisar y aplicar el arreglo rápido para el hallazgo:
- Aparece una vista del código con dos lados uno junto a otro, tal como muestra la captura de pantalla siguiente. El código fuente original se encuentra en la parte izquierda y el código fuente transformado que se crearía al aplicar el arreglo rápido se encuentra en la parte de la derecha. Si decide aplicar el arreglo rápido, añadirá las líneas de código resaltadas que faltan.

- En el apartado Cambios que se han de llevar a cabo expanda la lista para ver exactamente qué cambiará y cómo lo hará el arreglo rápido, tal como muestra la captura de pantalla siguiente:

- Revise los cambios de la lista. A continuación, pulse Aceptar para aplicar el arreglo rápido en todos los cambios seleccionados de la lista.
- Tras aplicar el arreglo rápido, aparecerá una marca de selección junto al hallazgo que ha corregido.

Junto a la marca de selección verá la información siguiente:
- El arreglo rápido que ha aplicado
- El número de línea del código fuente en el que se encuentra el hallazgo
- La regla de la revisión del código que no se seguía
Ha terminado el Ejercicio: Ejecución de una revisión del código y aplicación de un arreglo rápido.
Resumen del ejercicio
Ha llevado a cabo todas las tareas del Ejercicio: Ejecución de una revisión del código y aplicación de un arreglo rápido.
Tareas para llevar a cabo una revisión del código
Cuando ha llevado a cabo esta revisión del código, ha realizado las tareas siguientes:
- Ha seleccionado una revisión del código para llevarla a cabo.
- Ha visualizado las reglas aplicadas en la revisión del código.
- Ha elegido un cuerpo de código en el que se iba a llevar a cabo la revisión.
- Ha llevado a cabo la revisión del código.
- Ha visualizado los hallazgos de la revisión del código.
- Ha seleccionado un hallazgo para ver la información siguiente:
- Código fuente.
- Descripción, ejemplos y soluciones.
Tareas para aplicar un arreglo rápido
Cuando ha aplicado el arreglo rápido, ha realizado las tareas siguientes:
- Ha reconocido cuándo hay disponible un arreglo rápido para un hallazgo.
- Ha visto una lista de cambios que realizará el arreglo rápido en el código.
- Ha visualizado previamente el código original y el código transformado.
- Ha aplicado el arreglo rápido para transformar el código.
- Ha obtenido una confirmación indicando que se ha aplicado el arreglo rápido.
Implicaciones de una revisión del código
Al llevar a cabo de forma poactiva revisiones del código, podrá analizar los hallazgos pronto. Lo que significa que también los podrá corregir pronto, antes que originen los problemas siguientes:
- Afectan al rendimiento, mantenimiento o escalabilidad de su aplicación
- Cuestan dinero, tiempo y recursos a su empresa
Implicaciones de un arreglo rápido
La aplicación de un arreglo rápido proporcionado, representa una forma automatizada de resolver un hallazgo común. Los arreglos rápidos le ayudan de la forma siguiente:
- Corrigen un problema de forma coherente cada vez que se detecta
- Le evitan tener que emplear código y le ahorran tiempo a la hora de arreglar defectos
Termine la guía de aprendizaje revisando los objetivos de aprendizaje del apartado Resumen: Cómo ejecutar una revisión del código.