Generación de Informes y Documentación de Software con Java, Pruebas y Control de Versiones

UT4: Tipos de Informes

Tipos de Informes

• Incrustados: Informe importado a un proyecto o creado en él. Se genera automáticamente una clase contenedora para el informe. El código del proyecto interactúa con la clase, no con el informe original. Se compila con el proyecto.
  • Ventajas: Simplifica el proyecto al reducir el número de archivos y evita la gestión de rutas de informes.
• No Incrustados: Informe externo al proyecto, ubicado en un dispositivo externo. No se importa, por lo que no se crea una clase contenedora. Se abre en tiempo de ejecución.
  • Ventajas: Recomendable para informes que...

Aplicaciones

• Crystal Reports: Relacionado con Microsoft Visual Studio.
• JasperReports: Escrito en Java, utilizado en una gran variedad de aplicaciones Java, J2EE y web. Bajo licencia GNU. Utiliza iReport, un front-end gráfico de código abierto.
• ReportLab: Librería para la generación de informes en Python. Software libre.
• DataReport: Fácil de usar.
• Geraldo Reports: ...

Estructura del Informe

• Título: Solo en la primera página. Contiene el logo, fecha, nombre del informe, etc.
• Cabecera: Al principio de todas las páginas. Puede contener anotaciones generales como nombre, dirección, etc.
• Página: Filas o registros que conforman el reporte.
• Pie de Informe: Una sola vez al finalizar el informe. Se utiliza para imprimir totales, promedios, etc.
• Pie de Página (Summary): Al final de cada página. Se utiliza para la paginación total de hojas.

Java: Clases CrearReport, MostrarReport, ExportarPDF

public static void crearReporte(Connection con, String path) {
    try {
        System.out.println("hola");
        report = (JasperReport) JRLoader.loadObjectFromFile(path);
        reportFilled = JasperFillManager.fillReport(report, null, con);
        System.out.println("adios");
    } catch (Exception e) {
        e.printStackTrace();
    }
}

public static void crearReporte(Connection con, String path, Map parametros) {
    try {
        System.out.println("hola");
        report = (JasperReport) JRLoader.loadObjectFromFile(path);
        reportFilled = JasperFillManager.fillReport(report, parametros, con);
        System.out.println("adios");
    } catch (Exception e) {
        e.printStackTrace();
    }
}

public static void mostarReporte() {
    viewer = new JasperViewer(reportFilled);
    viewer.setVisible(true);
}

public static void exportarPDF(String path) {
    try {
        JasperExportManager.exportReportToPdfFile(reportFilled, path);
    } catch (Exception e) {
        e.printStackTrace();
    }
}

UT5: JavaDoc

JavaDoc es una utilidad de Oracle para generar documentación de API's en formato HTML a partir del código Java. Es el estándar de la industria para documentar clases de Java. La mayoría de los IDE's lo generan automáticamente, facilitando la actualización de la documentación. El uso de librerías de terceros es más sencillo gracias a esta documentación estandarizada.

Para comentar en JavaDoc se utiliza: /** Comentarios JavaDoc */

• @author: Nombre del desarrollador.
• @deprecated: Indica que un método es antiguo.
• @param: Define un parámetro de un método (requerido para todos los parámetros).
• @return: Informa de lo que devuelve el método.
• @see: Asocia con otro método o clase.
• @throws: Lanza excepciones.
• @version: Versión del método o clase.

UT6: GitHub

• Commit: Guardar una serie de cambios realizados.
• Push: Subir los commits locales al repositorio remoto.
• Pull: Descargar la versión más actualizada del repositorio remoto.
• Clone: Copiar un repositorio completo, incluyendo su historial, desde otro PC.
• Branch: Ramificación del repositorio.
• Master: Rama principal.
• Head: Revisión más actual de la rama actual.
• Origin: Servidor al que se envían los cambios con un push.

UT7: Pruebas de Software

Son investigaciones empíricas y técnicas para obtener información sobre la calidad del producto.

• Verificación: Determina si los productos de una fase cumplen las condiciones impuestas al inicio de la misma.
• Validación: Determina si se cumplen los requisitos del usuario.

Caja Blanca (pruebas estructurales): Se centra en el comportamiento y la estructura interna.

Caja Negra (pruebas de integración): Se centra en el comportamiento externo, estudiando las entradas y salidas.

Tipos de pruebas: De carga, de capacidad, de estrés, de estabilidad, de aislamiento y de regresión de rendimiento.

• Versión Alfa: Realizada por un cliente en un entorno controlado, con el desarrollador observando y registrando errores.
• Versión Beta: Realizada por usuarios finales en sus entornos de trabajo, sin la presencia del desarrollador. Los usuarios registran los problemas.