1.前言

本文章采用抛出需求，之后跟上解决实例的方式

2.实例一

2.1需求

一个对象直接导出成一个Excel表格
①导出的对象

  1. @Data
  2. public class PersonExportVo implements Serializable {
  3.     private Integer id;
  4.     private String name;
  5.     private Date birth;
  6. }

②想导出的表格
image.png

2.2实现

①导出对象加入注解

  1. @Data
  2. public class PersonExportVo implements Serializable {
  3.     @Excel(name = "编号")
  4.     private Integer id;
  5.     @Excel(name = "姓名")
  6.     private String name;
  7.     @Excel(name = "出生日期")
  8.     private Date birth;
  9. }

②工具类（网上搜的，下面的都使用这个工具类）

  1. package com.gao.booteasypoi.utils;
  3. import cn.afterturn.easypoi.excel.ExcelExportUtil;
  4. import cn.afterturn.easypoi.excel.ExcelImportUtil;
  5. import cn.afterturn.easypoi.excel.entity.ExportParams;
  6. import cn.afterturn.easypoi.excel.entity.ImportParams;
  7. import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;
  8. import org.apache.commons.lang3.StringUtils;
  9. import org.apache.poi.ss.usermodel.Workbook;
  10. import org.springframework.web.multipart.MultipartFile;
  12. import javax.servlet.http.HttpServletResponse;
  13. import java.io.File;
  14. import java.io.IOException;
  15. import java.io.InputStream;
  16. import java.net.URLEncoder;
  17. import java.util.List;
  18. import java.util.Map;
  19. import java.util.NoSuchElementException;
  21. public class ExcelUtils {
  22.     /**
  23.      * excel 导出
  24.      *
  25.      * @param list           数据
  26.      * @param title          标题
  27.      * @param sheetName      sheet名称
  28.      * @param pojoClass      pojo类型
  29.      * @param fileName       文件名称
  30.      * @param isCreateHeader 是否创建表头
  31.      * @param response
  32.      */
  33.     public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName, boolean isCreateHeader, HttpServletResponse response) throws IOException {
  34.         ExportParams exportParams = new ExportParams(title, sheetName, ExcelType.XSSF);
  35.         exportParams.setCreateHeadRows(isCreateHeader);
  36.         defaultExport(list, pojoClass, fileName, response, exportParams);
  37.     }
  39.     /**
  40.      * excel 导出
  41.      *
  42.      * @param list      数据
  43.      * @param title     标题
  44.      * @param sheetName sheet名称
  45.      * @param pojoClass pojo类型
  46.      * @param fileName  文件名称
  47.      * @param response
  48.      */
  49.     public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName, HttpServletResponse response) throws IOException {
  50.         defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName, ExcelType.XSSF));
  51.     }
  53.     /**
  54.      * excel 导出
  55.      *
  56.      * @param list         数据
  57.      * @param pojoClass    pojo类型
  58.      * @param fileName     文件名称
  59.      * @param response
  60.      * @param exportParams 导出参数
  61.      */
  62.     public static void exportExcel(List<?> list, Class<?> pojoClass, String fileName, ExportParams exportParams, HttpServletResponse response) throws IOException {
  63.         defaultExport(list, pojoClass, fileName, response, exportParams);
  64.     }
  66.     /**
  67.      * excel 导出
  68.      *
  69.      * @param list     数据
  70.      * @param fileName 文件名称
  71.      * @param response
  72.      */
  73.     public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response) throws IOException {
  74.         defaultExport(list, fileName, response);
  75.     }
  77.     /**
  78.      * 默认的 excel 导出
  79.      *
  80.      * @param list         数据
  81.      * @param pojoClass    pojo类型
  82.      * @param fileName     文件名称
  83.      * @param response
  84.      * @param exportParams 导出参数
  85.      */
  86.     private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) throws IOException {
  87.         Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);
  88.         downLoadExcel(fileName, response, workbook);
  89.     }
  91.     /**
  92.      * 默认的 excel 导出
  93.      *
  94.      * @param list     数据
  95.      * @param fileName 文件名称
  96.      * @param response
  97.      */
  98.     private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) throws IOException {
  99.         Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
  100.         downLoadExcel(fileName, response, workbook);
  101.     }
  103.     /**
  104.      * 下载
  105.      *
  106.      * @param fileName 文件名称
  107.      * @param response
  108.      * @param workbook excel数据
  109.      */
  110.     private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) throws IOException {
  111.         try {
  112.             response.setCharacterEncoding("UTF-8");
  113.             response.setHeader("content-Type", "application/vnd.ms-excel");
  114.             response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName + "." + ExcelTypeEnum.XLSX.getValue(), "UTF-8"));
  115.             workbook.write(response.getOutputStream());
  116.         } catch (Exception e) {
  117.             throw new IOException(e.getMessage());
  118.         }
  119.     }
  121.     /**
  122.      * excel 导入
  123.      *
  124.      * @param filePath   excel文件路径
  125.      * @param titleRows  标题行
  126.      * @param headerRows 表头行
  127.      * @param pojoClass  pojo类型
  128.      * @param <T>
  129.      * @return
  130.      */
  131.     public static <T> List<T> importExcel(String filePath, Integer titleRows, Integer headerRows, Class<T> pojoClass) throws IOException {
  132.         if (StringUtils.isBlank(filePath)) {
  133.             return null;
  134.         }
  135.         ImportParams params = new ImportParams();
  136.         params.setTitleRows(titleRows);
  137.         params.setHeadRows(headerRows);
  138.         params.setNeedSave(true);
  139.         params.setSaveUrl("/excel/");
  140.         try {
  141.             return ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
  142.         } catch (NoSuchElementException e) {
  143.             throw new IOException("模板不能为空");
  144.         } catch (Exception e) {
  145.             throw new IOException(e.getMessage());
  146.         }
  147.     }
  149.     /**
  150.      * excel 导入
  151.      *
  152.      * @param file      excel文件
  153.      * @param pojoClass pojo类型
  154.      * @param <T>
  155.      * @return
  156.      */
  157.     public static <T> List<T> importExcel(MultipartFile file, Class<T> pojoClass) throws IOException {
  158.         return importExcel(file, 1, 1, pojoClass);
  159.     }
  161.     /**
  162.      * excel 导入
  163.      *
  164.      * @param file       excel文件
  165.      * @param titleRows  标题行
  166.      * @param headerRows 表头行
  167.      * @param pojoClass  pojo类型
  168.      * @param <T>
  169.      * @return
  170.      */
  171.     public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass) throws IOException {
  172.         return importExcel(file, titleRows, headerRows, false, pojoClass);
  173.     }
  175.     /**
  176.      * excel 导入
  177.      *
  178.      * @param file       上传的文件
  179.      * @param titleRows  标题行
  180.      * @param headerRows 表头行
  181.      * @param needVerfiy 是否检验excel内容
  182.      * @param pojoClass  pojo类型
  183.      * @param <T>
  184.      * @return
  185.      */
  186.     public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, boolean needVerfiy, Class<T> pojoClass) throws IOException {
  187.         if (file == null) {
  188.             return null;
  189.         }
  190.         try {
  191.             return importExcel(file.getInputStream(), titleRows, headerRows, needVerfiy, pojoClass);
  192.         } catch (Exception e) {
  193.             throw new IOException(e.getMessage());
  194.         }
  195.     }
  197.     /**
  198.      * excel 导入
  199.      *
  200.      * @param inputStream 文件输入流
  201.      * @param titleRows   标题行
  202.      * @param headerRows  表头行
  203.      * @param needVerfiy  是否检验excel内容
  204.      * @param pojoClass   pojo类型
  205.      * @param <T>
  206.      * @return
  207.      */
  208.     public static <T> List<T> importExcel(InputStream inputStream, Integer titleRows, Integer headerRows, boolean needVerfiy, Class<T> pojoClass) throws IOException {
  209.         if (inputStream == null) {
  210.             return null;
  211.         }
  212.         ImportParams params = new ImportParams();
  213.         params.setTitleRows(titleRows);
  214.         params.setHeadRows(headerRows);
  215.         params.setSaveUrl("/excel/");
  216.         params.setNeedSave(true);
  217.         params.setNeedVerfiy(needVerfiy);
  218.         try {
  219.             return ExcelImportUtil.importExcel(inputStream, pojoClass, params);
  220.         } catch (NoSuchElementException e) {
  221.             throw new IOException("excel文件不能为空");
  222.         } catch (Exception e) {
  223.             throw new IOException(e.getMessage());
  224.         }
  225.     }
  227.     /**
  228.      * Excel 类型枚举
  229.      */
  230.     enum ExcelTypeEnum {
  231.         XLS("xls"), XLSX("xlsx");
  232.         private String value;
  234.         ExcelTypeEnum(String value) {
  235.             this.value = value;
  236.         }
  238.         public String getValue() {
  239.             return value;
  240.         }
  242.         public void setValue(String value) {
  243.             this.value = value;
  244.         }
  245.     }
  246. }

③Controller层代码

  1.  @GetMapping(value = "/export")
  2.     public void exportExcel(HttpServletResponse response) {
  3.         //初始化数据
  4.         List<PersonExportVo> personList = new ArrayList<>();
  5.         for (int i = 0; i < 5; i++) {
  6.             PersonExportVo personVo = new PersonExportVo();
  7.             personVo.setName("张三" + i);
  8.             personVo.setId(i);
  9.             personVo.setBirth(new Date());
  10.             personList.add(personVo);
  11.         }
  12.         try {
  13.             ExcelUtils.exportExcel(personList, "员工信息表", "员工信息", PersonExportVo.class, "员工信息", response);
  14.         } catch (IOException e) {
  15.             e.printStackTrace();
  16.         }
  17.     }

3.实例二（日期格式化）

3.1需求

针对实例一中的日期时间需要格式化。
image.png ===>image.png

3.2代码

  1. @Data
  2. public class PersonExportVo implements Serializable {
  3.     @Excel(name = "编号")
  4.     private Integer id;
  5.     @Excel(name = "姓名")
  6.     private String name;
  7.     @Excel(name = "出生日期",format = "yyyy-MM-dd HH:mm:ss")
  8.     private Date birth;
  9. }

3.3扩展

①数字的格式化使用 numformat
②每一列的单元格宽度使用 width设置

4.实例三

4.1需求

①将对象种某个字段不导出
②列顺序排列
③对于一个状态信息，后端只保存1，2，3这样的标识，所以我需要导出对应的 具体状态描述