MAVEN PARA LA BUENA CALIDAD DEL CODIGO

Posted: lunes, 19 de enero de 2015 by Skuarch in
0


Cuando trabajas en un equipo con varias personas en ocaciones la calidad del codigo empieza a disminuir proporcionalmente al aumento de lineas de codigo, por esta razon me puse a investigar como mantener la calidad del codigo sin tener que revizarlo por ti mismo de una forma automatizada y que no te deje pasar o compilar si no cumples con los requisitos Estos plugins estan basados para una aplicacion web, eso no significa que no lo puedas usar para crear otro tipo de archivo.

1.- Analizar el codigo

Para esto se va a utilizar findbugs que ya se puede usar con la version 8 de java y este seria el fragmento de codigo para usarlo
org.codehaus.mojo findbugs-maven-plugin 3.0.2 High Default false ${project.build.directory}/findbugs analyze-compile compile check
Con esto findbugs analizara el codigo y mostrara la salida, en el caso de que algo este mal, marcara error en el build, otro buen analizador de codigo es PMD entre algunas de las cosas buenas que tiene es que identifica el codigo repetido, esto lo hace mediante tokens y esta es la configuracion. org.apache.maven.plugins maven-pmd-plugin 3.5 true utf-8 40 1.8 true check cpd-check Checa que los tokens esta en 40, obviamente lo puedes configurar a tu gusto.

2.- Formato del codigo

Quien no odia el tipo de desarrollador que por querer hacer las cosas mas rapidas hace mal formato en el codigo, para eso vamos a usar checkstyle org.apache.maven.plugins maven-checkstyle-plugin 2.9.1 checkstyle validate check false true A veces checkstyle es muy estricto en sus reglas y no te deja compilar por que hiciste un pequeño mal codigo, por ejemplo hay si linea de codigo que mide mas de 80 caracteres, por eso la configuracion esta en false para no ser tan estrictos, pero la salida se muestra en consola de todas formas.

3.- Javadoc

checkstyle tambien checa que exista documentacion en nuestro codigo y eso lo vamos a aprovechar generando automaticamente la documentacion para eso utilizaremos javadoc org.apache.maven.plugins maven-javadoc-plugin 2.10.1 attach-javadocs jar

4.- Compilacion

Nunca esta demas compilar y mostrar los errores o posibles metodos/clases que ya no debemos de usar para eso le indicaremos al compilador que nos lo muestre org.apache.maven.plugins maven-compiler-plugin 3.1 ${java-version} ${java-version} -Xlint:all ${endorsed.dir} true true Todos los errores como deprecation, warnings y otros seran mostrados en la consola. Si esto lo aplicamos a un codigo que apenas empieza es mas facil mantener la calidad del codigo, cuando ya se escribieron cientos/miles de lineas de codigo obviamente seria una pesadilla hacer el javadoc, cambiar el formato y esas cosas, aun que nunca esta demas hacerlo. Por ultimo tenemos a proguard este es usado para ofuscar el codigo, desafortunadamente no lo pude integrar con una aplicacion web, por esa razon no hay un fragmento de xml que lño muestre