Saltar al contenido principal

Herramientas

Maven​

Maven es una herramienta de gestión de proyectos y automatización del proceso de construcción que se utiliza principalmente en proyectos de Java. Forma parte del ecosistema de Java y fue desarrollado por Apache Software Foundation. Aquí tienes una explicación detallada sobre qué es Maven, sus características y cómo funciona:

  • Gestión de dependencias: Maven permite que los desarrolladores especifiquen las bibliotecas y dependencias necesarias para su proyecto en un archivo de configuración llamado pom.xml (Project Object Model). Cuando se compila el proyecto, Maven descarga automáticamente estas dependencias desde repositorios centralizados (como Maven Central) o locales, lo que simplifica la gestión de bibliotecas.
  • Estandarización: Maven establece una estructura de proyecto común y unificada, que facilita la colaboración entre desarrolladores y la comprensión del proyecto por parte de nuevos miembros del equipo. La estructura de directorios y el ciclo de vida de los proyectos siguen convenciones que facilitan la organización y la coherencia.
  • Ciclo de vida de construcción: Maven define un ciclo de vida de construcción, que es una serie de fases que se ejecutan para compilar, probar, empaquetar e implementar un proyecto. Algunas de las fases principales son:
    • validate: Comprobar que el proyecto está correcto y que toda la información necesaria está disponible.
    • compile: Compilar el código fuente del proyecto.
    • test: Ejecutar las pruebas unitarias.
    • package: Empaquetar el código compilado en formatos como JAR o WAR.
    • install: Instalar el paquete en el repositorio local.
    • deploy: Copiar el paquete a un repositorio remoto para que otros proyectos puedan usarlo.
  • Plugins: Maven tiene un sistema de plugins que permite ampliar sus funcionalidades. Los plugins son módulos que ejecutan tareas específicas, como compilar código, ejecutar pruebas, crear documentación y generar informes. Existen muchos plugins disponibles que se pueden usar para diversas tareas, y también es posible crear tus propios plugins.
  • Facilidad de integración: Maven se integra bien con herramientas de automatización y CI/CD (Integración Continua/Despliegue Continuo) como Jenkins, Bamboo y Travis CI, facilitando así el desarrollo ágil.

Instalación​

Para instalar Maven en Debian, puedes seguir estos pasos:

sudo apt update
sudo apt upgrade
sudo apt install maven
mvn -version

Para instalar Maven en Windows, puedes usar Chocolatey, un gestor de paquetes para Windows que facilita el proceso de instalación de Maven.

  1. Abre PowerShell como administrador y ejecuta el siguiente comando para instalar Chocolatey (si no lo tienes instalado ya):

    Set-ExecutionPolicy Bypass -Scope Process -Force; `
    [System.Net.ServicePointManager]::SecurityProtocol = `
    [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; `
    iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

  2. Una vez completada la instalación, cierra y vuelve a abrir PowerShell o CMD.

  3. Una vez instalado Chocolatey, simplemente ejecuta este comando en CMD o PowerShell:

    choco install maven

  4. Después de instalar Maven, usa el comando mvn -version para verificar que está instalado correctamente:

    mvn -version

Estructura de un proyecto​

Un proyecto de Maven normalmente tiene una estructura de directorios específica. La estructura típica es:

my-project/
├── pom.xml          # Archivo de configuración de Maven
└── src/
    ├── main/
    │   └── java/   # Código fuente del proyecto
    └── test/
        └── java/   # Código de pruebas

El archivo pom.xml contiene toda la información del proyecto, como las dependencias, la versión del proyecto, la descripción, el grupo y el artefacto, así como las configuraciones específicas para los plugins que se utilizarán.

Un artefacto (artifact) es el archivo resultante de un proyecto o una dependencia que el proyecto necesita. Puede ser un JAR, WAR, EAR u otro archivo generado al compilar un proyecto.

Cada artifact se identifica de forma única por su groupId, artifactId, version y packaging.

<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>3.3.2</version>

Ejemplo básico de pom.xml:

<project xmlns="http://maven.apache.org/POM/4.0.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>my-project</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

Maven ofrece una interfaz de línea de comandos para ejecutar diferentes tareas, como compilar, probar y empaquetar el proyecto. Por ejemplo, para compilar y probar el proyecto, usarías:

mvn clean install

Javadoc​

Javadoc es una herramienta integrada en la plataforma Java que permite la creación de documentación en formato HTML a partir de comentarios en el código fuente de aplicaciones Java. Esta documentación sirve para describir clases, métodos, campos y paquetes, proporcionando una forma clara y estructurada de comunicar la funcionalidad del código a los desarrolladores y usuarios. Sus características son:

  • Comentarios estructurados: Para usar Javadoc, los desarrolladores deben escribir comentarios específicos antes de las declaraciones de clases, métodos y campos. Estos comentarios utilizan una sintaxis especial que Javadoc reconoce para generar la documentación. La estructura básica de un comentario Javadoc comienza con un delimitador /** y termina con un */. Dentro del comentario, los desarrolladores pueden usar etiquetas para describir diferentes aspectos, como parámetros, valores de retorno y ejemplos de uso.
  • Etiquetas Javadoc: Javadoc permite el uso de varias etiquetas para organizar la documentación. Algunos ejemplos de etiquetas son:
    • @param: Descripción de los parámetros de entrada de un método.
    • @return: Descripción del valor que retorna un método.
    • @throws o @exception: Describe las excepciones que un método puede lanzar.
    • @see: Proporciona referencias a otras clases o métodos relacionados.
    • @deprecated: Indica que un método o clase no debería ser utilizado y puede ser eliminado en futuras versiones.
  • Generación de documentación: La herramienta Javadoc analiza los comentarios en el código fuente y genera automáticamente archivos HTML que contienen la documentación estructurada. Para generar la documentación, simplemente se ejecuta un comando en línea de comandos o se usa un script en el entorno de desarrollo. La generación de documentación normalmente se realiza mediante la siguiente instrucción: 
    javadoc -d directorio_destino -sourcepath ruta_fuente paq1/clase1.java paq2/clase2.java
  • Integración con IDEs: Muchos IDEs, como IntelliJ IDEA, Eclipse y NetBeans, ofrecen soporte para Javadoc, facilitando la escritura de comentarios y la generación de documentación a través de interfaces gráficas.
  • Documentación útil para desarrolladores: La documentación generada por Javadoc proporciona información sobre cómo usar la API o clase, lo que es especialmente útil para desarrolladores que utilizan bibliotecas o frameworks. Permite que la documentación sea accesible y comprensible sin tener que leer el código fuente directamente.

SonarLint​

SonarLint es una herramienta de análisis estático de código que ayuda a los desarrolladores a detectar y corregir problemas de calidad en su código en tiempo real. Está integrada en entornos de desarrollo (IDE) y proporciona retroalimentación inmediata sobre problemas como vulnerabilidades de seguridad, errores de programación y prácticas de codificación inadecuadas. Sus características son:

  • Análisis en tiempo real: SonarLint analiza el código a medida que se escribe, ofreciendo feedback inmediato sobre problemas de calidad. Esto permite que los desarrolladores corrijan errores y mejoren el código antes de realizar el commit.
  • Soporte para múltiples lenguajes: La herramienta admite diversos lenguajes de programación, incluyendo Java, JavaScript, Python, C#, PHP, entre otros. Cada lenguaje tiene sus propias reglas de análisis adaptadas.
  • Integración con IDEs: SonarLint está disponible como complemento para varios IDEs populares, como IntelliJ IDEA, Eclipse, Visual Studio, y VS Code. Esta integración permite que los desarrolladores usen la herramienta directamente en su entorno de programación habitual.
  • Reglas de calidad configurables: SonarLint utiliza un conjunto de reglas predefinidas para evaluar el código, pero también permite a los usuarios personalizar y habilitar o deshabilitar reglas específicas según las necesidades del proyecto.
  • Detección de problemas: La herramienta identifica una variedad de problemas, incluyendo:
    • Vulnerabilidades de seguridad: Problemas que podrían exponer la aplicación a ataques.
    • Errores de programación: Problemas que podrían causar fallos en la aplicación.
    • Malas prácticas de codificación: Código que no sigue las convenciones o mejores prácticas.
  • Integración con SonarQube: SonarLint puede funcionar como una extensión de SonarQube, que es una plataforma de análisis de código a nivel de proyecto. Esta integración permite que los desarrolladores comparen la calidad de su código local con la que se tiene en el servidor de SonarQube, promoviendo la coherencia entre diferentes equipos.