SpringBoot整合EasyExcel實現復雜Excel表格的導入導出

更新時間：2023年11月28日 11:48:42 作者：IT·陳寒

這篇文章主要為大家詳細介紹了SpringBoot如何整合EasyExcel實現復雜Excel表格的導入導出功能,文中的示例代碼講解詳細,感興趣的小伙伴可以參考下

引言

在實際的軟件開發(fā)中，數據的導入和導出是非常常見的需求，特別是對于復雜的Excel表格，常規(guī)的處理方式可能顯得繁瑣而效率低下。SpringBoot作為一種現代化的Java開發(fā)框架，EasyExcel則是一款優(yōu)秀的Excel操作工具，兩者的結合可以大大簡化開發(fā)過程，提高效率。本文將介紹如何使用SpringBoot整合EasyExcel來實現復雜Excel表格的導入和導出功能。

一、環(huán)境準備

在開始之前，請確保你的開發(fā)環(huán)境中已經準備好了以下工具和庫：

JDK 8及以上版本
Maven
SpringBoot
EasyExcel

你可以通過Maven引入EasyExcel的依賴：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>2.2.10</version>
</dependency>

二、導入Excel數據

首先，我們將重點介紹如何使用SpringBoot整合EasyExcel來實現復雜Excel表格的導入功能。

1. 創(chuàng)建實體類

假設我們要導入的Excel表格數據如下：

姓名	年齡	地址	電話
張三	25	北京市朝陽區(qū)	13888888888
李四	30	上海市浦東區(qū)	13999999999
王五	28	廣州市天河區(qū)	13666666666

我們需要創(chuàng)建一個對應的Java實體類，例如：

public class User {
    private String name;
    private Integer age;
    private String address;
    private String phone;
    
    // 省略getter和setter方法
}

2. 編寫Excel導入的Controller

@RestController
@RequestMapping("/excel")
public class ExcelController {

    @PostMapping("/import")
    public String importExcel(@RequestParam("file") MultipartFile file) {
        try {
            List<User> userList = EasyExcel.read(file.getInputStream(), User.class, new UserDataListener()).sheet().doReadSync();
            // 處理導入的數據，可以保存到數據庫或進行其他操作
            // ...

            return "導入成功";
        } catch (Exception e) {
            e.printStackTrace();
            return "導入失?。? + e.getMessage();
        }
    }
}

在上面的例子中，UserDataListener是一個實現了AnalysisEventListener接口的監(jiān)聽器，用于監(jiān)聽Excel數據的讀取過程。

public class UserDataListener extends AnalysisEventListener<User> {

    private List<User> userList = new ArrayList<>();

    @Override
    public void invoke(User user, AnalysisContext context) {
        userList.add(user);
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        // 數據讀取完畢后的操作，可以在這里對數據進行進一步處理
        // ...
    }
}

3. 編寫前端頁面

在前端頁面中，我們需要一個文件上傳的表單，例如使用HTML的<form>標簽和<input type="file">標簽：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Excel導入</title>
</head>
<body>

<form action="/excel/import" method="post" enctype="multipart/form-data">
    <input type="file" name="file" accept=".xlsx, .xls">
    <button type="submit">導入Excel</button>
</form>

</body>
</html>

4. 啟動SpringBoot應用

通過以上步驟，我們已經完成了Excel導入功能的開發(fā)。啟動SpringBoot應用，并訪問前端頁面，選擇要導入的Excel文件，點擊導入按鈕即可完成數據導入。

三、導出Excel數據

下面，我們將介紹如何使用SpringBoot整合EasyExcel來實現復雜Excel表格的導出功能。

1. 編寫導出的Controller

@RestController
@RequestMapping("/excel")
public class ExcelController {

    @Autowired
    private ExcelService excelService;

    @GetMapping("/export")
    public void exportExcel(HttpServletResponse response) {
        try {
            excelService.exportExcel(response);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

2. 編寫導出的Service

@Service
public class ExcelService {

    public void exportExcel(HttpServletResponse response) throws IOException {
        // 查詢數據庫或其他數據源獲取導出的數據
        List<User> userList = getUserList();

        // 設置響應頭
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        response.setHeader("Content-disposition", "attachment;filename=user.xlsx");

        // 導出Excel
       

 ExcelWriter excelWriter = EasyExcel.write(response.getOutputStream(), User.class).build();
        WriteSheet writeSheet = EasyExcel.writerSheet("用戶信息").build();
        excelWriter.write(userList, writeSheet);
        excelWriter.finish();
    }

    private List<User> getUserList() {
        // 模擬從數據庫中獲取用戶數據
        List<User> userList = new ArrayList<>();
        userList.add(new User("張三", 25, "北京市朝陽區(qū)", "13888888888"));
        userList.add(new User("李四", 30, "上海市浦東區(qū)", "13999999999"));
        userList.add(new User("王五", 28, "廣州市天河區(qū)", "13666666666"));
        return userList;
    }
}

3. 編寫前端頁面

在前端頁面中，我們可以提供一個導出按鈕，通過點擊按鈕觸發(fā)導出操作：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Excel導出</title>
</head>
<body>

<a href="/excel/export" rel="external nofollow"  target="_blank">導出Excel</a>

</body>
</html>

4. 啟動SpringBoot應用

通過以上步驟，我們已經完成了Excel導出功能的開發(fā)。啟動SpringBoot應用，并訪問前端頁面，點擊導出按鈕即可下載導出的Excel文件。

拓展

異常處理：在實際項目中，需要對異常進行合理的處理?？梢酝ㄟ^在Controller中捕獲異常，并返回友好的提示信息，提高用戶體驗。

模板導出：有時候，我們需要按照一定的模板導出Excel文件，EasyExcel也提供了相關的API來支持模板導出。

大數據量處理：當需要處理大量數據時，可以考慮使用EasyExcel的分段讀取和分段寫入功能，以減輕內存壓力。

總結

通過本文的介紹，我們學習了如何使用SpringBoot整合EasyExcel來實現復雜Excel表格的導入和導出功能。EasyExcel提供了簡潔易用的API，使得開發(fā)者可以輕松地完成Excel操作，提高了開發(fā)效率。在實際項目中，可以根據需求進一步定制導入導出的邏輯，滿足不同場景的要求。希望本文對你在Excel操作方面的開發(fā)提供了幫助。

以上就是SpringBoot整合EasyExcel實現復雜Excel表格的導入導出的詳細內容，更多關于SpringBoot EasyExcel表格導入導出的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: