超好用的Excel异步导出功能

水深无声 2022-09-10 04:28 221阅读 0赞

之前也做过关于Excel的导出案例，此次也是在其基础上进行改造升级：

[https://www.bilibili.com/video/BV1kf4y1i761?p=5  
][https_www.bilibili.com_video_BV1kf4y1i761_p_5]

但是之前的导出存在这么几个问题：

*  如果是数据量很大容易导致页面卡死（我曾导出30w条数据，直接导致OOM）
 *  用户体验很糟糕，数据量一多就会等很久，而且用户没办法做别的事情。
 *  每次点击导出都需要走一遍完整的导出过程（这个其实还好）
 *  没办法对每次导出的数据进一个规整

今天使用**异步导出**来解决上述问题。

## 一、UML图 ##

### 1-1、导出图 ###

前台ControllerServiceAServiceB点击导出往数据库插入记录插入一条下载记录idname文件名rows 下载行数 (null)takeUpTime 下载耗时 (null)downloadUrl 下载地址（null）异步下载 (id、startTime)success下载成功，稍等片刻去【下载中心】下载根据需求去获取对应的数据把数据生成一个文件保存起来根据Id获取刚刚插入的记录完善以下数据rows 下载行数takeUpTime 下载耗时downloadUrl 下载地址（null）前台ControllerServiceAServiceB

### 1-2、下载图 ###

前台Controller获取下载列表返回下载列表downLoadUrl返回文件流前台Controller

从上面的图中可以看出，整个下载是异步的，用户不需要在页面等待，每次导出我们都生成一个记录和一个文件，用户可以多次下载。

## 二、功能实现 ##

### 2-1、记录实体 ###

/** * Excel列表数据 * * @author 小道仙97 * @date 2021/8/8 */
    public class ExcelList { 
    
        /** * id */
        private String id;
    
        /** * 文件名 */
        private String name;
    
        /** * 下载行数 */
        private Integer rows;
    
        /** * 下载耗时 */
        private Long takeUpTime;
    
        /** * 下载地址 */
        private String downloadUrl;
    }

### 2-2、Controller ###

import javax.servlet.http.HttpServletResponse;
    import java.util.*;
    
    /** * Excel导出 * * @author 小道仙97 * @date 2021-08-08 */
    @RestController
    public class ExportExcelController { 
    
        @Autowired
        private ExportExcel exportExcel;
    
        // 模仿下载列表
        public static List<ExcelList> list = new ArrayList<>(10);
    
        /** * Excel 导出 * @throws Exception */
        @GetMapping("/excel/export")
        public void export() { 
            Long startTime = System.currentTimeMillis();
            String name = "Excel异步导出测试" + UUID.randomUUID().toString() + ".xlsx";
            String id = UUID.randomUUID().toString();
            ExcelList excelList = new ExcelList();
            excelList.setId(id);
            excelList.setName(name);
            list.add(excelList);
            // 异步导出
            exportExcel.asyncExportExcel(id,name,startTime);
    
        }
    
        /** * 获取导出列表 - 模拟 */
        @GetMapping("/excel/list")
        public List<ExcelList> list() { 
           return list;
        }
    
        /** * 文件下载 */
        @GetMapping("/excel/downLoad")
        public void downLoad(HttpServletResponse response,@RequestParam  String url) { 
            FileUtils.download(url, response);
        }
    }

### 2-3、异步下载实现 ###

**ExportExcel**

注：使用异步注解`@Async` 需要先在启动类上开启 `@EnableAsync`

import org.springframework.scheduling.annotation.Async;
    
    public interface ExportExcel { 
    
        /** * 异步导出 * @param id 唯一记录Id * @param name 文件名称 * @param startTime 下载开始时间 */
        @Async
        void asyncExportExcel(String id,String name,Long startTime);
    }

**TestExportExcelImpl**

@Service
    public class TestExportExcelImpl implements ExportExcel { 
    
        @Override
        public void asyncExportExcel(String id,String name,Long startTime) { 
            // 模拟查询数据过程
            String[] header = new String[]{ "姓名","年纪"};
            String[] keys = new String[]{ "name","age"};
            List<Map<String, Object>> content = new ArrayList<>();
            Map<String, Object> map1 = new HashMap<>();
            map1.put("name","小道仙");
            map1.put("age","23");
            content.add(map1);
            Map<String, Object> map2 = new HashMap<>();
            map2.put("name","小道仙97");
            map2.put("age","97");
            content.add(map2);
    
            try { 
                // 获取Excel导出文件流
                ByteArrayOutputStream os = new ByteArrayOutputStream();
                ExcelUtils.exportExcel(header,keys,content,"first",os);
                byte[] content1 = os.toByteArray();
                InputStream inputStream = new ByteArrayInputStream(content1);
                // 上传文件 返回下载地址
                String url = FileUtils.uploadInputStream(inputStream, name);
                /** * 找到当前数据并封装结果集 * * 其实这里很简单并无这么复杂，实际情况我们只需要一个 update 语句就可以搞定 */
                for (ExcelList item : ExportExcelController.list) { 
                    if (item.getId().equals(id)) { 
                        item.setRows(content.size());
                        item.setDownloadUrl(url);
                        item.setTakeUpTime(System.currentTimeMillis() - startTime);
                        break;
                    }
                }
            }catch (Exception e){ 
                e.printStackTrace();
            }
        }
    }

## 三、演示 ##

下面的演示的前提都是在启动了项目的基础上

### 3-1、导出 ###

因为没有做任何的返回值，所以是空返回，这里也可以自定义任何提示返回。

http://127.0.0.1:8888/excel/export

### 3-2、下载列表 ###

http://127.0.0.1:8888/excel/list

返回结果如下：

[
        { 
            "id": "d3cb3551-cb33-445e-8e60-9534197f6647",
            "name": "Excel异步导出测试80d50264-3930-4667-8bc5-2d4a1cfe0d9d.xlsx",
            "rows": 2,
            "takeUpTime": 5,
            "downloadUrl": "2021/8/8/Excel异步导出测试80d50264-3930-4667-8bc5-2d4a1cfe0d9d.xlsx"
        }
    ]

### 3-3、下载 ###

http://127.0.0.1:8888/excel/downLoad?url=2021/8/8/Excel异步导出测试80d50264-3930-4667-8bc5-2d4a1cfe0d9d.xlsx

视频看讲解地址：[https://www.bilibili.com/video/BV1kf4y1i761][https_www.bilibili.com_video_BV1kf4y1i761]

关注微信公众号回复：**xdxFrameSimple** 获取源码。

![在这里插入图片描述][69a97cb011f94b8abfb7a567e0857398.jpg_pic_center]

[https_www.bilibili.com_video_BV1kf4y1i761_p_5]: https://www.bilibili.com/video/BV1kf4y1i761?p=5
[https_www.bilibili.com_video_BV1kf4y1i761]: https://www.bilibili.com/video/BV1kf4y1i761
[69a97cb011f94b8abfb7a567e0857398.jpg_pic_center]: /images/20220829/0047c321ad50410cbd31f136ad6b84c5.png