Création d'états avec JasperReports et JSF

Faisel Chabli

Cet article a pour objectif de vous présenter une des façons pour éditer un état JasperReports depuis une application JSF. ♪

- Titre : Création d'états avec JasperReports et JSF

- Auteur : Faisel Chabli

- Parution : 19 mars 2008

- Licence : Ce document est issu de http://www.developpez.com et reste la propriété exclusive de son auteur. La copie, modification et/ou distribution par quelque moyen que ce soit est soumise à l'obtention préalable de l'autorisation de l'auteur.

Sommaire

- I. Introduction

- II. Génération du fichier source de l'état via iReport

- II-A. Présentation

- II-B. Téléchargement et installation

- II-C. Configuration de la source de données

- II-D. Configuration du répertoire de compilation

- II-E. Génération de l'état

- III. Exécuter un état depuis JSF

- III-A. Configuration de l'environnement de travail

- III-B. Création du managedBean

- III-C. Configuration du managedBean dans le fichier faces-config.xml

- III-D. La création de la page JSF

- III-E. L'exécution du projet

- IV. Conclusion

- V. Remerciements

I - Introduction

Cet article servira à présenter les tâches de création d'un état JasperReports avec iReport ainsi que son utilisation depuis une application JSF.

II - Génération du fichier source de l'état via iReport

II-A - Présentation

Selon définition : un état est tout simplement : un document présentant des informations organisées pour leur visualisation ou leur impression (pas de modification ou de mise à jour des infos possibles). La liste des objets présents dans le stock d'une boutique est un exemple d'état. Syn: Rapport.

Jasper interprète un fichier source xml (.jrxml) qui définit le format de l'état, y injecte les données de l'utilisateur et génère des états dans divers formats (PDF, Excel, etc.) iReport est une sorte de WYSIWYG qui sert à éditer le fichier jrxml.

Les outils utilisés pour fournir cet exemple sont : Eclipse/Tomcat5.5/MySQL5.0/iReport2.0.1.

Notre base à exploiter est composée d'une seule table Person qui contient les champs suivant : id, nom, prenom, age. À partir de cette table, on veut générer un état iReport pour le compiler et ensuite l'exécuter à partir d'une application JSF afin de l'exporter en PDF et Excel.

II-B - Téléchargement et installation

J'utilise iReport 2.0.1 pour la création des états, il peut être téléchargé à partir de téléchargement de iReport. Après avoir téléchargé iReport 2.0.1 mettez-le dans votre répertoire favori et lancez-le en cliquant sur iReport.exe sans aucune installation.

II-C - Configuration de la source de données

Avant de commencer à réaliser ses états, il va falloir configurer la source de données pour pouvoir se connecter à la base de données et éditer l'état sous iReport avant de passer son fichier compilé (le fichier JASPER) pour le déploiement. Cette source de données nous servira uniquement pour faire des tests d'exécution de notre état sous iReport. À noter que ce n'est pas cette source de données qui sera utilisée dans notre application JSF. Pour faire cette configuration, vous allez sur le menu : Données-->Connexions/Sources de données, cliquez dessus :

Une fenêtre s'ouvre pour configurer sa connexion au SGBD :

Cliquez sur Nouveau, choisissez Connexion JDBC de base de données et cliquez sur suivant et entrez vos paramètres de connexion comme suit :

Pilote JDBC : représente le Driver de la base de données à utiliser. L'outil iReport cherche par défaut le driver, sous format .JAR, dans le dossier lib situé dans le répertoire d'installation de iReport. Dans mon cas, le lib est sur C:\softwares\iReport-2.0.1\ iReport-2.0.1\lib. Dans ce dossier, on trouve bien le driver de MySQL, à savoir mysql-connectorjava-3.1.11-bin.jar. Si le driver de la base ne se trouve pas dans ce dossier, alors il va falloir le paramétrer en l'ajoutant au chemin de classe de iReport. Pour ajouter un driver, qui ne se trouve pas par défaut dans le lib de iReport, au chemin de classe il suffit d'aller sur Options-->Chemin de classe :

Après cliquer sur Ajouter JAR pour sélectionner le JAR du driver souhaité. URL JDBC : représente l'adresse de connexion à votre base de données.

Adresse du serveur : représente le nom ou l'adresse IP de la machine contenant la base de données à partir de laquelle vous souhaitez éditer vos états.

Nom d'utilisateur/mot de passe : c'est le nom d'utilisateur /mot de passe de la base de données.

Cliquez sur Test pour voir si la connexion a été bien effectuée à votre base de données, après faites enregistrer.

II-D - Configuration du répertoire de compilation

Le fichier résultant d'une compilation sera déposé par défaut dans la racine où est installé le répertoire de iReport. Il vaut mieux donc avoir un répertoire dédié aux fichiers compilés, un répertoire que vous pouvez configurer à partir de Options-->Paramètres-->Onglet Compiler-->faites parcourir sur le répertoire de compilation par défaut pour sélectionner votre répertoire qui contiendra dorénavant vos fichiers compilés, les JASPER.

II-E - Génération de l'état

Maintenant que votre connexion a été configurée, on passe à la création de notre premier état. On va utiliser l'assistant de iReport pour créer nos états. Faites un clic sur le bouton de l'assistant en haut à gauche :

Dans la fenêtre qui s'ouvre, saisissez votre requête SQL.

Vérifiez bien si votre connexion est bien sélectionnée dans Connexions/Sources de données.

Cliquez sur Suivant> et sélectionnez les champs que vous souhaitez éditer, dans notre cas on sélectionnera tous les champs.

Cliquez sur suivant. L'écran suivant permet de faire des groupements, dans notre cas, on n'en aura pas besoin. Cet écran se présente comme suit :

Cliquez donc sur suivant pour passer sur l'écran qui nous permettra de sélectionner la mise en page de notre état. Cet écran se présente comme suit :

Sélectionnez le Format tableau (*). Cliquez sur Suivant et après Terminer. Bravo votre premier état est créé sous iReport.

Vous pouvez ajuster les champs pour rendre les choses un peu agréables et belles à voir, pour moi j'utilise un affichage du style :

Format tableau : dans ce format vous aurez les noms des champs en haut, les données correspondantes en bas en ligne. Les noms des champs s'affichent une seule fois sur l'état. Si vous choisissez le Format colonne au lieu du Format tableau alors les noms des champs s'afficheront en ligne et se répéteront pour chaque enregistrement de type :

Cet état est composé d'un titre en haut centré « Liste de toutes les personnes de la base », de la date du système en haut à gauche, cette date est extraite via l'expression new Date(), ensuite une table avec une colonne pour chaque champ de la table.

Une fois votre état conçu vous pouvez l'exécuter pour voir un aperçu des données saisies dans la table Person. Nommez le fichier person.jrxml. Cette exécution va générer un fichier person.jasper qui sera déposé dans le répertoire précédemment configuré.

Après l'exécution de votre état, vérifiez si le fichier jasper a été bien créé dans le répertoire configuré précédemment dans la partie 2.2. Configuration du répertoire de compilation. C'est ce fichier qu'on va utiliser par la suite dans notre application web.

III - Exécuter un état depuis JSF

III-A - Configuration de l'environnement de travail

- jasper-runtime.jar.

- jasperreports-1.2.8.jar.

- mysql-connector-java-5.0.5-bin.jar.

- itext-2.0.1.jar.

- poi-2.0-final-20040126.jar.

Ces JAR sont à mettre dans le CLASSPATH du projet en les ajoutant au chemin de génération.

III-B - Création du managedBean

Dans le dossier src, on va créer un package, par exemple com.jaub.view dans lequel on crée une classe InitPageBean.

Le corps de cette classe est constitué essentiellement de deux méthodes, l'une pour la visualisation Excel, l'autre pour PDF.

Ces deux méthodes se présentent comme suit.

Pour la visualisation PDF :

Code1 - Visualisation PDF

public String viewReportPDF() throws SQLException, JRException, IOException {
String reportId = "Person";
Driver mDriver = new Driver();
DriverManager.registerDriver(mDriver);
Connection connection = DriverManager.getConnection(
Constants.DRIVER_DATABASE_MYSQL,
Constants.LOGIN_DATABASE_MYSQL,
Constants.PASSWORD_DATABASE_MYSQL);
File file = new File(Constants.PATH_OF_REPORTS_JASPER);
JasperPrint jasperPrint = JasperFillManager.fillReport(
new FileInputStream(new File(file, reportId + ".jasper")),
null, connection);
byte[] bytes = JasperExportManager.exportReportToPdf(jasperPrint);
FacesContext context = FacesContext.getCurrentInstance();
HttpServletResponse response = (HttpServletResponse) context
.getExternalContext().getResponse();
/***********************************************************************
* Pour afficher une boîte de dialogue pour enregistrer le fichier sous
* le nom rapport.pdf
**********************************************************************/
response.addHeader("Content-disposition",
"attachment;filename=rapport.pdf");
response.setContentLength(bytes.length);
response.getOutputStream().write(bytes);
response.setContentType("application/PDF");
context.responseComplete();
return null;
}

Pour la visualisation Excel : :

Code2 - Visualisation EXCEL

public String viewReportExcel() throws SQLException, JRException, IOException {
String reportId = "Person";
Driver mDriver = new Driver();
DriverManager.registerDriver(mDriver);
Connection connection = DriverManager.getConnection(
Constants.DRIVER_DATABASE_MYSQL,
Constants.LOGIN_DATABASE_MYSQL,
Constants.PASSWORD_DATABASE_MYSQL);
File file = new File(Constants.PATH_OF_REPORTS_JASPER);
JasperPrint jasperPrint = JasperFillManager.fillReport(
new FileInputStream(new File(file, reportId + ".jasper")),
null, connection);
FacesContext context = FacesContext.getCurrentInstance();
HttpServletResponse response = (HttpServletResponse) context
.getExternalContext().getResponse();
if (jasperPrint != null) {
ByteArrayOutputStream xlsReport = new ByteArrayOutputStream();
JRXlsExporter exporter = new JRXlsExporter();
exporter.setParameter(JRXlsExporterParameter.JASPER_PRINT,
jasperPrint);
exporter.setParameter(JRXlsExporterParameter.OUTPUT_STREAM,
xlsReport);
exporter.exportReport();
// Send response
byte[] bytes = xlsReport.toByteArray();
/*******************************************************************
* Pour afficher une boîte de dialogue pour enregistrer le fichier
* sous le nom rapport.xls
******************************************************************/
response.addHeader("Content-disposition",
"attachment;filename=rapport.xls");
response.setContentType("application/vnd.ms-excel");
response.setContentLength(bytes.length);
response.getOutputStream().write(bytes, 0, bytes.length);
response.getOutputStream().flush();
response.getOutputStream().close();
} else {
Writer writer = response.getWriter();
writer.write("Aucun rapport à afficher");
response.setContentType("text/HTML");
}
return null;
}

La partie accès à la base de données peut être externalisée dans une autre classe, mais comme je l'ai cité au début de cet article, ce n'en est plus l'objectif.

Dans la ligne :

Remarque

JasperPrint jasperPrint = JasperFillManager.fillReport(
new FileInputStream(new File(file, reportId + ".jasper")),
null, connection);

le 3e paramètre de JasperFillManager.fillReport est mis à null. Ce paramètre permet de passer des paramètres à l'état. Dans notre cas, on veut éditer tous les éléments de la table Person, donc on n'a pas de paramètres à passer.

III-C - Configuration du managedBean dans le fichier faces-config.xml

Dans le faces-config.xml on ajoute le bout de code suivant :

Code3- faces-config.xml

<managed-bean>
<managed-bean-name>InitPageBean</managed-bean-name>
<managed-bean-class>
com.jaub.view.InitPageBean
</managed-bean-class>
<managed-bean-scope>session</managed-bean-scope>
</managed-bean>

III-D - La création de la page JSF

Notre page JSF se présente, tout simplement, comme suit :

Code4 - init.jsp

<?xml version="1.0" encoding="UTF-8"?>
<jsp:root version="1.2" xmlns:f="http://java.sun.com/jsf/core"
xmlns:h="http://java.sun.com/jsf/html"
xmlns:jsp="http://java.sun.com/JSP/Page">
<jsp:directive.page contentType="text/html;charset=UTF-8"
pageEncoding="UTF-8" />
<f:view>
<html>
<head>
<title>Test iReport With JSF</title>
</head>
<body style="background-color: #fff4db">
<h:form id="reportForm" target="report">
<h:commandButton id="pdfButton" value="Visualiser PDF"
styleClass="buttonStyle" action="#{InitPageBean.viewReportPDF}" />
<h:commandButton id="excelButton" value="Visualiser EXCEL"
styleClass="buttonStyle" action="#{InitPageBean.viewReportExcel}" />
</h:form>
</body>
</html>
</f:view>
</jsp:root>

On y met deux boutons, l'un pour la visualisation PDF, l'autre pour la visualisation Excel. Chaque bouton a sa propre action. Lors d'un clic sur le bouton « Visualiser PDF » c'est la méthode viewReportPDF du managedBean InitPageBean qui sera appelée, lors d'un clic sur le bouton « Visualiser Excel » c'est la méthode viewReportExcel qui en sera appelée.

III-E - L'exécution du projet

Après avoir tout configuré, lancez le projet JSF et cliquez sur les boutons pour faire vos tests.

Résultat :

IV - Conclusion

Cet article a pour objectif de vous expliquer une des façons pour éditer un état JasperReports depuis une application JSF. Je me suis contenté d'afficher tous les enregistrements d'une table, dans un prochain article je vous expliquerai comment on peut passer des paramètres à notre état pour afficher juste les éléments dont on a besoin.

V - Remerciements

Je tiens à remercier infiniment djo.mos pour ses retours et ses conseils. Je tiens à remercier aussi ArHacKnIdE pour ses corrections orthographiques.