JasperReports — Настройка среды

JasperReports — это чистая библиотека Java, а не отдельное приложение. Он не может работать сам по себе, поэтому его необходимо встроить в другое клиентское или серверное Java-приложение. Поскольку он основан на Java, его можно запускать на любой платформе, поддерживающей Java (JDK 1.3 и выше). Все функциональные возможности JasperReport собраны в одном файле JAR, jasperreports-xxxjar. Этот JAR, а также необходимые и дополнительные библиотеки (файл .ZIP) можно загрузить с сайта: JasperReport Library Link . Загрузите последнюю версию по этой ссылке.

ZIP-файл включает JAR-файл JasperReports вместе с исходным кодом JasperReports, зависимыми JAR-файлами и множеством примеров, демонстрирующих функциональные возможности JasperReport.

JasperReport Environment

Чтобы приступить к созданию отчетов, нам нужно подготовить среду. Извлеките загруженный файл JasperReport.ZIP в любое место (в нашем случае мы распаковали его в C: \ tools \ jasperreports-5.0.1). Структура каталогов извлеченного файла такая же, как показано ниже —

Вот деталь всех каталогов —

• build — Содержит скомпилированные файлы классов JasperReport.

• демо — содержит различные примеры, демонстрирующие несколько аспектов функциональности JasperReports.

• dist — содержит файл jasperreports-xxxjar. Мы добавим этот JAR-файл в наш CLASSPATH, чтобы воспользоваться JasperReports.

• docs — содержит локальную копию документации JasperReports.

• lib — содержит все JAR-файлы, необходимые как для сборки JasperReports, так и для использования в наших приложениях.

• src — содержит исходный код JasperReports.

• build.xml — ANT-файл сборки для сборки исходного кода JasperReports. Если мы не собираемся изменять JasperReports, нам не нужно использовать этот файл, поскольку JasperReports распространяется в скомпилированной форме.

• changes.txt — текстовый документ, объясняющий различия между текущей и предыдущими версиями библиотеки классов JasperReports.

• license.txt — текстовый документ, который содержит полный текст лицензии LGPL (Lesser General Public License).

• readme.txt — текстовый документ, содержащий инструкции о том, как построить и выполнить предоставленные примеры.

build — Содержит скомпилированные файлы классов JasperReport.

демо — содержит различные примеры, демонстрирующие несколько аспектов функциональности JasperReports.

dist — содержит файл jasperreports-xxxjar. Мы добавим этот JAR-файл в наш CLASSPATH, чтобы воспользоваться JasperReports.

docs — содержит локальную копию документации JasperReports.

lib — содержит все JAR-файлы, необходимые как для сборки JasperReports, так и для использования в наших приложениях.

src — содержит исходный код JasperReports.

build.xml — ANT-файл сборки для сборки исходного кода JasperReports. Если мы не собираемся изменять JasperReports, нам не нужно использовать этот файл, поскольку JasperReports распространяется в скомпилированной форме.

changes.txt — текстовый документ, объясняющий различия между текущей и предыдущими версиями библиотеки классов JasperReports.

license.txt — текстовый документ, который содержит полный текст лицензии LGPL (Lesser General Public License).

readme.txt — текстовый документ, содержащий инструкции о том, как построить и выполнить предоставленные примеры.

По сути, мы используем только jasperreports-xxxjar в dist и JAR в каталоге lib для генерации отчетов. Поскольку JasperReports является инструментом с открытым исходным кодом, если во время выполнения в jasperreports-xxxjar обнаружен какой-либо дефект или ошибка, мы можем исправить это и снова собрать JAR-файл, используя файл build.xml.

Установите CLASSPATH

Чтобы использовать JasperReport, нам нужно установить следующие файлы в наш CLASSPATH:

• jasperreports-xxxjar, где xxx — версия JasperReports. Это находится в каталоге C: \ tools \ jasperreports-xxx \ dist).

• Все файлы JAR в подкаталоге lib (C: \ tools \ jasperreports-xxx \ lib).

jasperreports-xxxjar, где xxx — версия JasperReports. Это находится в каталоге C: \ tools \ jasperreports-xxx \ dist).

Все файлы JAR в подкаталоге lib (C: \ tools \ jasperreports-xxx \ lib).

На момент установки мы использовали JasperReport версии 5.0.1. Щелкните правой кнопкой мыши «Мой компьютер» и выберите «Свойства», нажмите кнопку «Переменные среды» на вкладке «Дополнительно». Теперь обновите переменную ‘Path’ с помощью этой C: \ tools \ jasperreports-5.0.1 \ dist \ jasperreports-5.0.1.jar: C: \ tools \ jasperreports-5.0.1 \ lib . Теперь вы готовы создавать свои отчеты.

Во всех примерах этого руководства мы использовали задачи ANT для создания отчетов. Файл сборки заботится об импорте всех необходимых файлов JAR для генерации отчетов. Следовательно, установка CLASSPATH, как упомянуто выше, поможет только тем, кто хочет создавать отчеты без использования ANT.

Настройка сборки

Все примеры в этом уроке —

• были написаны с использованием простого текстового редактора.

• были сохранены в каталоге C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint.

• были скомпилированы и выполнены из командной строки, используя Apache ANT. Мы будем использовать файл baseBuild.xml , который мы импортируем в файл ANT build.xml в следующих главах. Сохраните этот файл в C: \ tools \ jasperreports-5.0.1 \ test. Ниже приводится содержимое файла baseBuild.xml —

были написаны с использованием простого текстового редактора.

были сохранены в каталоге C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint.

были скомпилированы и выполнены из командной строки, используя Apache ANT. Мы будем использовать файл baseBuild.xml , который мы импортируем в файл ANT build.xml в следующих главах. Сохраните этот файл в C: \ tools \ jasperreports-5.0.1 \ test. Ниже приводится содержимое файла 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>

Этот файл имеет все необходимые цели, такие как очистка каталогов, компиляция java-файлов и выполнение файлов классов.

Ниже приведены подробности, упомянутые различными каталогами в baseBuild.xml. Предполагая, что текущим каталогом является C: \ tools \ jasperreports-5.0.1 \ test) —

• jasper.dir — это каталог C: \ tools \ jasperreports-5.0.1

• lib.dir — это каталог C: \ tools \ jasperreports-5.0.1 \ lib

• src.dir — это C: \ tools \ jasperreports-5.0.1 \ test \ src

• classes.dir — это C: \ tools \ jasperreports-5.0.1 \ test \ classes

• основной класс — com.tutorialspoint.HelpMe. Этот класс выполняется простым классом, когда имя файла класса не передается из командной строки. Сохраните этот файл в C: \ tools \ jasperreports-5.0.1 \ test \ src \ com \ tutorialspoint.

jasper.dir — это каталог C: \ tools \ jasperreports-5.0.1

lib.dir — это каталог C: \ tools \ jasperreports-5.0.1 \ lib

src.dir — это C: \ tools \ jasperreports-5.0.1 \ test \ src

classes.dir — это C: \ tools \ jasperreports-5.0.1 \ test \ classes

основной класс — com.tutorialspoint.HelpMe. Этот класс выполняется простым классом, когда имя файла класса не передается из командной строки. Сохраните этот файл в 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 ");
   }
}

Джаспер Менеджеры Классы

Существует несколько классов, которые будут использоваться для компиляции дизайна отчета JRXML, для заполнения отчета, печати отчета, экспорта в файлы PDF, HTML и XML, просмотра сгенерированных отчетов и дизайна отчета.

Список этих классов —

• net.sf.jasperreports.engine.JasperCompileManager — используется для компиляции шаблона отчета JRXML.

• net.sf.jasperreports.engine.JasperFillManager — используется для заполнения отчета данными из источника данных.

• net.sf.jasperreports.engine.JasperPrintManager — используется для печати документов, созданных библиотекой JasperReports.

• net.sf.jasperreports.engine.JasperExportManager — используется для получения содержимого PDF, HTML или XML для документов, созданных в процессе заполнения отчета.

• net.sf.jasperreports.view.JasperViewer — представляет собой простое приложение Java Swing, которое может загружать и отображать отчеты.

• net.sf.jasperreports.view.JasperDesignViewer — используется во время разработки для предварительного просмотра шаблонов отчетов.

net.sf.jasperreports.engine.JasperCompileManager — используется для компиляции шаблона отчета JRXML.

net.sf.jasperreports.engine.JasperFillManager — используется для заполнения отчета данными из источника данных.

net.sf.jasperreports.engine.JasperPrintManager — используется для печати документов, созданных библиотекой JasperReports.

net.sf.jasperreports.engine.JasperExportManager — используется для получения содержимого PDF, HTML или XML для документов, созданных в процессе заполнения отчета.

net.sf.jasperreports.view.JasperViewer — представляет собой простое приложение Java Swing, которое может загружать и отображать отчеты.

net.sf.jasperreports.view.JasperDesignViewer — используется во время разработки для предварительного просмотра шаблонов отчетов.

Настройка Apache ANT

Мы собираемся собрать все примеры, используя Apache ANT. Поэтому, пожалуйста, ознакомьтесь с главой ANT — Настройка среды, чтобы настроить Apache ANT в вашей системе.