Springboot导出多sheet的Excel

背景

在日常操作中，导出Excel是一个比较常见的需求，一般是直接导出全部的数据到Excel表格中。今天碰到一个需求，需要将不同的数据导入到一个Excel中，这个时候就可以选择不同的sheet来存储不同数据，在此简单记录一下。

EasyPoi

easypoi的目标不是替代poi,而是让一个不懂导入导出的快速使用poi完成Excel和word的各种操作,而不是看很多api才可以完成这样工作。

功能

• 基于注解的导入导出,修改注解就可以修改Excel。
• 支持常用的样式自定义。
• 基于map可以灵活定义的表头字段。
• 支持一堆多的导出,导入。
• 支持模板的导出,一些常见的标签,自定义标签。
• 支持HTML/Excel转换,如果模板还不能满足用户的变态需求,请用这个功能。
• 支持word的导出,支持图片,Excel。

使用

导入依赖

        <dependency>
            <groupId>cn.afterturn</groupId>
            <artifactId>easypoi-spring-boot-starter</artifactId>
            <version>4.4.0</version>
        </dependency>

导出单个sheet的excel

Entity

@Data
public class StudentEntity {

    /**
     * id
     */
    private String pid;

    /**
     * 名字
     */
    @Excel(name = "名字")
    private String name;

    /**
     * 播放时长
     */
    @Excel(name = "年龄")
    private Integer age;


    /**
     * 开始时间
     */
    @Excel(name = "爱好")
    private String hobby;
}

Controller

    /**
     * 导出SIM卡信息
     */
    @GetMapping("/export")
    public void exportSIM ( HttpServletRequest request,
                           HttpServletResponse response, ModelMap map) {
        List<StudentEntity> list=studentService.getList();
        //第一个参数是title，第二个是sheet的名字
        ExportParams params = new ExportParams("学生爱好调查表", "student", ExcelType.XSSF);
        //导出的数据
        map.put(NormalExcelConstants.DATA_LIST, list);
        map.put(NormalExcelConstants.CLASS, StudentEntity.class);
        map.put(NormalExcelConstants.PARAMS, params);
        //导出的文件名
        map.put(NormalExcelConstants.FILE_NAME, "学生爱好表-" + DateUtils.format(new Date(),DateUtils.DATE_PATTERN));
        PoiBaseView.render(map, request, response, NormalExcelConstants.EASYPOI_EXCEL_VIEW);
    }

导出多sheet的Excel

Entity

@Data
public class TeacherEntity {

    /**
     * id
     */
    private String pid;

    /**
     * 名字
     */
    @Excel(name = "名字")
    private String name;

    /**
     * 播放时长
     */
    @Excel(name = "年龄")
    private Integer age;


    /**
     * 开始时间
     */
    @Excel(name = "爱好")
    private String hobby;
}

Controller

    @GetMapping("/excel")
    public void exportSIM (HttpServletResponse response) {
        List<StudentEntity> studentList= studentService.getList();
        List<TeacherEntity> teacherList = teacherService.getList();
        //多个map，对应了多个sheet
        List<Map<String, Object>> listMap = new ArrayList<>();
        ExportParams params = new ExportParams();
        params.setSheetName("学生爱好表");
        HashMap<String, Object> student = new HashMap<>();
        params.setTitle("学生爱好表");
        student.put(NormalExcelConstants.DATA_LIST, studentList);
        student.put(NormalExcelConstants.CLASS, StudentEntity.class);
        student.put("title", params);
        listMap.add(student);
        HashMap<String,Object> teacher=new HashMap<>();
        ExportParams teacherParams = new ExportParams();
        teacherParams.setSheetName("老师爱好表");
        teacherParams.setTitle("老师爱好表");
        teacher.put(NormalExcelConstants.DATA_LIST, teacherList);
        teacher.put(NormalExcelConstants.CLASS, TeacherEntity.class);
        teacher.put("title", teacherParams);
        listMap.add(teacher);
        Workbook workbook = ExcelExportUtil.exportExcel(listMap,ExcelType.XSSF);
        // 设置响应头
        response.setContentType("application/octet-stream");
        try {
            response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode("爱好表-" + DateUtils.format(new Date(),DateUtils.DATE_PATTERN)+".xlsx", "UTF-8"));
            // 将Workbook写入响应流
            workbook.write(response.getOutputStream());
            workbook.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

EasyExcel

easyexcel重写了poi对07版Excel的解析，一个3M的excel用POI sax解析依然需要100M左右内存，改用easyexcel可以降低到几M，并且再大的excel也不会出现内存溢出；03版依赖POI的sax模式，在上层做了模型转换的封装，让使用者更加简单方便

使用

导入依赖

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

Entity

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName(value = "student")
public class Student {
    @ExcelProperty("用户名")
    @TableId(value = "username")
    private String username;

    @ExcelProperty("密码")
    private String password;
    
    @ExcelProperty("年龄")
    private int age;

    @ExcelProperty("性别")
    private String gender;

    @ExcelProperty("手机号码")
    private String phoneNum;

    @ExcelProperty("邮箱")
    private String email;

    @ExcelIgnore
    private String avatar;
}

Controller

    @GetMapping("/down")
    public void down(HttpServletResponse response) throws IOException {
        List<Student> userList = studentService.list();
        //返回输出流_excel格式
        response.setContentType("application/octet-stream");
        String fileName = URLEncoder.encode("用户信息表", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");

        EasyExcel.write(response.getOutputStream(), Student.class).autoCloseStream(Boolean.FALSE).sheet("用户信息表").doWrite(userList);
    }

多个sheet

这里偷个懒，直接用的官方的例子。

    /**
     * 重复多次写入
     * <p>
     * 1. 创建excel对应的实体对象 参照{@link ComplexHeadData}
     * <p>
     * 2. 使用{@link ExcelProperty}注解指定复杂的头
     * <p>
     * 3. 直接调用二次写入即可
     */
    @Test
    public void repeatedWrite() {
        // 方法1: 如果写到同一个sheet
        String fileName = TestFileUtil.getPath() + "repeatedWrite" + System.currentTimeMillis() + ".xlsx";
        // 这里 需要指定写用哪个class去写
        try (ExcelWriter excelWriter = EasyExcel.write(fileName, DemoData.class).build()) {
            // 这里注意 如果同一个sheet只要创建一次
            WriteSheet writeSheet = EasyExcel.writerSheet("模板").build();
            // 去调用写入,这里我调用了五次，实际使用时根据数据库分页的总的页数来
            for (int i = 0; i < 5; i++) {
                // 分页去数据库查询数据 这里可以去数据库查询每一页的数据
                List<DemoData> data = data();
                excelWriter.write(data, writeSheet);
            }
        }

        // 方法2: 如果写到不同的sheet 同一个对象
        fileName = TestFileUtil.getPath() + "repeatedWrite" + System.currentTimeMillis() + ".xlsx";
        // 这里 指定文件
        try (ExcelWriter excelWriter = EasyExcel.write(fileName, DemoData.class).build()) {
            // 去调用写入,这里我调用了五次，实际使用时根据数据库分页的总的页数来。这里最终会写到5个sheet里面
            for (int i = 0; i < 5; i++) {
                // 每次都要创建writeSheet 这里注意必须指定sheetNo 而且sheetName必须不一样
                WriteSheet writeSheet = EasyExcel.writerSheet(i, "模板" + i).build();
                // 分页去数据库查询数据 这里可以去数据库查询每一页的数据
                List<DemoData> data = data();
                excelWriter.write(data, writeSheet);
            }
        }

        // 方法3 如果写到不同的sheet 不同的对象
        fileName = TestFileUtil.getPath() + "repeatedWrite" + System.currentTimeMillis() + ".xlsx";
        // 这里 指定文件
        try (ExcelWriter excelWriter = EasyExcel.write(fileName).build()) {
            // 去调用写入,这里我调用了五次，实际使用时根据数据库分页的总的页数来。这里最终会写到5个sheet里面
            for (int i = 0; i < 5; i++) {
                // 每次都要创建writeSheet 这里注意必须指定sheetNo 而且sheetName必须不一样。这里注意DemoData.class 可以每次都变，我这里为了方便 所以用的同一个class
                // 实际上可以一直变
                WriteSheet writeSheet = EasyExcel.writerSheet(i, "模板" + i).head(DemoData.class).build();
                // 分页去数据库查询数据 这里可以去数据库查询每一页的数据
                List<DemoData> data = data();
                excelWriter.write(data, writeSheet);
            }
        }

    }

最后

这两个工具都非常好用，easyexcel是针对excel的，easypoi则有更多的功能，重要的是他们两个在官方文档都有很多很好的例子可供参考，如果还有不会的可以直接去官网看看，也很容易看懂。