devbox
笔触狂放9
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

EasyExcel 操作excel导入导出_easyexcel导出excel文件

作者：笔触狂放9 | 2024-03-27 03:15:59

赞

踩

easyexcel导出excel文件

目录

1、核心依赖

2、导出

前端:一个小页面

后端 

实体类

controller 

dao.xml

sql

效果

导入

前端

后端

实体类(加校验注解)

controller

util包

dao.xml

效果

1、核心依赖

  1. 		<!-- easyExcel -->
  2. 		<dependency>
  3. 			<groupId>com.alibaba</groupId>
  4. 			<artifactId>easyexcel</artifactId>
  5. 			<version>2.2.6</version>
  6. 		</dependency>

2、导出

前端:一个小页面

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>excel导入导出</title>
  6.     <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
  7.  
  8. </head>
  9. <body>
  10.  
  11. <button id="easyExcelBtn" type="button" >
  12.     下载列表数据easyExcel
  13. </button>
  14.  
  15.  
  16. <script>
  17.    
  18.     /**
  19.      * easyExce导出
  20.      */
  21.     //给"批量导出"按钮添加单击事件
  22.     $("#easyExcelBtn").click(function () {
  23.         //发送同步请求
  24.         window.location.href="easyExcel/write";
  25.     });
  26.  
  27.    
  28. </script>
  29.  
  30. </body>
  31. </html>

后端 

实体类

  1.  
  2. /**
  3.  * 校验
  4.  */
  5. @Data
  6. @NoArgsConstructor
  7. @AllArgsConstructor
  8. public class EasySysUser {
  9.  
  10.     //
  11.     @ExcelProperty("用户账号")
  12.     private String  userName;
  13.  
  14.     @ExcelProperty("用户昵称")
  15.     private String  nickName;
  16.  
  17.     @ExcelProperty("用户邮箱")
  18.     private String  email;
  19.  
  20.     @ExcelProperty("手机号码")
  21.     private String  phonenumber;
  22.  
  23.     @ExcelProperty("用户性别")
  24.     private Integer sex;
  25.  
  26.     @ExcelProperty("帐号状态（0正常 1停用）")
  27.     private Integer  status;
  28.  
  29.    
  30.     /**
  31.      * 忽略这个字段
  32.      * @ExcelIgnore
  33.      */
  34.     @ExcelProperty("删除标志（0代表存在 2代表删除）")
  35.     private Integer  delFlag;
  36.  
  37. }

controller 

为了方便我就把代码业务都写这了。

 

  1. @Autowired
  2.     ExcelService excelService;
  3.  
  4.     @GetMapping("easyExcel/write")
  5.     public void easyExcelWrite(HttpServletResponse response){
  6.  
  7.  
  8.         //查询到数据库中的数据
  9.         List<EasySysUser> users = excelService.poiExcelWrite();
  10.  
  11.  
  12.         OutputStream outputStream = null;
  13.         try {
  14.  
  15.             String fileName = URLEncoder.encode("用户表", StandardCharsets.UTF_8.name());//文件名
  16.  
  17.             response.setContentType("application/octet-stream;charset=UTF-8");
  18.             response.setCharacterEncoding("utf-8");
  19.             response.addHeader("Content-Disposition", "attachment;filename*=utf-8''" + fileName + ".xls");
  20.             outputStream = response.getOutputStream();
  21.  
  22.             //                  流  , 数据类型                   表               数据
  23.             EasyExcel.write(outputStream, EasySysUser.class).sheet("1").doWrite(users);
  24.  
  25.         } catch (IOException e) {
  26.             e.printStackTrace();
  27.         } finally {
  28.             if (outputStream != null) {
  29.                 try {
  30.                     outputStream.flush();//刷新流：通道中数据全部输出
  31.                     outputStream.close();//关闭流
  32.                 } catch (IOException e) {
  33.                     e.printStackTrace();
  34.                 }
  35.             }
  36.         }
  37.  
  38.     }

dao.xml

  1.     <select id="poiExcelWrite" resultType="com.zoubin.easyexcel.web.entity.EasySysUser">
  2.         SELECT user_name username,nick_name nickname,email,phonenumber,sex,status,del_flag delflag from sys_user;
  3.     </select>

sql

  1. CREATE TABLE `sys_user` (
  2.   `user_id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '用户ID',
  3.   `dept_id` bigint(20) DEFAULT NULL COMMENT '部门ID',
  4.   `user_name` varchar(30) NOT NULL COMMENT '用户账号',
  5.   `nick_name` varchar(30) NOT NULL COMMENT '用户昵称',
  6.   `user_type` varchar(2) DEFAULT '00' COMMENT '用户类型（00系统用户）',
  7.   `email` varchar(50) DEFAULT '' COMMENT '用户邮箱',
  8.   `phonenumber` varchar(11) DEFAULT '' COMMENT '手机号码',
  9.   `sex` char(1) DEFAULT '0' COMMENT '用户性别（0男 1女 2未知）',
  10.   `avatar` varchar(100) DEFAULT '' COMMENT '头像地址',
  11.   `password` varchar(100) DEFAULT '' COMMENT '密码',
  12.   `status` char(1) DEFAULT '0' COMMENT '帐号状态（0正常 1停用）',
  13.   `del_flag` char(1) DEFAULT '0' COMMENT '删除标志（0代表存在 2代表删除）',
  14.   `login_ip` varchar(128) DEFAULT '' COMMENT '最后登录IP',
  15.   `login_date` datetime DEFAULT NULL COMMENT '最后登录时间',
  16.   `create_by` varchar(64) DEFAULT '' COMMENT '创建者',
  17.   `create_time` datetime DEFAULT NULL COMMENT '创建时间',
  18.   `update_by` varchar(64) DEFAULT '' COMMENT '更新者',
  19.   `update_time` datetime DEFAULT NULL COMMENT '更新时间',
  20.   `remark` varchar(500) DEFAULT NULL COMMENT '备注',
  21.   PRIMARY KEY (`user_id`)
  22. ) ENGINE=InnoDB AUTO_INCREMENT=158 DEFAULT CHARSET=utf8 COMMENT='用户信息表'

效果

 

 

导入

前端

  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>excel导入导出</title>
  6.     <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
  7.  
  8. </head>
  9. <body>
  10.  
  11. <button id="easyExcelBtn" type="button" >
  12.     下载列表数据easyExcel
  13. </button>
  14.  
  15. <hr/>
  16. <!-- 导入市场活动的模态窗口 -->
  17. <div class="modal fade" id="importActivityModal3" role="dialog">
  18.     <div class="modal-dialog" role="document" style="width: 85%;">
  19.         <div class="modal-content">
  20.             <div class="modal-header">
  21.                 <h4 class="modal-title" id="myModalLabel3">导入EasyExcel校验测试</h4>
  22.             </div>
  23.             <div class="modal-body" style="height: 350px;">
  24.                 <div style="position: relative;top: 20px; left: 50px;">
  25.                     请选择要上传的文件：<small style="color: gray;">[仅支持.xls]</small>
  26.                 </div>
  27.                 <div style="position: relative;top: 40px; left: 50px;">
  28.                     <input type="file" id="activityFile3">
  29.                 </div>
  30.                 <div style="position: relative;top: 60px; left: 50px;">
  31.                     <button id="importActivityBtn3" type="button" class="btn btn-primary">导入</button>
  32.                 </div>
  33.             </div>
  34.  
  35.         </div>
  36.     </div>
  37. </div>
  38.  
  39.  
  40. <script>
  41.  
  42.     /**
  43.      * easyExce导出
  44.      */
  45.     //给"批量导出"按钮添加单击事件
  46.     $("#easyExcelBtn").click(function () {
  47.         //发送同步请求
  48.         window.location.href="easyExcel/write";
  49.     });
  50.  
  51.    
  52.     /**
  53.      * EasyExcel导入 校验
  54.      */
  55.     //给"导入"按钮添加单击事件
  56.     $("#importActivityBtn3").click(function () {
  57.         //收集参数
  58.         //——xls文件获取的是文件名
  59.         var activityFileName=$("#activityFile3").val();
  60.         var suffix=activityFileName.substr(activityFileName.lastIndexOf(".")+1).toLocaleLowerCase();//xls,XLS,Xls,xLs,....截取字符串后缀，toLocaleLowerCase()：转小写
  61.         if(suffix!="xls"){
  62.             alert("只支持xls文件");
  63.             return;
  64.         }
  65.         //——获取文件内容
  66.         var activityFile=$("#activityFile3")[0].files[0];
  67.         //if(activityFile.size>5*1024*1024){//activityFile.size：获取文件大小
  68.         //    alert("文件大小不超过5MB");
  69.         //    return;
  70.         //}
  71.  
  72.         //FormData是ajax提供的接口,可以模拟键值对向后台提交参数;
  73.         //FormData最大的优势是不但能提交文本数据，还能提交二进制数据
  74.         var formData=new FormData();
  75.         formData.append("activityFile",activityFile);
  76.  
  77.         //发送请求
  78.         $.ajax({
  79.             url:'/EasyExcel/readCheck',
  80.             data:formData,
  81.             processData:false,//设置ajax向后台提交参数之前，是否把参数统一转换成字符串：true--是,false--不是,默认是true
  82.             contentType:false,//设置ajax向后台提交参数之前，是否把所有的参数统一按urlencoded编码：true--是,false--不是，默认是true
  83.             type:'post',
  84.             dataType:'json',
  85.             success:function (data) {
  86.                 if(data.code=="1"){
  87.                     //提示成功导入记录条数
  88.                     alert("成功导入"+data.retData+"条记录");
  89.                     //关闭模态窗口
  90.                     $("#importActivityModal3").modal("hide");
  91.                 }else{
  92.                     //提示信息
  93.                     alert(data.message);
  94.                     //模态窗口不关闭
  95.                     $("#importActivityModal3").modal("show");
  96.                 }
  97.             }
  98.         });
  99.     });
  100.  
  101.  
  102. </script>
  103.  
  104. </body>
  105. </html>

后端

实体类(加校验注解)

  1. package com.zoubin.easyexcel.web.entity;
  2.  
  3. import com.alibaba.excel.annotation.ExcelProperty;
  4. import lombok.AllArgsConstructor;
  5. import lombok.Data;
  6. import lombok.NoArgsConstructor;
  7.  
  8. import javax.validation.constraints.Email;
  9. import javax.validation.constraints.NotEmpty;
  10.  
  11. /**
  12.  * 校验
  13.  */
  14. @Data
  15. @NoArgsConstructor
  16. @AllArgsConstructor
  17. public class EasySysUser {
  18.  
  19.     @NotEmpty(message = "用户名称不能为空")
  20.     @ExcelProperty("用户账号")
  21.     private String  userName;
  22.  
  23.     @NotEmpty(message = "用户昵称不能为空")
  24.     @ExcelProperty("用户昵称")
  25.     private String  nickName;
  26.  
  27.     //    @Pattern(regexp="[a-za-z0-9._%+-]+@[a-za-z0-9.-]+\\.[a-za-z]{2,4}", message="邮件格式错误")
  28.     @Email(message = "邮箱格式不正确")
  29.     @ExcelProperty("用户邮箱")
  30.     private String  email;
  31.  
  32.     @NotEmpty(message = "手机号码不能为空")
  33.     @ExcelProperty("手机号码")
  34.     private String  phonenumber;
  35.  
  36.     @ExcelProperty("用户性别")
  37.     private Integer sex;
  38.  
  39.     @ExcelProperty("帐号状态（0正常 1停用）")
  40.     private Integer  status;
  41.  
  42.     @ExcelProperty("删除标志（0代表存在 2代表删除）")
  43.     /**
  44.      * 忽略这个字段
  45.      * @ExcelIgnore
  46.      */
  47.     private Integer  delFlag;
  48.  
  49. }

controller

  1.  /**
  2.      * 导入
  3.      * 数据校验并返回错误
  4.      * @param activityFile
  5.      * @return
  6.      */
  7.     @PostMapping("/EasyExcel/readCheck")
  8.     @ResponseBody
  9.     public Object easyExcelReadCheck(MultipartFile activityFile) {
  10.  
  11.  
  12.         ReturnObject returnObject = new ReturnObject();//响应数据
  13.         InputStream inputStream = null;
  14.         try {
  15.             //获取文件流
  16.             inputStream = activityFile.getInputStream();
  17.  
  18.             // 这里 需要指定读用哪个class去读，然后读取第一个sheet 文件流会自动关闭
  19.             UserListener userListener = new UserListener();
  20.             //             流           数据类型             导入数据监听器
  21.             EasyExcel.read(inputStream, EasySysUser.class, userListener).sheet().doRead();
  22.  
  23.             //获取监听收集的数据
  24.             List<EasySysUser> dataList = userListener.getDataList();
  25.  
  26.             //文件中有数据
  27.             if (!dataList.isEmpty()){
  28.  
  29.                 //进行数据校验
  30.                 List<String> valid = ValidationUtil02.valid(dataList);
  31.                 if (!valid.isEmpty()){//校验不为空就说明有错误数据
  32.                     for (String s:valid){
  33.                         System.out.println(s);//打印错误
  34.                     }
  35.                     //向前端返回错误信息
  36.                     returnObject.setCode("500");//失败
  37.                     returnObject.setMessage(valid.toString());
  38.                     return returnObject;
  39.                 }
  40.             }else {
  41.                 return null;
  42.             }
  43.  
  44.             //没有问题调用service层方法，保存用户
  45.             int ret = excelService.saveUsers(dataList);
  46.  
  47.             returnObject.setCode("1");//成功
  48.             returnObject.setRetData(ret);
  49.         } catch (IOException e) {
  50.             e.printStackTrace();
  51.             returnObject.setCode("500");//失败
  52.             returnObject.setMessage("系统忙，请稍后重试....");
  53.         } finally {
  54.             if (inputStream != null) {
  55.                 try {
  56.                     inputStream.close();//关闭流
  57.                 } catch (IOException e) {
  58.                     e.printStackTrace();
  59.                 }
  60.             }
  61.         }
  62.  
  63.         return returnObject;
  64.  
  65.     }

util包

ReturnObject ：返回响应信息

  1. @Data
  2. public class ReturnObject {
  3.  
  4.     private String code;//返回的编码
  5.     private String message;//返回的提示信息
  6.     private Integer retData;//返回条数
  7. }

 UserListener ：EasyExcel导入监听器,获取导入数据

  1. @Component
  2. public class UserListener extends AnalysisEventListener<EasySysUser> {
  3.  
  4.     //保存数据
  5.     List<EasySysUser> dataList = new ArrayList<>();;
  6.  
  7.     //读取表头的内容
  8.     @Override
  9.     public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
  10. //        System.out.println("表头->"+headMap);
  11.     }
  12.     //一行一行读取excel中的内容
  13.     @Override
  14.     public void invoke(EasySysUser user, AnalysisContext context) {
  15.         dataList.add(user);
  16.     }
  17.     //读取完成之后执行的方法
  18.     @Override
  19.     public void doAfterAllAnalysed(AnalysisContext context) {
  20.  
  21.     }
  22.  
  23.     public List<EasySysUser> getDataList() {
  24.         return dataList;
  25.     }
  26. }

 ValidationUtil02 : 数据校验工具类

  1.  
  2. /**
  3.  * 数据校验工具
  4.  */
  5. public class ValidationUtil02 {
  6.  
  7.     //校验对象（线程安全）
  8.     static Validator validator;
  9.  
  10.     //初始化
  11.     static {
  12.         validator = Validation.buildDefaultValidatorFactory().getValidator();
  13.     }
  14.  
  15.  
  16.     //校验方法 
  17.     public static List<String>  valid(List<EasySysUser> value){
  18.  
  19.         //校验错误信息
  20.         List<String>  errorResult = new ArrayList<>();
  21.         //初始行数
  22.         int row = 2;
  23.  
  24.         for (EasySysUser user : value){
  25.  
  26.             //如果没有校验通过，就会有校验信息
  27.             Set<ConstraintViolation<Object>> validate = validator.validate(user);// 进行校验
  28.  
  29.             if (!validate.isEmpty()){
  30.                 int finalRow = row;
  31.                 List<String> collect = validate.stream().map(v ->
  32.                         "第"+ finalRow +"行--"+
  33.                                 "属性：" + v.getPropertyPath() +
  34.                                 "，属性的值：" + v.getInvalidValue() +
  35.                                 "，校验不通过的提示信息:" + v.getMessage())
  36.                         .collect(Collectors.toList());
  37.  
  38.                 errorResult.add(collect.toString());
  39.             }
  40.             ++row;
  41.         }
  42.         return errorResult;
  43.  
  44.     }
  45.  
  46. //    //测试
  47. //    public static void main(String[] args) {
  48. //        EasySysUserCheck user = new EasySysUserCheck();
  49. //        user.setNickName("你好");
  50. //        List<String> valid = ValidationUtil.valid(user);
  51. //        System.out.println(valid);
  52. //
  53. //
  54. //    }
  55.  
  56. }
  57.  
  58.

dao.xml

  1.     <insert id="saveUsers">
  2.         insert into sys_user(user_name,nick_name,email,phonenumber,sex,status,del_flag)
  3.         values
  4.         <foreach collection="list" item="obj" separator=",">
  5.             (#{obj.userName},#{obj.nickName},#{obj.email},#{obj.phonenumber},#{obj.sex},#{obj.status},#{obj.delFlag})
  6.         </foreach>
  7.     </insert>

效果

错误数据

 

选择文件进行导入

 

 

 

准备正确数据

 

 

 本文还是有许多不足的，欢迎指正。

 可以试着去进行优化，提高拓展和复用性。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/笔触狂放9/article/detail/321570?site
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号