【EasyPoi实战系列】Spring Boot集成EasyPoi - 第467篇

和导出/导入相关的核心依赖是：easypoi-spring-boot-starter。

2.2 编写Excel操作工具类

Easypoi提供了对于Excel的基本操作，根据web的导出，我们进行简单的封装即可：

package com.example.demo;​import cn.afterturn.easypoi.excel.ExcelExportUtil;import cn.afterturn.easypoi.excel.ExcelImportUtil;import cn.afterturn.easypoi.excel.entity.ExportParams;import cn.afterturn.easypoi.excel.entity.ImportParams;import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;import org.apache.commons.lang3.StringUtils;import org.apache.poi.ss.usermodel.Workbook;import org.springframework.web.multipart.MultipartFile;​import javax.servlet.http.HttpServletResponse;import java.io.File;import java.io.IOException;import java.net.URLEncoder;import java.util.List;import java.util.Map;import java.util.NoSuchElementException;​/** * 导入导出工具类 * @Author huoqiang **/public class ExcelUtil {        public static void exportExcel(List list, String title, String sheetName, Class pojoClass,String fileName, HttpServletResponse response){        defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));    }​    private static void defaultExport(List list, Class pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) {        Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);        if (workbook != null) {            downLoadExcel(fileName, response, workbook);        }    }​    public static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) {        try {            response.setCharacterEncoding("UTF-8");            response.setHeader("content-Type", "application/vnd.ms-excel");            response.setHeader("Content-Disposition",                    "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));            workbook.write(response.getOutputStream());        } catch (IOException e) {            throw new RuntimeException(e.getMessage());        }    }​    public static void exportExcelX(List list, String title, String sheetName, Class pojoClass,String fileName, HttpServletResponse response){        defaultExportX(list, pojoClass, fileName, response, new ExportParams(title, sheetName,ExcelType.XSSF));    }​    private static void defaultExportX(List list, Class pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) {        Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);        if (workbook != null) {            downLoadExcelX(fileName, response, workbook);        }    }​    private static void downLoadExcelX(String fileName, HttpServletResponse response, Workbook workbook) {        try {            response.setCharacterEncoding("UTF-8");            response.setHeader("content-Type", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");            response.setHeader("Content-Disposition",                    "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));            workbook.write(response.getOutputStream());        } catch (IOException e) {            throw new RuntimeException(e.getMessage());        }    }​    public static void exportExcel(List list, String title, String sheetName, Class pojoClass,String fileName,boolean isCreateHeader, HttpServletResponse response){        ExportParams exportParams = new ExportParams(title, sheetName);        exportParams.setCreateHeadRows(isCreateHeader);        defaultExport(list, pojoClass, fileName, response, exportParams);​    }​    public static void exportExcel(List> list, String fileName, HttpServletResponse response){        defaultExport(list, fileName, response);    }​    private static void defaultExport(List> list, String fileName, HttpServletResponse response) {        Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);        if (workbook != null) {            downLoadExcel(fileName, response, workbook);        }    }​    public static  List importExcel(String filePath,Integer titleRows,Integer headerRows, Class pojoClass){        if (StringUtils.isBlank(filePath)){            return null;        }        ImportParams params = new ImportParams();        params.setTitleRows(titleRows);        params.setHeadRows(headerRows);        List list = null;        try {            list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);        }catch (NoSuchElementException e){            throw new RuntimeException("模板不能为空");        } catch (Exception e) {            e.printStackTrace();            throw new RuntimeException(e.getMessage());        }        return list;    }    public static  List importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class pojoClass){        if (file == null){            return null;        }        ImportParams params = new ImportParams();        params.setTitleRows(titleRows);        params.setHeadRows(headerRows);        List list = null;        try {            list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params);        }catch (NoSuchElementException e){            throw new RuntimeException("excel文件不能为空");        } catch (Exception e) {            throw new RuntimeException(e.getMessage());        }        return list;    }}

2.3 编写表格数据VO

对于Excel表格对应的单元格数据VO：

package com.example.demo.vo;​import cn.afterturn.easypoi.excel.annotation.Excel;import lombok.AllArgsConstructor;import lombok.Data;​import java.io.Serializable;import java.util.Date;​/** * author：悟纤「公众号SpringBoot」 * date：2023/4/19 */@Data@AllArgsConstructorpublic class UserExportVO implements Serializable {    @Excel(name = "姓名")    private String realName;​    @Excel(name = "性别")    private Integer sex;​    @Excel(name = "出生日期")    private Date birthday;​    @Excel(name = "手机号码")    private String phone;​    @Excel(name = "邮箱")    private String email;​    @Excel(name = "头像地址")    private String avatar;​    @Excel(name = "描述")    private String remark;}​

这里使用到了核心的一个注解@Excel，通过指定属性name来指定excel单元格的表头。

2.4 编写导出代码

编写一个Controller进行导出：

package com.example.demo;​import cn.afterturn.easypoi.excel.ExcelExportUtil;import cn.afterturn.easypoi.excel.entity.ExportParams;import com.example.demo.vo.UserExportVO;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;​import javax.servlet.http.HttpServletResponse;import java.util.ArrayList;import java.util.Date;import java.util.List;​/** * author：悟纤「公众号SpringBoot」 * date：2023/4/19 */@RestController@RequestMapping("/demo")public class DemoController {​    @GetMapping("/exportExcel")    public void export(HttpServletResponse response) {        //查询要导出的数据        //List users = userService.getUserExportList();        // 模拟数据        List users = new ArrayList<>();        users.add(new UserExportVO("悟纤",1,new Date(),"18688888888","1688@qq.com","https://picx.zhimg.com/80/v2-e141b3376b01e54409346bfcc9037e62_1440w.jpg","公众号SpringBoot"));        users.add(new UserExportVO("师傅",1,new Date(),"18666666666","1888@qq.com","https://picx.zhimg.com/80/v2-e141b3376b01e54409346bfcc9037e62_1440w.jpg","公众号SpringBoot"));​        ExcelUtil.exportExcelX(users, "测试导出表", "sheet1", UserExportVO.class, "测试导出表.xlsx", response);    }​​}​

2.5 测试导出

启动项目，访问地址：

http://127.0.0.1:8080/demo/exportExcel

导出就是如此之简单。

总结

如果用过POI导出的，那么再用EasyPoi就会发现EasyPoi使用起来就会简单很多了。本节就先介绍到此为止，简单的做下总结：

（1）导入导出数据可以使用Apache的POI来进行实现。

（2）为什么没使用POI？其原生的用法太复杂，很繁琐

（3）EasyPoi也是基于POI的。

（4）EasyPoi在Spring Boot中的使用：添加依赖，easypoi-spring-boot-starter，然后使用EasyPoi提供的Excel导出类ExcelExportUtil的exportExcel方法，构建一个Workbook；最后利用response进行下载excel文件。

悟纤：师傅，导出是可以来了，但我这导出还存在一些问题呐。

师傅：何以见得？

悟纤：我给你罗列一下哦

（1）姓名单元格都快把你我挤坏了。

（2）性别怎么能显示数字呢，不得显示对应的男/女吗？

（3）图片显示的地址问题也不大，但是产品还是希望能够显示为图片呢。

（4）出生日期格式也不友好呀。

师傅：徒儿，不错，不错，思考的很到位。你说的这些问题，都是需要优化和调整的，下节咱们继续来学习。

「关注我不迷路，带你探索新技术」

我是一名热爱技术、分享经验的 IT 从业者。如果您也热爱计算机、喜欢编程、探寻新技术，那么我们一定会成为好朋友！我的微信号是 [wuqian5268]，如果你想随时和我交流、讨论技术或者了解我最新的项目和成果，请不要犹豫，立即扫码或者添加我吧！

我就是我，是颜色不一样的烟火。
我就是我，是与众不同的小苹果。

à悟纤学院：https://t.cn/Rg3fKJD

学院中有Spring Boot相关的课程！点击「阅读原文」进行查看！

SpringBoot视频：http://t.cn/A6ZagYTi

SpringBoot交流平台：https://t.cn/R3QDhU0

SpringSecurity5.0视频：http://t.cn/A6ZadMBe

ShardingJDBC分库分表：http://t.cn/A6ZarrqS

分布式事务解决方案：http://t.cn/A6ZaBnIr

JVM内存模型调优实战：http://t.cn/A6wWMVqG

Spring入门到精通：https://t.cn/A6bFcDh4

大话设计模式之爱你：https://dwz.cn/wqO0MAy7

本文来自互联网用户投稿，文章观点仅代表作者本人，不代表本站立场，不承担相关法律责任。如若转载，请注明出处。 如若内容造成侵权/违法违规/事实不符，请点击【内容举报】进行投诉反馈！