JasperReports - Configuration de l'environnement

JasperReports est une pure bibliothèque Java et non une application autonome. Il ne peut pas s'exécuter seul, il doit donc être intégré dans une autre application Java côté client ou serveur. Comme il est basé sur Java, il peut être exécuté sur n'importe quelle plate-forme prenant en charge Java (JDK 1.3 et supérieur). Toutes les fonctionnalités de JasperReport sont rassemblées dans un seul fichier JAR, jasperreports-xxxjar. Ce JAR ainsi que les bibliothèques obligatoires et facultatives (fichier .ZIP) peuvent être téléchargés à partir du site: JasperReport Library Link . Téléchargez la dernière version à partir de ce lien.

Le fichier ZIP comprend le fichier JAR JasperReports ainsi que le code source JasperReports, les JAR dépendants et de nombreux exemples illustrant les fonctionnalités de JasperReport.

Environnement JasperReport

Pour commencer à créer les rapports, nous devons configurer l'environnement prêt. Extrayez le fichier JasperReport.ZIP téléchargé à n'importe quel emplacement (dans notre cas, nous l'avons extrait dans C: \ tools \ jasperreports-5.0.1). La structure du répertoire du fichier extrait est la même que celle indiquée ci-dessous -

Voici le détail de tous les répertoires -

  • build - Contient les fichiers de classe JasperReport compilés.

  • demo - Contient divers exemples, démontrant plusieurs aspects de la fonctionnalité JasperReports.

  • dist - Contient le fichier jasperreports-xxxjar. Nous ajouterons ce fichier JAR à notre CLASSPATH pour profiter de JasperReports.

  • docs - Contient une copie locale de la documentation JasperReports.

  • lib - Contient tous les JAR nécessaires, à la fois pour construire JasperReports et pour l'utiliser dans nos applications.

  • src - Contient le code source JasperReports.

  • build.xml - Un fichier de construction ANT pour créer le code source JasperReports. Si nous n'avons pas l'intention de modifier JasperReports, nous n'avons pas besoin d'utiliser ce fichier puisque JasperReports est distribué sous la forme compilée.

  • changes.txt - Un document texte, expliquant les différences entre les versions actuelle et précédente de la bibliothèque de classes JasperReports.

  • license.txt - Un document texte qui contient le texte intégral de la licence LGPL (Lesser General Public License).

  • readme.txt - Un document texte, contenant des instructions sur la façon de construire et d'exécuter les exemples fournis.

Fondamentalement, nous utilisons uniquement jasperreports-xxxjar sous dist et JAR sous le répertoire lib pour générer des rapports. Comme JasperReports est un outil open source, si un défaut ou un bogue est reconnu pendant l'exécution dans le jasperreports-xxxjar, nous pouvons le réparer et reconstruire le JAR en utilisant le fichier build.xml.

Réglez le CLASSPATH

Pour utiliser JasperReport, nous devons définir les fichiers suivants sur notre CLASSPATH -

  • jasperreports-xxxjar, où xxx est la version JasperReports. Cela se trouve sous le répertoire C: \ tools \ jasperreports-xxx \ dist).

  • Tous les fichiers JAR du sous- répertoire lib (C: \ tools \ jasperreports-xxx \ lib).

Au moment de l'installation, nous avons utilisé JasperReport version 5.0.1. Cliquez avec le bouton droit sur «Poste de travail» et sélectionnez «Propriétés», cliquez sur le bouton «Variables d'environnement» sous l'onglet «Avancé». Maintenant, mettez à jour la variable 'Path' avec ceciC:\tools\jasperreports-5.0.1\dist\jasperreports-5.0.1.jar:C:\tools\jasperreports-5.0.1\lib. Vous êtes maintenant prêt à créer vos rapports.

Dans tous les exemples de ce tutoriel, nous avons utilisé des tâches ANT pour générer des rapports. lebuildfile se charge d'importer tous les JAR requis pour générer des rapports. Par conséquent, la configuration de CLASSPATH comme mentionné ci-dessus n'aidera que ceux qui souhaitent générer des rapports sans utiliser ANT.

Configuration de la construction

Tous les exemples de ce tutoriel -

  • ont été écrits en utilisant un simple éditeur de texte.

  • ont été enregistrés dans le répertoire C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint.

  • ont été compilés et exécutés à partir de l'invite de commande, à l'aide d'Apache ANT. Nous utiliserons unbaseBuild.xml fichier, que nous importerons dans ANT build.xmlfichier dans les chapitres suivants. Enregistrez ce fichier dans C: \ tools \ jasperreports-5.0.1 \ test. Voici le contenu du fichier 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>

Ce fichier a toutes les cibles requises, comme le nettoyage des répertoires, la compilation des fichiers java et l'exécution des fichiers de classe.

Voici les détails, mentionnés par divers répertoires dans baseBuild.xml. En supposant que le répertoire actuel est C: \ tools \ jasperreports-5.0.1 \ test) -

  • jasper.dir - est le répertoire C: \ tools \ jasperreports-5.0.1

  • lib.dir - est le répertoire C: \ tools \ jasperreports-5.0.1 \ lib

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

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

  • classe principale - com.tutorialspoint.HelpMe. Cette classe est une classe simple exécutée, lorsqu'aucun nom de fichier de classe n'est passé depuis la ligne de commande. Enregistrez ce fichier dans 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 ");
   }
}

Cours de gestionnaires Jasper

Il existe un certain nombre de classes qui seront utilisées pour compiler une conception de rapport JRXML, pour remplir un rapport, pour imprimer un rapport, pour exporter vers des fichiers PDF, HTML et XML, afficher les rapports générés et la conception de rapports.

La liste de ces classes est -

  • net.sf.jasperreports.engine.JasperCompileManager - Utilisé pour compiler un modèle de rapport JRXML.

  • net.sf.jasperreports.engine.JasperFillManager - Utilisé pour remplir un rapport avec les données de la source de données.

  • net.sf.jasperreports.engine.JasperPrintManager - Utilisé pour imprimer les documents générés par la bibliothèque JasperReports.

  • net.sf.jasperreports.engine.JasperExportManager - Utilisé pour obtenir du contenu PDF, HTML ou XML pour les documents produits par le processus de remplissage de rapport.

  • net.sf.jasperreports.view.JasperViewer - Il représente une application Java Swing simple, qui peut charger et afficher des rapports.

  • net.sf.jasperreports.view.JasperDesignViewer - Utilisé au moment du design pour prévisualiser les modèles de rapport.

Configurer Apache ANT

Nous allons construire tous les exemples en utilisant Apache ANT. Veuillez donc consulter le chapitre ANT - Configuration de l'environnement pour configurer Apache ANT sur votre système.