AbstractJExcelViewを介したSpring MVCとExcelファイル

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

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

1. JExcelAPI

JExcelAPI libraryを取得します。

    
    
    net.sourceforge.jexcelapi
    jxl
    2.6.3

2. コントローラ

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

ファイル：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. AbstractJExcelView

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

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

ファイル：ExcelRevenueReportView.java

package com.example.common.view;

import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import jxl.write.Label;
import jxl.write.WritableSheet;
import jxl.write.WritableWorkbook;
import org.springframework.web.servlet.view.document.AbstractJExcelView;

public class ExcelRevenueReportView extends AbstractJExcelView{

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

       Map revenueData = (Map) model.get("revenueData");
       WritableSheet sheet = workbook.createSheet("Revenue Report", 0);

           sheet.addCell(new Label(0, 0, "Month"));
           sheet.addCell(new Label(1, 0, "Revenue"));

           int rowNum = 1;
       for (Map.Entry entry : revenueData.entrySet()) {
        //create the row data
        sheet.addCell(new Label(0, rowNum, entry.getKey()));
            sheet.addCell(new Label(1, rowNum, entry.getValue()));
            rowNum++;
           }
       }
}

Note
または、Apache POI APIを使用して同じExcelビューを作成するAbstractExcelViewを使用することもできます。このAbstractExcelView 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-AbstractJExcelView-Example.zip（9KB）

TOC