JasperReports - Configuración del entorno

JasperReports es una biblioteca Java pura y no una aplicación independiente. No puede ejecutarse por sí solo, por lo que debe integrarse en otra aplicación Java del lado del cliente o del servidor. Como está basado en Java, se puede ejecutar en cualquier plataforma que admita Java (JDK 1.3 y superior). Todas las funcionalidades de JasperReport están reunidas en un solo archivo JAR, jasperreports-xxxjar. Este JAR junto con las bibliotecas requeridas y opcionales (archivo .ZIP) se pueden descargar desde el sitio: JasperReport Library Link . Descargue la última versión desde este enlace.

El archivo ZIP incluye el archivo JAR de JasperReports junto con el código fuente de JasperReports, los JAR dependientes y muchos ejemplos que demuestran las funcionalidades de JasperReport.

Entorno JasperReport

Para comenzar a crear los informes, debemos configurar el entorno listo. Extraiga el archivo JasperReport.ZIP descargado a cualquier ubicación (en nuestro caso, lo hemos extraído a C: \ tools \ jasperreports-5.0.1). La estructura del directorio del archivo extraído es la misma que se muestra a continuación:

Aquí está el detalle de todos los directorios:

  • build : contiene los archivos de clase JasperReport compilados.

  • demo : contiene varios ejemplos que demuestran varios aspectos de la funcionalidad de JasperReports.

  • dist : contiene el archivo jasperreports-xxxjar. Agregaremos este archivo JAR a nuestro CLASSPATH para aprovechar JasperReports.

  • docs : contiene una copia local de la documentación de JasperReports.

  • lib : contiene todos los archivos JAR necesarios, tanto para compilar JasperReports como para usarlo en nuestras aplicaciones.

  • src : contiene el código fuente de JasperReports.

  • build.xml : un archivo de compilación ANT para compilar el código fuente de JasperReports. Si no tenemos la intención de modificar JasperReports, no necesitamos usar este archivo ya que JasperReports se distribuye en forma compilada.

  • changes.txt : un documento de texto que explica las diferencias entre las versiones actual y anterior de la biblioteca de clases JasperReports.

  • license.txt : un documento de texto que contiene el texto completo de la licencia LGPL (Licencia pública general reducida).

  • readme.txt : un documento de texto que contiene instrucciones sobre cómo crear y ejecutar los ejemplos proporcionados.

Básicamente, solo usamos jasperreports-xxxjar en dist y JAR en el directorio lib para generar informes. Como JasperReports es una herramienta de código abierto, si se reconoce algún defecto o error durante la ejecución en jasperreports-xxxjar, podemos solucionarlo y compilar el JAR nuevamente usando el archivo build.xml.

Establecer el CLASSPATH

Para usar JasperReport, necesitamos configurar los siguientes archivos en nuestro CLASSPATH -

  • jasperreports-xxxjar, donde xxx es la versión de JasperReports. Esto se encuentra en el directorio C: \ tools \ jasperreports-xxx \ dist).

  • Todos los archivos JAR del subdirectorio lib (C: \ tools \ jasperreports-xxx \ lib).

En el momento de la instalación, usamos JasperReport versión 5.0.1. Haga clic con el botón derecho en 'Mi PC' y seleccione 'Propiedades', haga clic en el botón 'Variables de entorno' en la pestaña 'Avanzado'. Ahora actualice la variable 'Ruta' con estoC:\tools\jasperreports-5.0.1\dist\jasperreports-5.0.1.jar:C:\tools\jasperreports-5.0.1\lib. Ahora está listo para crear sus informes.

En todos los ejemplos de este tutorial, hemos utilizado tareas ANT para generar informes. losbuildfile se encarga de importar todos los archivos JAR necesarios para generar informes. Por lo tanto, configurar CLASSPATH como se mencionó anteriormente solo ayudará a aquellos que deseen generar informes sin usar ANT.

Configuración de compilación

Todos los ejemplos de este tutorial:

  • se han escrito utilizando un editor de texto simple.

  • se han guardado en el directorio C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint.

  • se han compilado y ejecutado desde el símbolo del sistema, utilizando Apache ANT. Usaremos unbaseBuild.xml archivo, que importaremos en ANT build.xmlarchivo en los capítulos siguientes. Guarde este archivo en C: \ tools \ jasperreports-5.0.1 \ test. A continuación se muestra el contenido del archivo baseBuild.xml:

<?xml version = "1.0" encoding = "UTF-8"?>
<project name = "JasperReportExample" basedir = ".">
   <description>Previews our JasperReport XML Design</description>
   <property name = "file.name" value = "jasper_report_template" />
   
   <!-- Directory where the JasperReports project file was extracted
   needs to be changed to match the local environment -->
   <property name = "jasper.dir" value = "../" />
   <property name = "dist.dir" value = "${jasper.dir}/dist" />
   <property name = "lib.dir" value = "${jasper.dir}/lib" />
   <property name = "src.dir" value = "src" />
   <property name = "classes.dir" value = "classes" />
   <property name = "main-class" value = "com.tutorialspoint.HelpMe" />

   <path id = "classpath">
      <pathelement location = "./" />
      <pathelement location = "${classes.dir}" />
	  
      <fileset dir = "${lib.dir}">
         <include name = "**/*.jar" />
      </fileset>
	  
      <fileset dir = "${dist.dir}">
         <include name = "**/*.jar" />
      </fileset>
   </path>
   
   <target name = "compile" depends = "clean-sample">
      <mkdir dir = "${classes.dir}"/>
		
      <javac srcdir = "${src.dir}" destdir = "${classes.dir}" 
         classpathref = "classpath" />
   </target>
   
   <target name = "run" depends = "compile">
      <echo message = "Running class : ${main-class}"/>
	  
      <java fork = "true" classname = "${main-class}">
         <classpath>
            <path refid = "classpath" />
         </classpath>
      </java>
   </target>
   
   <target name = "clean-sample">
      <delete dir = "${classes.dir}" />
      <delete file = "./${file.name}.jasper" />
      <delete file = "./${file.name}.jrprint" />
   </target>
   
</project>

Este archivo tiene todos los destinos requeridos, como limpiar los directorios, compilar los archivos java y ejecutar los archivos de clase.

A continuación se muestran los detalles, mencionados por varios directorios en baseBuild.xml. Suponiendo que el directorio actual es C: \ tools \ jasperreports-5.0.1 \ test) -

  • jasper.dir - es el directorio C: \ tools \ jasperreports-5.0.1

  • lib.dir - es el directorio C: \ tools \ jasperreports-5.0.1 \ lib

  • src.dir - es C: \ tools \ jasperreports-5.0.1 \ test \ src

  • classes.dir - es C: \ tools \ jasperreports-5.0.1 \ test \ classes

  • clase principal - com.tutorialspoint.HelpMe. Esta clase es una clase simple que se ejecuta, cuando no se pasa ningún nombre de archivo de clase desde la línea de comandos. Guarde este archivo en C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint.

package com.tutorialspoint;

public class HelpMe {
   public static void main(String[] args) {
      System.out.println("This is the default class executed."
         + "Please pass the fully qualified class" + " name to be executed as command line"
         + " parameter, for example," + " com.tutorialspoint.HelpMe ");
   }
}

Clases de gerentes de Jasper

Hay varias clases que se utilizarán para compilar un diseño de informe JRXML, para completar un informe, para imprimir un informe, para exportar a archivos PDF, HTML y XML, ver los informes generados y diseñar el informe.

La lista de estas clases es:

  • net.sf.jasperreports.engine.JasperCompileManager: se utiliza para compilar una plantilla de informe JRXML.

  • net.sf.jasperreports.engine.JasperFillManager: se utiliza para completar un informe con datos de la fuente de datos.

  • net.sf.jasperreports.engine.JasperPrintManager: se utiliza para imprimir los documentos generados por la biblioteca JasperReports.

  • net.sf.jasperreports.engine.JasperExportManager: se utiliza para obtener contenido PDF, HTML o XML para los documentos producidos por el proceso de llenado de informes.

  • net.sf.jasperreports.view.JasperViewer: representa una aplicación Java Swing simple, que puede cargar y mostrar informes.

  • net.sf.jasperreports.view.JasperDesignViewer: se utiliza en el momento del diseño para obtener una vista previa de las plantillas de informes.

Configuración de Apache ANT

Vamos a construir todos los ejemplos usando Apache ANT. Por lo tanto, consulte el capítulo ANT - Configuración del entorno para configurar Apache ANT en su sistema.