Configuración de Maven para usar el Plugin PMD
En este tutorial vamos a realizar una introducción del plugin PMD (versión 3.2) para Maven 2
Más concretamente vememos que modificaciones tenemos que realizar sobre los pom.xml de nuestros proyectos para integrar en Maven
la funcionalidad de análisis y reporting de código que nos aporta PMD
¿Qué es PMD?
PMD verifica reglas de codificación buscando en el código fuente posibles errores del tipo:
- Nombres de variables demasiado cortos.
- Concatenaciones de String en lugar de usar StringBuffer.
- Bloques de código sin llaves de apertura y cierre.
- Variables declaradas sin usarse.
- Bloques de código repetido »
Copy/Paste Detector tool (CPD). - Funciones con más de un punto de salida (
return). - …
- Y un largo etc.
Es decir, PMD nos proporciona información para mejorar la cálidad de nuestro código fuente evitándonos incluso comoter errores difíciles de detectar.
Por ejemplo, PMD nos reportaría que en la linea 5 de siguiente clase hay un posible error.
|
1 2 3 4 5 6 7 8 9 |
public class Clase1 { private String miVariable; public Clase1(String miVariable){ miVariable = miVariable; // ¡¡Error!!, lo correcto sería: this.miVariable = miVariable; } ... ... } |
Instalación del Plugin
Puede descargar el plugin para su entorno de desarrollo favorito haciendo clic aquí
Si su entorno es Eclipse, para instalar el plugin simplemente deberá descomprimir el archivo dentro de la carpeta donde tenga instalado su Eclipse y reiniciar (su Eclipse) en caso de que esté abierto.
El plugin PMD en acción
A continuación vamos a ver el funcionamiento del plugin analizando un proyecto de prueba.
Además, para que sea más facil de asimilar, nuestro proyecto sólo tendrá una clase deficiente sintácticamente y sin sentido semántico.
Código fuente de nuestro proyecto:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
package com.autentia.pmdeclipseplugin; import java.util.Enumeration; import java.util.*; /** * Clase para el tutorial de PMD * @author Carlos García. Autentia. * @see http://www.mobiletest.es */ public class Persona { public String dni; public Persona(String dni) { dni = (String) dni; } public boolean equals(Object obj) { try { String dni2 = ((Persona) obj).dni; return this.dni.equals( dni2 ); } catch (Exception ex){} return false; } public int funcionTonta2(int numerito){ int total = 0; if ((numerito % 3) == 0){ total+=3; } else if ((numerito % 4) == 0){ } else { total+=9; } if ((numerito % 3) == 0){ total+=3; } else if ((numerito % 4) == 0){ } else { total+=9; } Vector cadenas = new Vector(); cadenas.addElement("a"); cadenas.addElement("a"); cadenas.addElement("a"); Enumeration enum1 = cadenas.elements(); String cadenaTonta = ""; while (enum1.hasMoreElements()){ cadenaTonta += enum1.nextElement(); } System.err.print(cadenaTonta); return total; } public static void main( String[] args ){ try { new Persona("62626261231"); } catch (java.lang.Throwable ex) { System.out.println("error: " + ex); } } } |
Definición y configuración del plugin PMD dentro del pom.xml de nuestro proyecto (autocomentado):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
<?xml version="1.0" encoding="UTF-8"?> <project> <modelVersion>4.0.0</modelVersion> <groupId>pmdEclipsePlugin</groupId> <artifactId>pmdEclipsePlugin</artifactId> <name>pmdEclipsePlugin</name> <version>1.0-SNAPSHOT</version> <url>http://maven.apache.org</url> <packaging>jar</packaging> <!-- Informes del Site --> <reporting> <plugins> <!-- Definición y configuración del plugin PMD --> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-pmd-plugin</artifactId> <version>2.4</version> <configuration> <!-- Codificación del código fuente --> <sourceEncoding>utf-8</sourceEncoding> <!-- Para el análisis de CPD: Si dos bloques de al menos 20 palabras son iguales se reportará en el resultado --> <minimumTokens>20</minimumTokens> <!-- Código fuente para 1.5 --> <targetJdk>1.4</targetJdk> <!-- ¿Qué reglas deseamos aplicar? Por defecto si no se dice nada se aplican las reglas: basic, unusedcode, imports Puede ver un listado de todos los ruleset en: http://pmd.sourceforge.net/rules/index.html --> <rulesets> <!-- Estas reglas están dentro del JAR del PMD --> <ruleset>/rulesets/basic.xml</ruleset> <ruleset>/rulesets/braces.xml</ruleset> <ruleset>/rulesets/design.xml</ruleset> <ruleset>/rulesets/unusedcode.xml</ruleset> <ruleset>/rulesets/imports.xml</ruleset> <ruleset>/rulesets/controversial.xml</ruleset> <ruleset>/rulesets/migrating.xml</ruleset> <ruleset>/rulesets/strings.xml</ruleset> <ruleset>/rulesets/optimizations.xml</ruleset> <!-- Puedo definir mis propios ruleset o modificar uno existente, colocarlo en el sistema de fichero y hacer referencia a el. Por ejemplo: <ruleset>c:/java/pmd/my_rules/naming2.xml</ruleset> --> </rulesets> <!-- Si no ponemos reportSets se generan todos los informes. Si queremos desahilitar alguno podemos comentarlo --> <reportSets> <reportSet> <reports> <report>pmd</report> <report>cpd</report> </reports> </reportSet> </reportSets> </configuration> </plugin> </plugins> </reporting> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>3.8.1</version> <scope>test</scope> </dependency> </dependencies> </project> |
Generación del Site
A través de línea de comandos, ejecutando:
mvn site
Desde Eclipse, haciendo clic con el botón derecho del ratón sobre el proyecto:
Informe PMD generado por el plugin
El informe nos reporta las siguientes advertencias:
Informe CPD generado por el plugin
El informe nos indica que hay un bloque de código repetido en nuestro proyecto.
Conclusiones
Sin lugar a dudas, Maven ha supuesto un antes y un después en la gestión de proyectos.
En Autentia, llevamos años usándolo e intentamos sacar todo su potencial a través del uso de plugin como el que se ha mostrado en este tutorial.
Bueno, eso es todo, un saludo.
Carlos García. Creador de MobileTest.
