前后端分离下EasyExcel的使用

缠丝猫  论坛元老 | 2023-3-17 14:39:55 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 1011|帖子 1011|积分 3033

前后端分离下EasyExcel的使用

项目环境:SpringBoot+Vue
依赖导入
  1. <dependency>
  2.     <groupId>com.alibaba</groupId>
  3.     <artifactId>easyexcel</artifactId>
  4.     <version>3.0.2</version>
  5. </dependency>
复制代码
tips
3.0.1版本 @ColumnWidth失效问题 用其他版本即可
实体类关联Excel

@ExcelProperty：value属性可用来设置表头名称
@ExcelPropertyvalue属性可用来设置表头名称
点击查看代码
  1. @TableName(value = "five_insurances")
  2. @Data
  3. public class FiveInsurances implements Serializable {
  4.     /**
  5.      *
  6.      */
  7.     @ExcelProperty("编号")
  8.     @ColumnWidth(10)
  9.     @TableId(value = "id", type = IdType.AUTO)
  10.     private Integer id;
  12.     /**
  13.      * 工号
  14.      */
  15.     @ExcelProperty("工号")
  16.     @ColumnWidth(15)
  17.     @TableField(value = "number")
  18.     private String number;
  20.     /**
  21.      * 姓名
  22.      */
  23.     @ExcelProperty("姓名")
  24.     @ColumnWidth(20)
  25.     @TableField(value = "name")
  26.     private String name;
  28.     /**
  29.      * 部门id
  30.      */
  31.     @ExcelProperty("部门")
  32.     @ColumnWidth(20)
  33.     @TableField(value = "dept_id")
  34.     private Integer deptId;
  36.     /**
  37.      * 电话
  38.      */
  39.     @ExcelProperty("电话")
  40.     @ColumnWidth(20)
  41.     @TableField(value = "phone")
  42.     private String phone;
  44.     /**
  45.      * 缴纳基数
  46.      */
  47.     @ExcelProperty({"社保", "缴纳基数"})
  48.     @ColumnWidth(20)
  49.     @TableField(value = "base_payment")
  50.     private String basePayment;
  52.     /**
  53.      * 个人缴纳
  54.      */
  55.     @ExcelProperty({"社保", "个人", "缴纳费用"})
  56.     @ColumnWidth(20)
  57.     @TableField(value = "self_payment")
  58.     private String selfPayment;
  60.     /**
  61.      * 工伤保险缴纳比例
  62.      */
  63.     @ExcelProperty({"社保", "企业", "工伤保险缴纳比例"})
  64.     @ColumnWidth(20)
  65.     @TableField(value = "ratio")
  66.     private String ratio;
  68.     /**
  69.      * 企业缴纳
  70.      */
  71.     @ExcelProperty({"社保", "企业", "缴纳费用"})
  72.     @ColumnWidth(20)
  73.     @TableField(value = "com_payment")
  74.     private String comPayment;
  76.     /**
  77.      * 备注
  78.      */
  79.     @ExcelProperty({"社保", "备注"})
  80.     @ColumnWidth(30)
  81.     @TableField(value = "remarks")
  82.     private String remarks;
  84.     @ExcelIgnore
  85.     @TableField(exist = false)
  86.     private Dept dept;
  88.     @ExcelIgnore
  89.     @TableField(exist = false)
  90.     private static final long serialVersionUID = 1L;
  91. }
复制代码
导出Excel

Controller
  1. @GetMapping("/fihf")
  2. @ApiOperation(value = "导出五险一金列表Excel")
  3. @ApiImplicitParams(
  4.             @ApiImplicitParam(dataType = "Interger",name = "page",value = "page==-1:查询所有;page==-2,返回空模板",required = false)
  5.     )
  6. public void exportList(HttpServletResponse response, @RequestParam(value = "page", defaultValue = "1") Integer page) throws Exception {
  7.         PageBean<List<FiveInsurances>> pageBean = fiveInsurancesService.selectFiveInsurancesList(page);
  8.         ExcelUtils.exportToWeb(response,"sheet1",FiveInsurances.class,pageBean.getData());
  9.     }
复制代码
前端Axios请求
  1. exportFile(page = this.pageBean.current) {
  2.     //复选框选中则设置page为-1,表示导出全部
  3.     if (this.checked) {
  4.         page = -1;
  5.     }
  6.     //关闭对话框
  7.     this.dialogVisible = false;
  8.     this.axios({
  9.         method: 'get',
  10.         url: baseURL + "fileExport/fihf",
  11.         params: {
  12.             page: page,
  13.         },
  14.         responseType: 'blob' //响应类型须设置为二进制文件流
  15.     }).then((res) => {
  16.         if (!res) {
  17.             return
  18.         }
  19.         const link = document.createElement("a");//创建a标签
  20.         let blob = new Blob([res.data], { type: "multipart/form-data" }); //设置文件类型
  21.         link.style.display = "none";
  22.         let url = URL.createObjectURL(blob);
  23.         link.href = url; //给a标签href属性赋值
  24.         link.setAttribute("download", decodeURI(Date.now() + '.xlsx'));
  25.         document.body.appendChild(link);//挂载a标签
  26.         link.click();//a标签click事件
  27.         document.body.removeChild(link); //移除a标签
  28.         window.URL.revokeObjectURL(url); //销毁下载链接
  30.         console.log(res);
  31.         this.checked = false;
  32.         return this.$message.success("导出报表数据成功!")
  33.     })
  34. },
复制代码
导入Excel

Controller
  1. @PostMapping("/fihf")
  2. @ApiOperation(value = "导入五险一金列表Excel")
  3. public ResultVO<FiveInsurances> FiveInsurances(@RequestPart("file") MultipartFile file) throws IOException {
  4.     if (file.getSize() < 0) {
  5.         return ResultVO.createFail(404, "导入数据失败");
  6.     }
  7.     List<FiveInsurances> list = ExcelUtils.importFile(file, FiveInsurances.class);
  9.     //持久化到数据库
  10.     int i = fiveInsurancesService.insertBatch(list);
  11.     if (i > 0) {
  12.         return ResultVO.createSuccess("读取excel成功", null);
  13.     } else {
  14.         return ResultVO.createFail();
  15.     }
  16. }
复制代码
前端Axios请求
  1. handleBeforUpload(file) {
  2.     console.log("beforeUpload", file);
  3.     //创建文件附件
  4.     let formData = new FormData();
  5.     //添加到formdata
  6.     formData.append("file", file);
  7.     this.axios({
  8.         method: 'post',
  9.         url: baseURL + "fileImport/fihf",
  10.         data: formData,
  11.         Headers: {
  12.             "Content-Type": "multipart/form-data",
  13.         }
  14.     }).then((res) => {
  15.         console.log("读取excel", res);
  16.         if (res.data.data == 10000) {
  17.             this.$message.success(res.data.msg)
  18.         }
  19.     })
  20. },
复制代码
Excel导入导出工具类

点击查看代码
  1. package com.self.salarymanagement.utils;
  3. import com.alibaba.excel.EasyExcel;
  4. import com.alibaba.excel.support.ExcelTypeEnum;
  5. import lombok.extern.slf4j.Slf4j;
  6. import org.apache.poi.util.IOUtils;
  7. import org.springframework.web.multipart.MultipartFile;
  9. import javax.servlet.ServletOutputStream;
  10. import javax.servlet.http.HttpServletResponse;
  11. import java.io.File;
  12. import java.io.FileInputStream;
  13. import java.io.IOException;
  14. import java.io.UnsupportedEncodingException;
  15. import java.net.URLEncoder;
  16. import java.util.List;
  18. /**
  19. * Excel工具类
  20. */
  21. @Slf4j
  22. public class ExcelUtils {
  24.     /**
  25.      * 导出Excel到指定路径下
  26.      *
  27.      * @param path      路径
  28.      * @param excelName Excel名称
  29.      * @param sheetName sheet页名称
  30.      * @param clazz     Excel要转换的类型
  31.      * @param data      要导出的数据
  32.      */
  33.     public static void exportFileToLocal(String path, String excelName, String sheetName, Class clazz, List data) {
  34.         String fileName = path.concat(excelName).concat(ExcelTypeEnum.XLSX.getValue());
  35.         EasyExcel.write(fileName, clazz).sheet(sheetName).doWrite(data);
  36.     }
  38.     /**
  39.      * 导出Excel到web
  40.      *
  41.      * @param response  响应
  42.      * @param sheetName sheet页名称
  43.      * @param clazz     Excel要转换的类型
  44.      * @param data      要导出的数据
  45.      * @throws Exception
  46.      */
  47.     public static void exportToWeb(HttpServletResponse response, String sheetName, Class clazz, List data) throws Exception {
  48. //        response.setContentType("application/vnd.ms-excel");
  49.         response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
  50.         response.setCharacterEncoding("utf-8");
  51.         // 这里URLEncoder .encode可以防止中文乱码
  52.         String excelName = URLEncoder.encode(String.valueOf(System.currentTimeMillis()), "UTF-8");
  53.         response.setHeader("Content-disposition", "attachment;filename=" + excelName + ExcelTypeEnum.XLSX.getValue());
  54.         EasyExcel.write(response.getOutputStream(), clazz).excelType(ExcelTypeEnum.XLSX).sheet(sheetName).doWrite(data);
  55.     }
  57.     /**
  58.      * 导出Excel到web
  59.      *
  60.      * @param response  响应
  61.      * @param excelName Excel名称
  62.      * @param sheetName sheet页名称
  63.      * @param clazz     Excel要转换的类型
  64.      * @param data      要导出的数据
  65.      * @throws Exception
  66.      */
  67.     public static void exportToWeb(HttpServletResponse response, String excelName, String sheetName, Class clazz, List data) throws Exception {
  68. //        response.setContentType("application/vnd.ms-excel");
  69.         response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
  70.         response.setCharacterEncoding("utf-8");
  71.         // 这里URLEncoder.encode可以防止中文乱码
  72.         excelName = URLEncoder.encode(excelName, "UTF-8");
  73.         response.setHeader("Content-disposition", "attachment;filename=" + excelName + ExcelTypeEnum.XLSX.getValue());
  74.         EasyExcel.write(response.getOutputStream(), clazz).sheet(sheetName).doWrite(data);
  75.     }
  77.     /**
  78.      * 将指定位置指定名称的Excel导出到web
  79.      *
  80.      * @param response  响应
  81.      * @param path      文件路径
  82.      * @param excelName 文件名称
  83.      * @throws UnsupportedEncodingException
  84.      */
  85.     public static String export2Web4File(HttpServletResponse response, String path, String excelName) throws UnsupportedEncodingException {
  86.         File file = new File(path.concat(excelName).concat(ExcelTypeEnum.XLSX.getValue()));
  87.         if (!file.exists()) {
  88.             return "文件不存在！";
  89.         }
  91.         response.setContentType("application/vnd.ms-excel");
  92.         response.setCharacterEncoding("utf-8");
  93.         // 这里URLEncoder.encode可以防止中文乱码
  94.         excelName = URLEncoder.encode(excelName, "UTF-8");
  95.         response.setHeader("Content-disposition", "attachment;filename=" + excelName + ExcelTypeEnum.XLSX.getValue());
  97.         try (
  98.                 FileInputStream in = new FileInputStream(file);
  99.                 ServletOutputStream out = response.getOutputStream();
  100.         ) {
  101.             IOUtils.copy(in, out);
  102.             return "导出成功！";
  103.         } catch (Exception e) {
  104.             log.error("导出文件异常：", e);
  105.         }
  107.         return "导出失败！";
  108.     }
  110.     public static <T> List<T> importFile(MultipartFile file, Class<T> clazz) throws IOException {
  112.         return EasyExcel.read(file.getInputStream())
  113.                 .head(clazz)
  114.                 .registerReadListener(new DefaultExcelListener<T>())
  115.                 .sheet()
  116.                 .doReadSync();
  117.     }
  118. }
复制代码
Excel导入监听器
  1. import com.alibaba.excel.context.AnalysisContext;
  2. import com.alibaba.excel.event.AnalysisEventListener;
  3. import com.alibaba.excel.exception.ExcelDataConvertException;
  4. import lombok.extern.slf4j.Slf4j;
  6. import java.util.ArrayList;
  7. import java.util.List;
  9. /**
  10. * @author Liu
  11. * @create 2023-03-08-11:44
  12. * @description:
  13. */
  14. @Slf4j
  15. public class DefaultExcelListener<T> extends AnalysisEventListener<T> {
  17.     private final List<T> rows = new ArrayList<>();
  19.     /**
  20.      * 读取excel操作
  21.      *
  22.      * @param obj             数据
  23.      * @param analysisContext 上下文
  24.      */
  25.     // 每读一样，会调用该invoke方法一次
  26.     @Override
  27.     public void invoke(T obj, AnalysisContext analysisContext) {
  28.         //添加到list
  29.         rows.add(obj);
  30.         log.info("list容量" + rows.size() + obj);
  31.         /** 数据量不是特别大，可以不需要打开
  32.          // 实际数据量比较大时，rows里的数据可以存到一定量之后进行批量处理（比如存到数据库），
  33.          // 然后清空列表，以防止内存占用过多造成OOM
  34.          if(rows.size() >= 500){
  35.          log.info("存入数据库ing");
  36.          try {
  37.          Thread.sleep(3000);
  38.          } catch (InterruptedException e) {
  39.          e.printStackTrace();
  40.          }
  41.          rows.clear();
  42.          }
  43.          */
  44.     }
  46.     /**
  47.      * 读取玩excel后的操作
  48.      */
  49.     @Override
  50.     public void doAfterAllAnalysed(AnalysisContext analysisContext) {
  51.         log.info("成功读取【" + rows.size() + "】条数据");
  53.         System.out.println("================================");
  54.         rows.forEach(System.out::println);
  55.         System.out.println("================================");
  57.     }
  59.     /**
  60.      * 在读取excel异常 获取其他异常下会调用本接口。抛出异常则停止读取。如果这里不抛出异常则 继续读取下一行。
  61.      */
  62.     @Override
  63.     public void onException(Exception exception, AnalysisContext context) {
  64.         log.error("解析失败，但是继续解析下一行:{}", exception.getMessage());
  65.         if (exception instanceof ExcelDataConvertException) {
  66.             ExcelDataConvertException excelDataConvertException = (ExcelDataConvertException) exception;
  67.             log.error("第{}行，第{}列解析异常，数据为:{}", excelDataConvertException.getRowIndex(),
  68.                     excelDataConvertException.getColumnIndex(), excelDataConvertException.getCellData());
  69.         }
  70.     }
  72.     /**
  73.      * @return 返回读取的总数据
  74.      */
  75.     public List<T> getRows() {
  76.         return rows;
  77.     }
  78. }
复制代码
多级表头设置

嵌套el-table-column即可
  1. <el-table-column label="社保" width="180">
  2.     <el-table-column label="缴纳基数" width="120">
  3.         <template slot-scope="scope">
  4.             {{ scope.row.basePayment }}
  5.         </template>
  6.     </el-table-column>
  7.     <el-table-column label="个人" width="120">
  8.         <el-table-column label="缴纳费用" width="120">
  9.             <template slot-scope="scope">
  10.                 {{ scope.row.selfPayment }}
  11.             </template>
  12.         </el-table-column>
  13.     </el-table-column>
  14.     <el-table-column label="企业" width="180">
  15.         <el-table-column label="工伤保险缴纳比例" width="180">
  16.             <template slot-scope="scope">
  17.                 {{ scope.row.ratio }}
  18.             </template>
  19.         </el-table-column>
  20.         <el-table-column label="缴纳费用" width="180">
  21.             <template slot-scope="scope">
  22.                 {{ scope.row.comPayment }}
  23.             </template>
  24.         </el-table-column>
  25.     </el-table-column>
  26.     <el-table-column label="备注" width="120">
  27.         <template slot-scope="scope">
  28.             {{ scope.row.remarks }}
  29.         </template>
  30.     </el-table-column>
  31. </el-table-column>
复制代码


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

缠丝猫

论坛元老
这个人很懒什么都没写!

楼主热帖

标签云

AI 运维 CIO 存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表