SpringMVC与iReport(JasperReports) 整合开发实例教程

前言

在本教程中，我们将学习如何在一个简单的spring MVC Web应用中集成Jasper报表工具。教程涵盖的技术点有：报表自定义数据源的使用；报表渲染、呈现的配置与实现；iReport报表设计器的使用（报表模板设计）等。

开发环境准备

以下两种方式任选其一：

1. 在已有的SpringMVC项目环境中进行配置（要求项目可正常运行、调试）；

2. 在eclipse中安装Spring的STS工具，然后新建一个Spring MVC Project（要求已配置好Maven环境）；

项目依赖包

添加必须的jasperreports包依赖：

[html]  view plain  copy

 

1. <!-- iReport JasperReports -->  
2. <dependency>  
3.     <groupId>net.sf.jasperreports</groupId>  
4.     <artifactId>jasperreports</artifactId>  
5.     <version>5.6.0</version>  
6. </dependency>  
7. <dependency>  
8.     <groupId>org.codehaus.groovy</groupId>  
9.     <artifactId>groovy-all</artifactId>  
10.     <version>2.2.2</version>  
11. </dependency>  

SpringMvc JasperReport整合

1、继承JasperReportsMultiFormatView类，并重写fillReport()方法，在该方法中增加setUrl()实现，这样就可以在controller中指定要使用的报表模板文件了。这样做的好处是，只需要一个jasperReport配置文件，可以在controller中动态的设定报表模板url。

[java]  view plain  copy

 

1. package com.pes_soft.example;  
2.   
3. import java.util.Map;  
4.   
5. import net.sf.jasperreports.engine.JasperPrint;  
6. import net.sf.jasperreports.engine.JasperReport;  
7.   
8. import org.springframework.web.servlet.view.jasperreports.JasperReportsMultiFormatView;  
9.   
10. /** 
11.  * SpringMVC + IReport整合 视图处理扩展 
12.  * @Author 许亮 
13.  * @Create 2015-11-7 21:38:18 
14.  */  
15. public class ApplicationIReportView extends JasperReportsMultiFormatView {  
16.     private JasperReport jasperReport;  
17.       
18.     public ApplicationIReportView() {  
19.         super();  
20.     }  
21.   
22.     protected JasperPrint fillReport(Map<String, Object> model) throws Exception {  
23.         if (model.containsKey("url")) {  
24.             setUrl(String.valueOf(model.get("url")));  
25.             this.jasperReport = loadReport();  
26.         }  
27.           
28.         return super.fillReport(model);  
29.     }  
30.       
31.     protected JasperReport getReport() {  
32.         return this.jasperReport;  
33.     }  
34. }  

2、在/WEB-INF/jasper/目录下创建报表视图配置文件jasper-defs.xml，并指定解析器类为自定义的视图解析器类：

[html]  view plain  copy

 

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans"  
3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    
4.     xsi:schemaLocation="  
5.         http://www.springframework.org/schema/beans   
6.         http://www.springframework.org/schema/beans/spring-beans-3.1.xsd">  
7.   
8.     <bean id="iReportView" class="com.pes_soft.example.ApplicationIReportView">  
9.         <!-- <property name="url" value="/WEB-INF/jasper/report2.jasper"/> -->  
10.         <property name="reportDataKey" value="jrMainDataSource"/>  
11.     </bean>  
12. </beans>  

3、Jasper报表的渲染需要用到XmlViewResolver视图解析器，这样你的项目中就会存在多个视图解析器。需要注意的是，项目中如果使用了多个视图解析器，则需要设置order的值来区分解析器的使用顺序，order值越小则越靠前。增加XmlViewResolver视图解析器的同时，并指定其要解析的配置文件路径。

那么，需要在/WEB-INF/spring/appServlet/servlet-context.xml中增加下述配置：

[html]  view plain  copy

 

1. <!-- 注册XmlViewResolver，用于iReport & JasperReports报表生成 -->  
2. <beans:bean id="jasperReportResolver" class="org.springframework.web.servlet.view.XmlViewResolver">  
3.     <beans:property name="order">  
4.         <beans:value>0</beans:value>  
5.     </beans:property>  
6.     <beans:property name="location">  
7.         <beans:value>WEB-INF/jasper/jasper-defs.xml</beans:value>  
8.     </beans:property>  
9. </beans:bean>  

测试准备

1、创建JavaBeanPerson实体类：

[java]  view plain  copy

 

1. package com.pes_soft.example.model;  
2.   
3. import java.util.ArrayList;  
4. import java.util.List;  
5.   
6. /** 
7.  * iReport测试bean: Person实体类 
8.  * @author 许亮 
9.  * @Create 2015-1-15 20:32:27 
10.  */  
11. public class JavaBeanPerson {  
12.     private String name;    // 姓名  
13.     private String sex;        // 性别  
14.     private int age;        // 年龄  
15.     private String hometown;// 籍贯  
16.     private String phone;    // 电话号码  
17.       
18.     public JavaBeanPerson() {}  
19.       
20.     public JavaBeanPerson(String name, String sex, int age, String hometown, String phone) {  
21.         this.name = name;  
22.         this.sex = sex;  
23.         this.age = age;  
24.         this.hometown = hometown;  
25.         this.phone = phone;  
26.     }  
27.       
28.     // 此处省略字段的getter和setter  
29.       
30.     public static List<JavaBeanPerson> getList() {  
31.         List<JavaBeanPerson> list = new ArrayList<JavaBeanPerson>();  
32.         list.add(new JavaBeanPerson("Lily", "female", 22, "Hubei", "10086"));  
33.         list.add(new JavaBeanPerson("Macro", "male", 33, "Beijing", "13800000000"));  
34.         list.add(new JavaBeanPerson("Andy", "male", 44, "HongKong", "13812345678"));  
35.         list.add(new JavaBeanPerson("Linder", "female", 28, "Guangxi", "18677778888"));  
36.         list.add(new JavaBeanPerson("Jessie", "female", 26, "Gansu", "18219177720"));  
37.         return list;  
38.     }  
39. }  

2、使用iReport设计报表模板，并编成.jasper二进制文件，并拷贝至\WEB-INF\jasper目录下：

3、编写Controller方法

[java]  view plain  copy

 

1. /** 
2.  * 返回iReport报表视图 
3.  * @param model 
4.  * @return 
5.  */  
6. @RequestMapping(value = "/report", method = RequestMethod.GET)  
7. public String report(Model model) {  
8.     // 报表数据源  
9.     JRDataSource jrDataSource = new JRBeanCollectionDataSource(JavaBeanPerson.getList());  
10.           
11.     // 动态指定报表模板url  
12.     model.addAttribute("url", "/WEB-INF/jasper/MvcIReportExample.jasper");  
13.     model.addAttribute("format", "pdf"); // 报表格式  
14.     model.addAttribute("jrMainDataSource", jrDataSource);  
15.           
16.     return "iReportView"; // 对应jasper-defs.xml中的bean id  
17. }  

运行结果

Demo源码下载

mvc-ireport.rar (v2)

spring_ireport.rar