Saltar navegación

Activa JavaScript para disfrutar de los vídeos de la Mediateca.

Instalar y usar CheckStyle - Contenido educativo

Ajuste de pantalla

El ajuste de pantalla se aprecia al ver el vídeo en pantalla completa. Elige la presentación que más te guste:

Subido el 31 de enero de 2024 por Francisco J. G.

163 visualizaciones

Como instalar y configurar el plugin de Eclipse CheckStyle

Más información Transcripción

Descargar la transcripción

Hola a todos. Este vídeo va destinado a explicar lo que es CheckStyle. CheckStyle lo he puesto 00:00:00
en la teoría en lugar de PMD. PMD, el link a PMD, no es posible en estos momentos y por 00:00:17
eso he tenido que sustituirlo por otro analizador de código, que sería CheckStyle. CheckStyle 00:00:29
aparece en esta página y aparece con... Aquí tenemos toda la documentación por si queremos 00:00:34
andar en ella. Hay que decir que CheckStyle se basa en una serie de reglas, que puede 00:00:41
ser del estilo de Google o de Sun. Aquí tendríamos el estilo de Java, según el 00:00:50
Google Check, y aquí aparecerían cómo hacer las indentaciones, qué cosas son necesarias 00:01:01
en una clase, etc. Todo eso es lo que nos va a chequear a través de CheckStyle. Lo 00:01:10
primero que hay que hacer es en Eclipse, lo tengo en Debian, y lo primero que vamos 00:01:16
a hacer es instalarlo. Para instalarlo, lo primero que he hecho es, según la teoría, 00:01:21
hay una prueba de PMD, del programa PMD, del plugin, y yo lo que he hecho es, con ese mismo 00:01:31
código, he creado una prueba para CheckStyle, que estaría el código aquí. He creado un 00:01:39
proyecto que se llama Prueba de Código y he generado una clase que se llama Prueba CheckStyle 00:01:43
y le he metido el código que aparece en la teoría. Lo primero que vamos a hacer es irnos 00:01:47
a Help o Ayuda, si lo tenéis en castellano, y nos iremos a instalar a Eclipse Marketplace. 00:01:53
Y lo que vamos a hacer es buscar CheckStyle. Pondremos CheckStyle, va un poquito lento 00:02:02
y aquí lo tenemos. Bueno, le damos a CheckStyle, le damos a Enter y nos aparecerá, lo he hecho 00:02:19
mal aquí, CheckStyle. De los dos que hay, otra posibilidad sería el JSParrow, pero 00:02:25
es más complicado de instalar. Entonces, he decidido utilizar CheckStyle para que veáis 00:02:34
un ejemplo de lo que es un analizador de código. Le damos a Instalar y procederá a instalarlo. 00:02:39
CheckStyle es una forma de revisión automatizada que comprueba si el código JAVA se encuentra 00:02:55
en unos ciertos estándares para garantizar una cierta calidad en la codificación. Se 00:03:07
trata de este tipo de programas. ¿Qué ventajas tiene? Pues que facilita el mantenimiento 00:03:13
en el código, asegura la calidad, facilidad de uso, mensajes de reglas en castellano y 00:03:20
podemos implementar propias reglas. Nosotros podemos crear nuestras propias reglas. Ejemplos, 00:03:29
los comentarios JAVA Doc, el te dice si están puestos o no, violaciones en el tamaño, espacios 00:03:38
en blanco, bloques, diseño de clases, si se ha creado un constructor o no, etc. Todo eso, 00:03:44
a la hora de construir un proyecto en JAVA, cada una de las clases, en la manera de como 00:03:51
nosotros las escribimos, nos corregirá y nos irá, a lo largo de los chequeos que hagamos, 00:03:56
nos irá corrigiendo lo que tenemos mal. Eso nos va a ayudar también a mejorar nuestra 00:04:06
programación en JAVA y a aprender también en JAVA. 00:04:12
En la teoría nos aparece el PMD para Eclipse. Yo he probado el plugin para Eclipse y de ninguna 00:04:18
manera siempre sale con un error. Es verdad que antes sí funcionaba y a raíz de los últimos meses 00:04:28
ya no funcionan estas entradas. Esta sería la entrada que habría que utilizar y que lo haríamos 00:04:36
concretamente en la instalación de nuevos software. Habría que poner adicionar y adicionar esa 00:04:44
dirección y nos aparecería él. Pero una vez que lo estás instalando, al final genera un error. 00:04:50
Entonces, ya os digo, no vais a poder instalar el plugin de PMD y como se trata nada más que de 00:04:57
ver o de que veáis cómo utilizar a grosso modo un analizador de código, pues cualquiera nos vale 00:05:05
y que perfecto como checkstyle que hace las veces de PMD. Bien, entonces, en cuanto se termine de 00:05:14
instalar, tarda un poquito, veremos cómo utilizamos este analizador. Bueno, ya he terminado de hacer la 00:05:24
parte primera de la instalación. Aquí nos dice que la instalación no puede ser completada como se 00:05:39
requería. Entonces, bueno, vamos a guardar la instalación y modificar los ítems que sean 00:05:44
necesarios para que sea compatible. La otra opción, esta no nos la deja, es mostrar el original error y construir 00:05:52
una propia solución. Lo vamos a dejar así y le vamos a dar a confirmar. Le damos a confirmar y esto seguirá 00:05:58
instalando. Está calculando. Vale, y ya lo tendríamos aquí. Hay que aceptar por los términos de la 00:06:10
licencia. Le damos a aceptar y le damos a finalizar. Una vez que finalice, si vemos, el software se está instalando aquí 00:06:20
abajo. Habrá que esperar a que lo instale para que luego reiniciemos Eclipse y veamos si funciona o no. 00:06:27
Entonces, fases ¿qué hemos hecho hasta ahora? Hasta ahora lo único que hemos hecho es, hemos creado un 00:06:39
proyecto que se llama PruebaCódigo. Dentro hemos creado una clase que se llama PruebaCheckstyle 00:06:43
y hemos añadido el código que aparece en la teoría. A continuación, hemos instalado el plugin a través del 00:06:49
Marketplace, el plugin de Checkstyle. Ese plugin se está instalando ahora y, posteriormente, una vez que esté 00:06:57
instalado, reiniciaremos Eclipse y lo probaremos. Continúa esto, va al 53% y sale un warning que dice que el 00:07:06
contenido no está firmado. Lo vamos a dar a instalar de todos modos. Le damos y seguimos. 00:07:23
Ya ha terminado la descarga y nos dice que restauremos Eclipse. Entonces, le damos a restaurar y nos lo cerrará y nos lo volverá a abrir. 00:07:29
Decimos que salve, que guarde de la clase PruebaCheckstyle, que lo hemos modificado, y le damos a Sí. 00:07:43
Se está abriendo Eclipse y ahora comprobaremos si realmente se ha instalado el plugin de manera adecuada. 00:07:53
Ya se ha reiniciado Eclipse. Tenemos aquí la clase que habíamos creado y vamos a ver si realmente se nos ha descargado. 00:08:06
Si yo me pongo encima del proyecto que hemos generado y con el botón derecho del ratón observo si se me ha descargado o no. 00:08:15
Veis que tenemos aquí ya Checkstyle y que tenemos cómo activar Checkstyle, cómo desactivarlo, cómo chequear el código con Checkstyle, 00:08:26
qué es lo que vamos a hacer y cómo crear formatos. Hay que decir que si nos vamos aquí a Propiedades, en el proyecto veremos que tenemos también Checkstyle incorporado. 00:08:35
Al dar a Checkstyle nos aparecerán todas las propiedades que podemos hacer. Aquí tenemos, como he dicho antes, dos posibles check. 00:08:50
El check de Google y el check de SAM. Son una serie de reglas que ya vienen por defecto. Se pueden configurar. Aquí le damos a Configurar y podemos ver cada una de ellas. 00:08:59
Veis aquí el tamaño, la indentación, los imports, las headers, los comentarios de Javadoc. Todo esto se puede configurar. Dependerá de si es el de Google o es el de SAM. 00:09:12
Ya vienen todas estas instaladas y podemos aquí crear también reglas nuestras propias. Esto sería el Checkstyle para el proyecto en el que lo que vamos a hacer es chequear esta clase. 00:09:26
¿Cómo? Vamos a meternos en la clase, abrimos el proyecto y en el paquete por defecto que nos ha creado tenemos la clase. Si nosotros le damos a botón derecho podemos hacer un Checkstyle de que dé el código. 00:09:47
Al darle a Checkstyle nos aparecerán las líneas en amarillo. Aquí ya es en el que no cumplen con el Google Check que es el que hemos dejado. Según vemos, aquí está bastante mal todo. 00:10:06
Lo primero, podemos acercarnos a la lupa y ahí nos va diciendo cuál es el que nos está diciendo que falta un comentario. Habría que poner un comentario aquí. 00:10:22
Clase, prueba, analizador. Después podemos nosotros de nuevo darle al chequeador y ver si realmente con el comentario se nos quita la violación que hemos generado aquí. 00:10:31
Aquí nos dice que sigue habiendo falta de comentario. Si yo cojo el paquete y le doy a Checkstyle. 00:10:58
Quiero el paquete. Aquí está. A ver si puede. Todas las violaciones nos están diciendo que si nos vamos encima nos dice que esta línea tiene un carácter de tabulación. 00:11:10
Abreviatura del nombre. Hay que hacerlo. Debe contener con más de una mayúscula. Si nos fijamos aquí en otras, la línea contiene un carácter de tabulación. 00:11:28
El método name, método doble return, debe contener ese patrón. Si veis que falta un comentario, etc. Aquí, si me pongo en código, nosotros podemos darle a Checkstyle y desactivarlo. 00:11:41
O decirle que podemos desactivar el Checkstyle y de nuevo después. Va super lento. Y luego activarlo. 00:11:58
Con ello lo que hacemos es que si yo le doy aquí a Checkstyle y chequeamos de nuevo el código, lo que uno va a generar es ver si alguna de las de lo que hemos realizado nos quita la línea en amarillo. 00:12:20
Si le doy un Enter. 00:12:35
Nos ha cogido aquí clase prueba analizador. Si yo le doy a Enter, ya me ha quitado una línea. 00:12:43
Si le doy a Control-Alt-J nos vuelve a chequear la línea y nos quitaría aquí el error que había. Era que nos faltaba un comentario. Y, a lo opuesto, nos quita la línea amarilla. 00:13:08
Si nos vamos al public-instructable-main, nos está diciendo que falta un comentario, que la línea contiene un carácter de tabulación y luego nos está hablando del sangrado, que está a 24 aquí y tendría que estar a 2. 00:13:23
Habría que acercarlo. Este igual. Aquí el sangrado debería ser de 4 y está con una línea de tabulación. Si le dejamos a 2 líneas se nos quitaría el siguiente. 00:13:39
Y así sucesivamente. Nosotros vamos viendo todo. Aquí seguramente el sangrado es muy alto. Necesitaríamos que contiene un carácter de tabulación. 00:13:57
El nivel de sangrado 8 no está al nivel correcto que debería ser 0, que es lo que acabo de hacer. Si ahora le hacemos un nuevo chequeo con CheckStyle y chequea el código con CheckStyle, nos quita el amarillo porque antes estaba un sangrado de 8 y debería estar un sangrado de 0. 00:14:09
Porque esta llave pertenece a la clase que sería esta de aquí. Y así sucesivamente. Aquí nos ha generado de nuevo porque, si veis, también tenemos aquí un espacio que habría que ajuntarlo aquí. 00:14:30
A lo mejor aquí probando con CheckStyle. Volveríamos a chequear el código y veríamos si lo quita. No nos quita porque realmente todavía nos está diciendo que falta comentario javadoc. 00:14:45
Este no lo toma como un comentario. Esto sería así sucesivamente. Este sería el método del analizador de código CheckStyle y esto sería trabajar con ello y ver cada una de las reglas para que sea de utilidad. 00:14:59
Idioma/s:
es
Autor/es:
Francisco josé González Constanza
Subido por:
Francisco J. G.
Licencia:
Todos los derechos reservados
Visualizaciones:
163
Fecha:
31 de enero de 2024 - 11:55
Visibilidad:
Público
Centro:
IES CIFP a Distancia Ignacio Ellacuría
Duración:
15′ 26″
Relación de aspecto:
1.78:1
Resolución:
1920x1080 píxeles
Tamaño:
244.33 MBytes

Del mismo autor…

Ver más del mismo autor

EducaMadrid, Plataforma Educativa de la Comunidad de Madrid

Plataforma Educativa EducaMadrid