SpringBoot+Hutool+thymeleaf完成導出Excel的實現方法
導出Excel的框架有很多種,POI相對來說比較老瞭,很多Excel框架底層都是POI、有EasyPoi、EasyExcel、包括Hutool當中封裝的也是POI。唯一不同的是Hutool工具包不局限與做Excel、他裡面封裝瞭大量的util,一般現在開發都會用到糊塗。
本篇示例當中不僅僅有後端,而且還提供瞭前端html,html當中利用js將後端 輸出流直接下載為文件。
實現的效果如下:一點擊導出文件直接下載到本地。應該現在導出普遍都是這樣。
1、引入依賴
這裡用到瞭lombok,就是簡化實體類當中的get、set方法的。
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-thymeleaf</artifactId> </dependency> <!-- 導出重要依賴|截止2022-03-09 hutool和poi-ooxml依賴是最新的 --> <!--POI組件 設置字體樣式--> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>5.2.1</version> </dependency> <dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.7.22</version> </dependency>
2、創建實體類
用於導出測試使用。
import lombok.AllArgsConstructor; import lombok.Data; @Data @AllArgsConstructor public class User { private String name; private Integer age; private String sex; }
3、創建導出接口
導出主要是圍繞ExcelWriter類來進行開發的。
hutool在線api:https://apidoc.gitee.com/dromara/hutool/
我大概看瞭一眼,根據api其實任何復雜的Excel導出都可以做出來,API可以設置指定單元格樣式字體、還有指定行的樣式字體、合並單元格等等…
import cn.hutool.poi.excel.ExcelUtil; import cn.hutool.poi.excel.ExcelWriter; import com.gzl.cn.hutoolexcel.domain.User; import org.apache.poi.ss.usermodel.CellStyle; import org.apache.poi.ss.usermodel.Font; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestMapping; import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.net.URLEncoder; import java.nio.charset.StandardCharsets; import java.util.*; @Controller @RequestMapping("/test") public class TestController { /** * 導出測試 * * @param response * @param startDate * @param endDate */ @PostMapping("/export") public void export2(HttpServletResponse response, String startDate, String endDate) { List<User> list = data(); // 1.創建ExcelWriter // 通過工具類創建writer,默認創建xls格式 ExcelWriter excelWriter = ExcelUtil.getWriter(); //創建xlsx格式的 //ExcelWriter writer = ExcelUtil.getWriter(true); // 2.設置一級標題 // 合並單元格後的標題行,使用默認標題樣式,從0開始 excelWriter.merge(2, "學生記錄"); // 設置表頭高度 excelWriter.setRowHeight(0, 25); // 3.設置二級標題 excelWriter.addHeaderAlias("name", "姓名"); excelWriter.addHeaderAlias("age", "年齡"); excelWriter.addHeaderAlias("sex", "性別"); // 4.設置表頭字體 // 獲取表頭樣式,獲取樣式後可自定義樣式 CellStyle headCellStyle = excelWriter.getHeadCellStyle(); // 獲取單元格樣式 // CellStyle cellStyle = excelWriter.getCellStyle(); // 設置內容字體 Font font = excelWriter.createFont(); // 設置字體 font.setFontName("宋體"); // 設置字體大小 font.setFontHeightInPoints((short) 14); // 字體加粗 font.setBold(true); // 字體顏色 font.setColor(Font.SS_NONE); headCellStyle.setFont(font); // 5.設置單元格寬度 int[] arr = {30, 30, 25}; for (int i = 0; i < arr.length; i++) { excelWriter.setColumnWidth(i, arr[i]); } // 隻導出有別名的字段 excelWriter.setOnlyAlias(true); // 一次性寫出內容,使用默認樣式,強制輸出標題 excelWriter.write(list, true); // 從第幾行寫入 // excelWriter.setCurrentRow(1); // excelWriter.writeRow(data()); // 設置某個單元格的樣式 // CellStyle orCreateCellStyle = excelWriter.getOrCreateCellStyle(0, 1); // 設置某行的樣式 // excelWriter.setRowStyle(); try { String fileName = URLEncoder.encode("統計" + startDate + "日到" + endDate + "日", StandardCharsets.UTF_8.name()); response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"); response.setCharacterEncoding("utf-8"); response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx"); // 將Excel Workbook刷出到輸出流 excelWriter.flush(response.getOutputStream()); } catch (IOException e) { e.printStackTrace(); throw new RuntimeException("文件寫入失敗!"); } //關閉流 excelWriter.close(); } /** * 構造 導出的數據 * * @return */ public List<User> data() { List<User> users = new ArrayList<>(); users.add(new User("張三", 2, "男")); users.add(new User("李四", 2, "女")); return users; } }
4、創建html
在templates下創建index.html,這樣啟動項目後直接訪問8080端口,他會直接調到index.html。
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> <script src="https://ajax.aspnetcdn.com/ajax/jquery/jquery-3.5.1.min.js"></script> </head> <body> <input type="button" id="clickme" value="導出"/> </body> <script type="text/javascript"> function postExcelFile(params, url) { //params是post請求需要的參數,url是請求url地址 var form = document.createElement("form"); form.style.display = 'none'; form.action = url; form.method = "post"; document.body.appendChild(form); for (var key in params) { var input = document.createElement("input"); input.type = "hidden"; input.name = key; input.value = params[key]; form.appendChild(input); } form.submit(); form.remove(); } //點擊導出按鈕導出excel表格 clickme.onclick = function () { var params = {}; params.startDate = '2022-01-01'; params.endDate = '2022-03-03'; postExcelFile(params, "/test/export"); } </script> </html>
5、測試導出
到此這篇關於SpringBoot+Hutool+thymeleaf完成導出Excel的文章就介紹到這瞭,更多相關SpringBoot導出Excel內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- Java Hutool工具實現驗證碼生成及Excel文件的導入和導出
- Hutool Java工具類庫_ExcelUtil的使用
- SpringBoot+hutool實現圖片驗證碼
- Java利用POI實現導入導出Excel表格
- springboot+hutool批量生成二維碼壓縮導出功能