Spring學習手冊 2：Spring MVC 匯出excel表格

EatherToo發表於2019-02-10
SpringMVCExcel

目錄

完整程式碼在這

Spring 匯出excel表格有很多種方法，可以直接用設定檔案頭的方法，也可以使用ContentNegotiatingViewResolver 直接將excel檔案直接解析成view。

一、配置檔案要加上哪些東西？

首先，如果採用設定響應頭的方式來匯出excel檔案，並不需要配置得很複雜，只要加上一個excel的處理庫和Java-servlet庫就可以。在這裡，我使用了apache-poi庫。

完整pom配置檔案

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.learn.springmvc</groupId>
  <artifactId>SpringMVCExportFile</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>SpringMVCExportFile Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.7</maven.compiler.source>
    <maven.compiler.target>1.7</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>4.3.11.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>4.3.11.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>4.3.11.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</artifactId>
      <version>4.3.11.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>4.3.11.RELEASE</version>
    </dependency>

    <!--Excel 依賴包-->
    <dependency>
      <groupId>org.apache.poi</groupId>
      <artifactId>poi</artifactId>
      <version>3.10-beta2</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>servlet-api</artifactId>
      <version>3.0-alpha-1</version>
    </dependency>
  </dependencies>


  <build>
    <finalName>SpringMVCExportFile</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>
複製程式碼

二、依據poi包的用法建立一個用來匯出excel檔案的工具類：

package com.learn.com.learn.tool;

import org.apache.poi.hssf.usermodel.*;

import javax.servlet.ServletOutputStream;

public class ExcelExport {
    public void export(String titles[], String datas[][], ServletOutputStream out) throws Exception{
        try{
            // 第一步，建立一個workbook，對應一個Excel檔案
            HSSFWorkbook workbook = new HSSFWorkbook();

            // 第二步，在webbook中新增一個sheet,對應Excel檔案中的sheet
            HSSFSheet hssfSheet = workbook.createSheet("sheet1");

            // 第三步，在sheet中新增表頭第0行,注意老版本poi對Excel的行數列數有限制short

            HSSFRow row = hssfSheet.createRow(0);
            // 第四步，建立單元格，並設定值表頭 設定表頭居中
            HSSFCellStyle hssfCellStyle = workbook.createCellStyle();

            //居中樣式
            hssfCellStyle.setAlignment(HSSFCellStyle.ALIGN_CENTER);

            HSSFCell hssfCell = null;
            for (int i = 0; i < titles.length; i++) {
                hssfCell = row.createCell(i);//列索引從0開始
                hssfCell.setCellValue(titles[i]);//列名1
                hssfCell.setCellStyle(hssfCellStyle);//列居中顯示
            }

            int lens = datas.length;
            for (int i = 1; i <= lens; i++) {
                HSSFRow hssfRow = hssfSheet.createRow(i);
                // 第四步，建立單元格，並設定值表頭 設定表頭居中
                HSSFCellStyle style = workbook.createCellStyle();

                //居中樣式
                style.setAlignment(HSSFCellStyle.ALIGN_CENTER);

                HSSFCell cell = null;
                int len = datas[i-1].length;
                for (int j = 0; j < len; j++) {
                    cell = hssfRow.createCell(j);
                    cell.setCellValue(datas[i-1][j]);
                    cell.setCellStyle((hssfCellStyle));
                }
            }


            // 第七步，將檔案輸出到客戶端瀏覽器
            try {
                workbook.write(out);
                out.flush();
                out.close();

            } catch (Exception e) {
                e.printStackTrace();
            }


        }catch(Exception e){
            e.printStackTrace();
            throw new Exception("匯出資訊失敗！");

        }
    }
}
複製程式碼

在這個類中有一個匯出excel檔案的方法，這個方法接受三個引數。

第一個引數是表格的標題，是一個字串型別的一維陣列

第二個引數是表格的資料，儲存了表格中的所有資料

第三個引數是servlet的輸出流，用來輸出檔案到瀏覽器

具體的poi庫的用法可以參考這裡

三、建立excel輸出控制器

建立一個名為ExcelController的類， 類中建立一個方法叫excel，接受HttpServletResponse型別的引數。

修改 @RequestMapping註解為：

@RequestMapping(value = "excel", produces = "application/binary;charset=UTF-8")
複製程式碼

指明返回給瀏覽器的資料型別為二進位制檔案。

新增上 @ResponseBody註解

完整程式碼為：

package com.learn.controller;

import com.learn.com.learn.tool.ExcelExport;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;

@Controller
public class ExcelController{
    private ExcelExport excelExport = new ExcelExport();

    /**
     * 
     * @param response
     * @return
     */
    @RequestMapping(value = "excel", produces = "application/binary;charset=UTF-8")
    @ResponseBody
    public String excel(HttpServletResponse response) {
        try{
            ServletOutputStream out=response.getOutputStream();
            try {
                //設定檔案頭：最後一個引數是設定下載檔名
                response.setHeader("Content-Disposition", "attachment;fileName=" + URLEncoder.encode(1+".xls", "UTF-8"));
            } catch (UnsupportedEncodingException e1) {
                e1.printStackTrace();
            }

            String[] titles = { "使用者id", "使用者姓名", "使用者密碼", "使用者年齡" };
            String[][] datas = {{"1", "2"}, {"3", "4"}};
            //呼叫匯出excel檔案方法
            excelExport.export(titles,datas, out);
            return "success";
        } catch(Exception e){
            e.printStackTrace();
            return "匯出資訊失敗";
        }

    }

}
複製程式碼

執行效果為：

Spring學習手冊 2：Spring MVC 匯出excel表格

相關文章