Spring Boot框架下實現Excel服務端導入導出
Spring Boot是由Pivotal團隊提供的全新框架,其設計目的是用來簡化新Spring應用的初始搭建以及開發過程。該框架使用了特定的方式來進行配置,從而使開發人員不再需要定義樣板化的配置。今天我們就使用純前對按表格控制項帶大家了解,如何在Spring Boot框架下實現Excel服務端導入導出。
1.IDEA創建SpringBoot項目
1.1 Spring Initializr
想要在IDEA下快速搭建一個SpringBoot項目,可以使用Spring Initializr工具作為腳手架。
進入IDEA後,在左側菜單中可以找到Plugins,點擊後,在上方的搜索框中輸入Spring Initializr。
之後點擊右上角的綠色Install按鈕進行安裝。
安裝完畢後,在New Project 的時候就會多一個Spring Initializr的選項。
1.2 SpringBoot 項目的創建
Project SDK:根據實際應用情況選擇用於配置項目所依賴的Java SDK。
Choose Spring Initializr Server:選擇一個Spring Initializr伺服器,一般來說都選擇默認的。
GroupId:一般分為多個段,第一段為域,第二段為公司名稱。例如:org.apache,com.grapecity。
ArtifactId:是項目的唯一標識符,在實際開發中一般對應項目的名稱,就是項目根目錄的名稱。
Group Id,Artfact Id是保證項目唯一性的標識,一般來說如果項目打包上傳至maven這樣的包管理倉庫中。在搜索你的項目時,Group Id,Artfact Id是必要的條件。
Version:版本號,默認0.0.1-SNAPSHOT。SNAPSHOT代表不穩定的版本,與之相對的有RELEASE。
Project type:工程的類型,maven工程還是gradle工程。
Language:語言(Java,Kotlin,Groovy)。
Packaging:Jar包還是War包。
Java version:語法版本,與Project SDK不同,Project SDK是實際用到的JDK。Java version指的是語法版本。一般來說語言特性不能比SDK高。比如SDK版本是11,語法選擇8。那麼實際項目中只能使用java 8的語法。反之SDK版本是8,語法選11就有問題了。一般情況下都會與SDK保持一致。
Project name:項目名稱
Project description:項目描述
Package name:包名
第三部分根據項目的實際需求去配置。
第四部分:
設置項目名稱與路徑。
2.前端配置
考慮到導入導出功能需要對Excel具有較高的還原度,這裡使用了SpreadJS組件,通過SpreadJS組件的ExcelIO功能,進行Excel的導入與導出。SpreadJS是一款純前端的組件,與後端完全解耦,可以完美的整合到SpringBoot工程中。
2.1 前端頁面創建
在static目錄下建立index.html文件,用來繪製前端頁面。如果用了thymeleaf也可以將文件建立在templates目錄中。
2.1 SpreadJS組件引入和初始化
在header中引入SpreadJS相關的css與js引用。
創建SpreadJS對應的DOM對象。
在JS中初始化SpreadJS和導入導出Excel相關的ExcelIO對象。
通過按鈕點擊進行服務端導入與導出。
導入導出事件處理,在事件中發送請求與服務端進行連接。
導入原理:
將服務端的文件以文件流的形式傳輸至前端,前端通過ExcelIO將結果導入結果呈現值SpreadJS中,所以導入的傳遞的參數是一個文件路徑。注意該路徑是文件在服務端或者工程中的一個路徑。
導出原理:
通過SpreadJS ExcelIO的功能將內容導出成Excel的blob流。之後將blob流傳至伺服器端,在伺服器端進行保存Excel文件的操作。
3.後端配置
創建後端controller,可按照自身項目的包的層級分類進行創建。
構建服務端的導入導出方法和相關邏輯。
伺服器端導入:
由於前端傳入的是一個文件的路徑,所以參數這裡我們需要一個字元串類型的參數去接收。
另外,我們會將流傳到前端,所以會將流寫到response中,所以參數中還需要response對象,方法本身不需要返回,返回空即可。原理是通過inputStream讀取文件後,將其寫入response的outputStream中。
導出到伺服器:
由於前端傳入傳入的是保存文件的名稱以及文件blob文件流。伺服器端需要兩個參數,String用來接收文件名稱,MultipartFile對象用來接收blob文件流。後端接受到文件流之後通過transferTo方法在指定目錄下根軍傳來的fileName轉存成新的文件。
4.測試運行
將工程跑起來之後進入主頁面,顯示如下:
點擊服務端導入按鈕,從伺服器端下載指定的Excel文件並打開。
對該文件進行操作修改並點擊服務端導出的按鈕。
之後我們去伺服器端的導出路徑下查看,發下文件存在,用Excel打開文件後發現,修改後的內容健在並且其他內容顯示均無問題。
到這裡我們就實現了Spring Boot框架下實現Excel服務端導入導出。
拓展閱讀
React + Springboot + Quartz,從0實現Excel報表自動化
使用純前端類Excel表格控制項SpreadJS構建企業現金流量表