jasperreports_JasperReports JSF插件用例系列

jasperreports

这是文章系列的切入点，在该系列文章中，我将尝试介绍JasperReport JSF插件的一些用例，该工具的创建是为了轻松地将为JasperReports设计的业务报告集成到JSF应用程序中。该系列中描述的所有示例都可以从JasperReports JSF插件网站的“ 示例”部分获得，并将成为同一业务应用程序的一部分：在线书店。

本系列将介绍构建前面提到的Web应用程序所需的步骤。我将尝试使文章尽可能整洁，独立且完整，但是我将故意省略某些与此处没有公开的主要技术没有特别关系的部分。这样，每篇文章都将直达重点，并且不会太冗长，从而使人们更容易理解主要演员及其角色。

在深入介绍JasperReports JSF插件的不同场景的材料之前，我们需要设置Web应用程序项目，这将是进一步使用案例的起点。本系列中用于该项目的主要工具如下：

JasperReports 4.5.1：报告引擎。
iReport 4.5.1：可视报表设计器
Java Server Faces 1.2和Facelets 1.1.1：我的应用程序的Web框架（请注意，可以轻松地将其迁移到JSF 2.x中）。
JasperReports JSF插件 1.0：报告引擎和Web框架之间的集成桥梁。
Apache Derby 10.8.2.2：将保存我们所需信息的数据库。
Apache Tomcat 6.0.35：将用于部署和测试应用程序的应用程序服务器。

每个特定报告要显示的数据将来自具有几个表的简单数据库，这些表将保存我们所需的信息。我将用来复合域模型的主要实体基本上是：帐簿，客户，订单和订单行 。

内容

1项目设置
2配置iReport
3域模型
4。结论

项目设置

我将采用的方法是创建一个新的基于Web的项目，该项目将使用该数据库模型。我将使用Maven来配置和管理将要使用的依赖项，因为我已经习惯了它，这将避免我独立获取所有jar文件并在我的代码库中手动配置它们。其他任何人都可以使用他/她喜欢的工具（ Ant ， Gradle ，基于IDE等）。

使用Maven做到这一点的一个很好的例子是Maven Book中的“ simple-webapp”原型样本。我将在此处发布使用该原型生成项目结构时使用的命令行语句：

mvn archetype:create -DgroupId=net.sf.jasperreports.jsf.sample
-DartifactId=jrjsf-usecases
-Dpackage=net.sf.jasperreports.jsf.sample.usecases
-Dversion=1.0-SNAPSHOT
-DarchetypeArtifactId=maven-archetype-webapp
-DarchetypeGroupId=org.apache.maven.archetypes
-DarchetypeVersion=1.0

这将在名为jrjsf-usecases且具有以下初始值的文件夹中生成一个Maven项目：

groupId ： net.sf.jasperreports.jsf.sample
artifactId ： jrjsf用例
版本： 1.0-快照
包： net.sf.jasperreports.jsf.sample.usecases

现在，需要对pom.xml文件进行一些修改，以保存我们项目所需的依赖项。我将做的主要更改将包括添加对Java 1.5（及更高版本）的支持以及对本文开头列出的项目的依赖性。

为了能够使用Java 5发行后添加到Java的泛型和其他高级功能，我们需要配置maven-compiler-plugin，以便Java编译器可以识别出我们希望支持这些功能：

<project>...<build><plugins><plugin><artifactId>maven-compiler-plugin</artifactId><groupId>org.apache.maven.plugins</groupId><configuration><source>1.5</source><target>1.5</target></configuration></plugin></plugins></build>
</project>

现在，让我们添加实现应用程序所需的依赖项：

<project>...<dependencies><dependency><groupId>javax.servlet</groupId><artifactId>servlet-api</artifactId><version>2.4</version><scope>provided</scope></dependency><dependency><groupId>javax.servlet.jsp</groupId><artifactId>jsp-api</artifactId><version>2.0</version><scope>provided</scope></dependency><dependency><groupId>javax.el</groupId><artifactId>el-api</artifactId><version>1.0</version></dependency><dependency><groupId>javax.faces</groupId><artifactId>jsf-api</artifactId><version>1.2_14</version></dependency><dependency><groupId>javax.faces</groupId><artifactId>jsf-impl</artifactId><version>1.2_14</version></dependency><dependency><groupId>com.sun.facelets</groupId><artifactId>jsf-facelets</artifactId><version>1.1.1</version></dependency><dependency><groupId>net.sf.jasperreports</groupId><artifactId>jasperreports</artifactId><version>4.5.1</version></dependency><dependency><groupId>net.sf.jasperreports.jsf</groupId><artifactId>jasperreports-jsf</artifactId><version>1.0</version></dependency><dependency><groupId>org.apache.derby</groupId><artifactId>derbyclient</artifactId><version>10.8.2.2</version></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.8.1</version><scope>test</scope></dependency></dependencies>
</project>

在此项目中，我们将使用可通过JNDI访问的容器管理数据源。这种配置取决于我们使用的应用程序服务器的类型。由于我将Tomcat用作应用程序服务器，因此需要在项目中的src / main / webapp / META-INF文件夹下添加一个context.xml文件，以告诉它如何访问该数据库以及资源的类型。我想要：

<Context path='/jrjsf-usecases' reloadable='true'><Resource name='jdbc/BookStoreDB' auth='Container' type='javax.sql.DataSource'maxActive='100' maxIdle='30' maxWait='10000'username='app' password='' driverClassName='org.apache.derby.jdbc.ClientDriver'url='jdbc:derby://localhost:1527/bookstoredb;create=true'/></Context>

配置iReport

我们需要配置iReport使其能够连接到数据库，因此让我们启动iReport设计工具并对其进行配置以使其可以进行设计工作。 iReport的不带至Apache Derby数据库的支持外的开箱 ，我们需要将库添加到其类路径和手工配置Derby JDBC驱动程序。该练习将教我们如何配置工具以支持其他任何数据库。

首先，从Apache Derby数据库的网站下载Apache Derby数据库，并将其安装（解压缩zip文件）到本地计算机中您选择的文件夹中（如果尚未执行的话）。然后打开iReport的首选项/选项窗口，然后选择类路径选项卡：

我将把Derby的lib文件夹添加到iReport类路径中。为此，请单击“添加文件夹”按钮并浏览文件系统，直到获得Apache Derby安装中的lib文件夹：

完成后，在首选项窗口中单击“确定”按钮，现在iReport中应该可以使用Apache Derby客户端类。现在，我们准备在iReport中配置Apache Derby数据源，该数据源将由我们的报告使用。要添加新的数据源，我们可以从iReport欢迎页面开始，然后单击“ 步骤1 ：创建数据库连接...”按钮，或者单击工具栏上的“报告数据源”按钮，然后单击“添加”。按钮。无论哪种方式，我们都将到达如下所示的窗口：

需要在iReport中手动配置Apache Derby数据源，因此在上一个窗口的列表中选择“数据库JDBC连接”，单击“下一步>”，然后在下一个窗口中填写JDBC驱动程序的值：

字段的值如下：

名称： BookStoreDB
JDBC驱动程序 ： org.apache.derby.jdbc.ClientDriver
JDBC URL ： jdbc：derby：// localhost：1527 / bookstoredb
用户名 ： app
密码： <空>

现在，在继续之前，请确保您的Apache Derby实例正在运行以允许与其建立连接，然后单击“测试”按钮以检查一切是否正常。

领域模型

假设我们已经配置了项目并准备好开始工作（我们有一个基本的项目文件夹结构，所有基本依赖项都在我们的类路径中，并且iReport能够连接到我们的数据库），所以让我们从码。我在这方面的第一步将是创建一个SQL文件（ bookstore.create.sql ），以初始化我在本系列的Introduction部分中所讨论的域模型。复制此段下面的文本并将其粘贴到项目文件夹结构内的文件中，以便以后使用：

create table book (book_id int generated by default as identity primary key,title varchar(50) not null,author varchar(50) not null,published_year varchar(4) not null,genre varchar(20) not null,price numeric not null
);create table customer (customer_id int generated by default as identity primary key,name varchar(250) not null
);create table purchase_order (order_id int generated by default as identity primary key,customer_id int not null,created_date date not null,constraint customer_fk foreign key (customer_id) references customer(customer_id)
);create table purchase_order_line (order_line_id int generated by default as identity primary key,order_id int not null,book_id int not null,item_count int not null,constraint order_fk foreign key (order_id) references purchase_order(order_id),constraint book_fk foreign key (book_id) references book(book_id)
);

这只是我的域模型的后端部分，在我的应用程序中，我还需要将那些实体表示为Java类。因此，要使此域模型完整，下一步是编写Java类，该类需要表示Java应用程序中先前定义的域模型。现在该看看以前的模型了，我们有4个不同的实体，因此我们将需要在Java应用程序中使用4个不同的类来遵守该模型：

书

public class Book {private Long id;private String title;private String author;private String publishedYear;private String genre;private double price;public String getAuthor() {return author;}public void setAuthor(String author) {this.author = author;}public String getGenre() {return genre;}public void setGenre(String genre) {this.genre = genre;}public Long getId() {return id;}public void setId(Long id) {this.id = id;}public double getPrice() {return price;}public void setPrice(double price) {this.price = price;}public String getPublishedYear() {return publishedYear;}public void setPublishedYear(String publishedYear) {this.publishedYear = publishedYear;}public String getTitle() {return title;}public void setTitle(String title) {this.title = title;}}

顾客

public class Customer {private Long id;private String name;public Long getId() {return id;}public void setId(Long id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}}

订购

public class Order {private Long id;private Customer customer;private Date createdDate;private List lines = new ArrayList();public Date getCreatedDate() {return createdDate;}public void setCreatedDate(Date createdDate) {this.createdDate = createdDate;}public Customer getCustomer() {return customer;}public void setCustomer(Customer customer) {this.customer = customer;}public Long getId() {return id;}public void setId(Long id) {this.id = id;}public List getLines() {return lines;}public void setLines(List lines) {this.lines = lines;}}

订单行

public class OrderLine {private Long id;private Order order;private Book book;private int itemCount;public Book getBook() {return book;}public void setBook(Book book) {this.book = book;}public Long getId() {return id;}public void setId(Long id) {this.id = id;}public int getItemCount() {return itemCount;}public void setItemCount(int itemCount) {this.itemCount = itemCount;}public Order getOrder() {return order;}public void setOrder(Order order) {this.order = order;}}

现在，使用您选择的工具连接到数据库，并执行bookstoredb.create.sql文件创建表结构。

结论

我试图使代码尽可能简单和干净。上一节中列出的Java类可以使用ORM工具（例如Hibernate ， iBATIS ， Ebean等）映射到我们的关系数据库。我将对象关系映射层的选择留给读者，因为有很多选择，但是没有一个选择将影响我们将报告与Web框架集成的方式。

我们的Web应用程序应包含其他类，以将其体系结构构成为DAO和业务外观以及视图控制器。但是，出于与我没有添加任何可能有助于将模型类链接到数据库表的ORM信息相同的原因，在本文中添加所有它们完全超出了范围。如今有很多IoC容器（ Spring框架， Weld ， Seam等），本系列中真正重要的是演示JasperReports JSF插件的用法。（由于它们是每个特定用例的一部分，因此将在其特定的文章中列出视图控制器）。

这就是我们开始在这个漂亮工具的不同示例中所做的全部。在接下来的几周中，新文章将在JasperReports JSF插件类别下发布，并提供详细的示例来演示如何实现最常见的用例。希望您喜欢它们，欢迎任何评论。

参考：来自Code Nibbles博客的JCG合作伙伴 Alonso Dominguez的JasperReports JSF插件用例系列。