AbstractExcelViewを使用したSpring MVCおよびExcelファイル

AbstractExcelViewを介したSpring MVCおよびExcelファイル

Spring MVCには、Apache POIライブラリを介してデータをExcelファイルにエクスポートするためのAbstractExcelViewクラスが付属しています。このチュートリアルでは、Spring MVCアプリケーションでAbstractExcelViewクラスを使用して、ダウンロード用にデータをExcelファイルにエクスポートする方法を示します。

1. アパッチPOI

Apache POI libraryを取得して、Excelファイルを作成します。

   
   
    org.apache.poi
    poi
    3.6

2. コントローラ

コントローラークラス、デモ用のダミーデータを生成し、要求パラメーターを取得して、返すビューを決定します。リクエストパラメータが「EXCEL」と等しい場合は、Excelビュー（AbstractExcelView）を返します。

ファイル：RevenueReportController.java

package com.example.common.controller;

import java.util.HashMap;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.bind.ServletRequestUtils;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.AbstractController;

public class RevenueReportController extends AbstractController{

    @Override
    protected ModelAndView handleRequestInternal(HttpServletRequest request,
        HttpServletResponse response) throws Exception {

        String output =
            ServletRequestUtils.getStringParameter(request, "output");

        //dummy data
        Map revenueData = new HashMap();
        revenueData.put("Jan-2010", "$100,000,000");
        revenueData.put("Feb-2010", "$110,000,000");
        revenueData.put("Mar-2010", "$130,000,000");
        revenueData.put("Apr-2010", "$140,000,000");
        revenueData.put("May-2010", "$200,000,000");

        if(output ==null || "".equals(output)){
            //return normal view
            return new ModelAndView("RevenueSummary","revenueData",revenueData);

        }else if("EXCEL".equals(output.toUpperCase())){
            //return excel view
            return new ModelAndView("ExcelRevenueSummary","revenueData",revenueData);

        }else{
            //return normal view
            return new ModelAndView("RevenueSummary","revenueData",revenueData);

        }
    }
}

3. AbstractExcelView

AbstractExcelViewクラスを拡張してExcelビューを作成し、buildExcelDocument()メソッドをオーバーライドしてデータをExcelファイルに入力します。 AbstractExcelViewは、Apache POIAPIを使用してExcelファイルの詳細を作成しています。

Note
Apache POIの使用方法の詳細については、Apache POI documentationを参照してください。

ファイル：ExcelRevenueReportView.java

package com.example.common.view;

import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.springframework.web.servlet.view.document.AbstractExcelView;

public class ExcelRevenueReportView extends AbstractExcelView{

    @Override
    protected void buildExcelDocument(Map model, HSSFWorkbook workbook,
        HttpServletRequest request, HttpServletResponse response)
        throws Exception {

        Map revenueData = (Map) model.get("revenueData");
        //create a wordsheet
        HSSFSheet sheet = workbook.createSheet("Revenue Report");

        HSSFRow header = sheet.createRow(0);
        header.createCell(0).setCellValue("Month");
        header.createCell(1).setCellValue("Revenue");

        int rowNum = 1;
        for (Map.Entry entry : revenueData.entrySet()) {
            //create the row data
            HSSFRow row = sheet.createRow(rowNum++);
            row.createCell(0).setCellValue(entry.getKey());
            row.createCell(1).setCellValue(entry.getValue());
                }
    }
}

Note
または、JExcelAPIを使用して同じExcelビューを作成するAbstractJExcelViewを使用することもできます。このAbstractJExcelView exampleを参照してください。

4. スプリング構成

ExcelビューのXmlViewResolverを作成します。



  

    

    
        
            /WEB-INF/spring-excel-views.xml

ファイル：spring-excel-views.xml

5. Demo

URL：http://localhost:8080/SpringMVC/revenuereport.htm?output=excel

ユーザーがダウンロードするためのExcelファイルを生成します。

SpringMVC-ExcelFile-Example

ソースコードをダウンロード

ダウンロード–SpringMVC-ExcelFile-AbstractExcelView-Example.zip（9KB）

TOC