快捷導(dǎo)航

在SpringBoot框架下實(shí)現(xiàn)Excel導(dǎo)入導(dǎo)出的方法詳解

更新時(shí)間：2023年06月18日 09:43:41 作者：葡萄城技術(shù)團(tuán)隊(duì)

SpringBoot是由Pivotal團(tuán)隊(duì)提供的全新框架，其設(shè)計(jì)目的是用來(lái)簡(jiǎn)化新Spring應(yīng)用的初始搭建以及開(kāi)發(fā)過(guò)程，今天我們就使用純前對(duì)按表格控件帶大家了解，如何在Spring Boot框架下實(shí)現(xiàn)Excel服務(wù)端導(dǎo)入導(dǎo)出,需要的朋友可以參考下

1.IDEA創(chuàng)建SpringBoot項(xiàng)目

1.1 Spring Initializr

想要在IDEA下快速搭建一個(gè)SpringBoot項(xiàng)目，可以使用Spring Initializr工具作為腳手架。

進(jìn)入IDEA后，在左側(cè)菜單中可以找到Plugins，點(diǎn)擊后，在上方的搜索框中輸入Spring Initializr。

之后點(diǎn)擊右上角的綠色I(xiàn)nstall按鈕進(jìn)行安裝。

安裝完畢后，在New Project 的時(shí)候就會(huì)多一個(gè)Spring Initializr的選項(xiàng)。

1.2 SpringBoot 項(xiàng)目的創(chuàng)建

Project SDK：根據(jù)實(shí)際應(yīng)用情況選擇用于配置項(xiàng)目所依賴的Java SDK。

Choose Spring Initializr Server：選擇一個(gè)Spring Initializr服務(wù)器，一般來(lái)說(shuō)都選擇默認(rèn)的。

GroupId：一般分為多個(gè)段，第一段為域，第二段為公司名稱。例如：org.apache，com.grapecity。

ArtifactId：是項(xiàng)目的唯一標(biāo)識(shí)符，在實(shí)際開(kāi)發(fā)中一般對(duì)應(yīng)項(xiàng)目的名稱，就是項(xiàng)目根目錄的名稱。

Group Id，Artfact Id是保證項(xiàng)目唯一性的標(biāo)識(shí)，一般來(lái)說(shuō)如果項(xiàng)目打包上傳至maven這樣的包管理倉(cāng)庫(kù)中。在搜索你的項(xiàng)目時(shí)，Group Id，Artfact Id是必要的條件。

Version：版本號(hào)，默認(rèn)0.0.1-SNAPSHOT。SNAPSHOT代表不穩(wěn)定的版本，與之相對(duì)的有RELEASE。

Project type：工程的類型，maven工程還是gradle工程。

Language：語(yǔ)言（Java，Kotlin，Groovy）。

Packaging：Jar包還是War包。

Java version：語(yǔ)法版本，與Project SDK不同，Project SDK是實(shí)際用到的JDK。Java version指的是語(yǔ)法版本。一般來(lái)說(shuō)語(yǔ)言特性不能比SDK高。比如SDK版本是11，語(yǔ)法選擇8。那么實(shí)際項(xiàng)目中只能使用java 8的語(yǔ)法。反之SDK版本是8，語(yǔ)法選11就有問(wèn)題了。一般情況下都會(huì)與SDK保持一致。

Project name：項(xiàng)目名稱

Project description：項(xiàng)目描述

Package name：包名

第三部分根據(jù)項(xiàng)目的實(shí)際需求去配置。

第四部分：

設(shè)置項(xiàng)目名稱與路徑。

2.前端配置

考慮到導(dǎo)入導(dǎo)出功能需要對(duì)Excel具有較高的還原度，這里使用了SpreadJS組件，通過(guò)SpreadJS組件的ExcelIO功能，進(jìn)行Excel的導(dǎo)入與導(dǎo)出。SpreadJS是一款純前端的組件，與后端完全解耦，可以完美的整合到SpringBoot工程中。

2.1 前端頁(yè)面創(chuàng)建

在static目錄下建立index.html文件，用來(lái)繪制前端頁(yè)面。如果用了thymeleaf也可以將文件建立在templates目錄中。

2.2 SpreadJS組件引入和初始化

在header中引入SpreadJS相關(guān)的css與js引用。

創(chuàng)建SpreadJS對(duì)應(yīng)的DOM對(duì)象。

在JS中初始化SpreadJS和導(dǎo)入導(dǎo)出Excel相關(guān)的ExcelIO對(duì)象。

通過(guò)按鈕點(diǎn)擊進(jìn)行服務(wù)端導(dǎo)入與導(dǎo)出。

導(dǎo)入導(dǎo)出事件處理，在事件中發(fā)送請(qǐng)求與服務(wù)端進(jìn)行連接。

導(dǎo)入原理：

將服務(wù)端的文件以文件流的形式傳輸至前端，前端通過(guò)ExcelIO將結(jié)果導(dǎo)入結(jié)果呈現(xiàn)值SpreadJS中，所以導(dǎo)入的傳遞的參數(shù)是一個(gè)文件路徑。注意該路徑是文件在服務(wù)端或者工程中的一個(gè)路徑。

導(dǎo)出原理:

通過(guò)SpreadJS ExcelIO的功能將內(nèi)容導(dǎo)出成Excel的blob流。之后將blob流傳至服務(wù)器端，在服務(wù)器端進(jìn)行保存Excel文件的操作。

3.后端配置

創(chuàng)建后端controller，可按照自身項(xiàng)目的包的層級(jí)分類進(jìn)行創(chuàng)建。

構(gòu)建服務(wù)端的導(dǎo)入導(dǎo)出方法和相關(guān)邏輯。

服務(wù)器端導(dǎo)入：

由于前端傳入的是一個(gè)文件的路徑，所以參數(shù)這里我們需要一個(gè)字符串類型的參數(shù)去接收。

另外，我們會(huì)將流傳到前端，所以會(huì)將流寫(xiě)到response中，所以參數(shù)中還需要response對(duì)象，方法本身不需要返回，返回空即可。原理是通過(guò)inputStream讀取文件后，將其寫(xiě)入response的outputStream中。

導(dǎo)出到服務(wù)器：

由于前端傳入傳入的是保存文件的名稱以及文件blob文件流。服務(wù)器端需要兩個(gè)參數(shù)，String用來(lái)接收文件名稱，MultipartFile對(duì)象用來(lái)接收blob文件流。后端接受到文件流之后通過(guò)transferTo方法在指定目錄下根軍傳來(lái)的fileName轉(zhuǎn)存成新的文件。