SpringMVC與iReport(JasperReports) 5.6整合開發實例

前言

在本教程中，我們將學習如何在一個簡單的Spring MVC Web應用中集成Jasper報表工具。教程涵蓋的技術點有：報表自定義數據源的使用；報表渲染、呈現的配置與實現；iReport報表設計器的使用（報表模板設計）等。

開發環境準備

以下兩種方式任選其一：

1. 在已有的SpringMVC項目環境中進行配置（要求項目可正常運行、調試）；

2. 在eclipse中安裝Spring的STS工具，然後新建一個Spring MVC Project（要求已配置好Maven環境）；

項目依賴包

添加必須的jasperreports包依賴：

<!-- iReport JasperReports -->
<dependency>
    <groupId>net.sf.jasperreports</groupId>
    <artifactId>jasperreports</artifactId>
    <version>5.6.0</version>
</dependency>
<dependency>
    <groupId>org.codehaus.groovy</groupId>
    <artifactId>groovy-all</artifactId>
    <version>2.2.2</version>
</dependency>

SpringMvc JasperReport整合

1、繼承JasperReportsMultiFormatView類，並重寫fillReport()方法，在該方法中增加setUrl()實現，這樣就可以在controller中指定要使用的報表模板文件了。這樣做的好處是，只需要一個jasperReport配置文件，可以在controller中動態的設定報表模板url。

package com.sample.sping_ireport;

import java.util.Map;

import net.sf.jasperreports.engine.JasperPrint;
import net.sf.jasperreports.engine.JasperReport;

import org.springframework.web.servlet.view.jasperreports.JasperReportsMultiFormatView;

public class CustomReportView extends JasperReportsMultiFormatView {
    private JasperReport report;

    public CustomReportView() {
        super();
    }

    protected JasperPrint fillReport(Map<String, Object> model) throws Exception {
        if (model.containsKey("url")) {
            setUrl(String.valueOf(model.get("url")));
            this.report = loadReport();
        }

        return super.fillReport(model);
    }

    protected JasperReport getReport() {
        return this.report;
    }
}

2、在WEB-INF目錄下創建報表視圖配置文件jasper-views.xml，並指定解析器類爲自定義的視圖解析器類：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-3.2.xsd">

    <bean id="reportView" class="com.sample.sping_ireport.CustomReportView">
        <!-- <property name="url" value="/WEB-INF/jasper/report2.jasper"/> -->
        <property name="reportDataKey" value="jrMainDataSource"/>
    </bean>
</beans>

3、Jasper報表的渲染需要用到XmlViewResolver視圖解析器，這樣你的項目中就會存在多個視圖解析器。需要注意的是，項目中如果使用了多個視圖解析器，則需要設置order的值來區分解析器的使用順序，order值越小則越靠前。增加XmlViewResolver視圖解析器的同時，並指定其要解析的配置文件路徑。

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

<!-- 註冊XmlViewResolver，用於iReport & JasperReports報表生成 -->
<beans:bean id="jasperReportResolver" class="org.springframework.web.servlet.view.XmlViewResolver">
    <beans:property name="order">
        <beans:value>0</beans:value>
    </beans:property>
    <beans:property name="location">
        <beans:value>WEB-INF/jasper-views.xml</beans:value>
    </beans:property>
</beans:bean>

測試準備

1、創建JavaBeanPerson實體類：

package com.sample.sping_ireport.model;

import java.util.ArrayList;
import java.util.List;

/**
 * iReport測試bean: Person實體類
 * @author 許亮
 * @Create 2015-2-2 17:03:44
 */
public class JavaBeanPerson {
    private String name;    // 姓名
    private String sex;     // 性別
    private int age;        // 年齡
    private String hometown;// 籍貫
    private String phone;   // 電話號碼

    public JavaBeanPerson() {}

    public JavaBeanPerson(String name, String sex, int age, String hometown, String phone) {
        this.name = name;
        this.sex = sex;
        this.age = age;
        this.hometown = hometown;
        this.phone = phone;
    }

    /**
     * 姓名
     * @return
     */
    public String getName() {
        return name;
    }

    /**
     * 姓名
     * @param name
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * 性別
     * @return
     */
    public String getSex() {
        return sex;
    }

    /**
     * 性別
     * @param sex
     */
    public void setSex(String sex) {
        this.sex = sex;
    }

    /**
     * 年齡
     * @return
     */
    public int getAge() {
        return age;
    }

    /**
     * 年齡
     * @param age
     */
    public void setAge(int age) {
        this.age = age;
    }

    /**
     * 籍貫
     * @return
     */
    public String getHometown() {
        return hometown;
    }

    /**
     * 籍貫
     * @param hometown
     */
    public void setHometown(String hometown) {
        this.hometown = hometown;
    }

    /**
     * 電話號碼
     * @return
     */
    public String getPhone() {
        return phone;
    }

    /**
     * 電話號碼
     * @param phone
     */
    public void setPhone(String phone) {
        this.phone = phone;
    }

    public static List<JavaBeanPerson> getList() {
        List<JavaBeanPerson> list = new ArrayList<JavaBeanPerson>();
        list.add(new JavaBeanPerson("Lily", "female", 22, "Hubei", "10086"));
        list.add(new JavaBeanPerson("Macro", "male", 33, "Beijing", "13800000000"));
        list.add(new JavaBeanPerson("Andy", "male", 44, "HongKong", "13812345678"));
        list.add(new JavaBeanPerson("Linder", "female", 28, "Guangxi", "18677778888"));
        list.add(new JavaBeanPerson("Jessie", "female", 26, "Gansu", "18219177720"));
        return list;
    }
}

2、使用iReport設計報表模板，並編成.jasper二進制文件，並拷貝至\WEB-INF\jasper目錄下：

3、編寫Controller方法

@RequestMapping(value = "/report", method = RequestMethod.GET)
public String report(Model model) {
    // 報表數據源
    JRDataSource jrDataSource = new JRBeanCollectionDataSource(JavaBeanPerson.getList());

    // 動態指定報表模板url
    model.addAttribute("url", "/WEB-INF/jasper/spring_report.jasper");
    model.addAttribute("format", "pdf"); // 報表格式
    model.addAttribute("jrMainDataSource", jrDataSource);

    return "reportView"; // 對應jasper-views.xml中的bean id
}

運行結果

Demo源碼下載

spring_ireport.rar