码农知识堂 - 1000bd
  •   Python
  •   PHP
  •   JS/TS
  •   JAVA
  •   C/C++
  •   C#
  •   GO
  •   Kotlin
  •   Swift

  • SpringBoot集成EasyExcel快速人们

    目录

    1.背景介绍

    2.EasyExcel的使用

    1.添加依赖

    2.相关代码准备

    1.实体类

    2.ExcelUtil工具类

    3.写入控制类

    1.背景介绍

            EasyExcel 是阿里巴巴开发的一款基于 Java 的专业化 Excel 操作工具，主要用于在 Java 应用程序中快速、高效地读写 Excel 文件。EasyExcel 提供了简单易用的 API，使开发人员可以轻松地处理 Excel 文件，包括读取数据、写入数据、格式化等操作。

            像前面文章中提到的Apache POI也是一个用于操作Excel的API，当然同时能操作Word、PPT这样的Microsoft Ofiice文档，EasyExcel 是一个基于 Apache POI 封装的 Java Excel 操作工具库，它简化了使用 Apache POI 进行 Excel 文件读写操作的复杂性，提供了更加简洁易用的 API 接口。EasyExcel 在底层仍然依赖于 Apache POI 库来实现 Excel 文件的读写功能，但通过封装和优化，使得开发者能够更方便地处理 Excel 文件，减少了编码量。

            它在保留 Apache POI 功能的基础上，提供了更高层次的抽象和更友好的接口，使得开发者能够更快速地实现 Excel 文件的读写操作，降低了学习成本和开发难度。

    2.EasyExcel的使用

    1.添加依赖
    1.         <dependency>
    2.             <groupId>com.alibabagroupId>
    3.             <artifactId>easyexcelartifactId>
    4.             <version>3.0.5version>
    5.         dependency>

    2.相关代码准备

    1.实体类
    1. import com.alibaba.excel.annotation.ExcelProperty;
    2. import io.swagger.annotations.ApiModel;
    3. import io.swagger.annotations.ApiModelProperty;
    4.  
    5. @ApiModel("用户实体类")
    6. public class User {
    7.  
    8.     @ApiModelProperty("用户名")
    9.     @ExcelProperty(index = 0, value = "账号")
    10.     private String username;
    11.  
    12.     @ExcelProperty(index = 1, value = "密码")
    13.     @ApiModelProperty("密码")
    14.     private String password;
    15.  
    16.     public String getUsername() {
    17.         return username;
    18.     }
    19.  
    20.     public void setUsername(String username) {
    21.         this.username = username;
    22.     }
    23.  
    24.     public String getPassword() {
    25.         return password;
    26.     }
    27.  
    28.     public void setPassword(String password) {
    29.         this.password = password;
    30.     }
    31.  
    32. }

    注意:@ApiModelProperty是Swagger的注解，EasyExcel的注解是@ExcelProperty

    2.ExcelUtil工具类
    1. import com.alibaba.excel.EasyExcel;
    2. import com.alibaba.excel.context.AnalysisContext;
    3. import com.alibaba.excel.event.AnalysisEventListener;
    4. import org.springframework.stereotype.Component;
    5.  
    6. import java.util.ArrayList;
    7. import java.util.List;
    8.  
    9. @Component
    10. public class ExcelUtil {
    11.  
    12.     public void writeExcel(String filePath, List data, Class clazz) {
    13.         EasyExcel.write(filePath, clazz).sheet("Sheet1").doWrite(data);
    14.     }
    15.  
    16.     public List readExcel(String filePath, Class clazz) {
    17.         List dataList = new ArrayList<>();
    18.         EasyExcel.read(filePath, clazz, new AnalysisEventListener() {
    19.             @Override
    20.             public void invoke(Object data, AnalysisContext context) {
    21.                 dataList.add(data);
    22.             }
    23.  
    24.             @Override
    25.             public void doAfterAllAnalysed(AnalysisContext context) {
    26.                 // 解析完成后的操作
    27.             }
    28.         }).sheet().doRead();
    29.         return dataList;
    30.     }
    31. }
      32.  

      如果不封装，则像写入Excel的代码，可以是这样：准备需要写入的路径filePath、对应的反射类以及该类的集合：
       

      1.  @GetMapping("/export")
      2.        public void export(HttpServletResponse response) throws IOException {
      3.  
      4.            List userList = userMapper.getAll();
      5.  
      6.            String filePath = "D:/zhan215/src/main/java/com/zhan/zhan215/FileStorage/账号信息2.xlsx";
      7.  
      8.            // 设置响应头信息
      9.            response.setContentType("application/vnd.ms-excel");
      10.            response.setCharacterEncoding("utf-8");
      11.            String fileName = URLEncoder.encode("账号信息2.xlsx", "UTF-8");
      12.            response.setHeader("Content-disposition", "attachment;filename=" + fileName);
      13.  
      14.            // 将数据写入 Excel 文件
      15.            ExcelWriter excelWriter = EasyExcel.write(filePath, User.class).build();
      16.  
      17.            // 创建WriteSheet对象
      18.            WriteSheet writeSheet = EasyExcel.writerSheet("账号信息").build();
      19.            // 将数据写入Excel
      20.            excelWriter.write(userList, writeSheet);
      21.  
      22.            // 关闭ExcelWriter对象
      23.            excelWriter.finish();
      24.  
      25.  
      26.        }
       

      上述代码可以先作为单元测试，确保能正常使用
       

      测试结果：
       

       

      这里的账号密码是我自定义User表，可以先随意写入
       

      3.写入控制类
       

      由于我们写好了ExcelUtil工具类，里面包含了对Excel的读和写，因此在控制类中直接调用即可：
       

      写：
       

      1.        @GetMapping("/export")
      2.        public void export(HttpServletResponse response，@RequestParam String filePath) throws IOException {
      3.  
      4.            List userList = userMapper.getAll();
      5.  
      6.  
      7.            // 设置响应头信息
      8.            response.setContentType("application/vnd.ms-excel");
      9.            response.setCharacterEncoding("utf-8");
      10.            String fileName = URLEncoder.encode("账号信息2.xlsx", "UTF-8");
      11.            response.setHeader("Content-disposition", "attachment;filename=" + fileName);
      12.            
      13.            // 这样用User类作示例，因此是User.class, 可根据自己实际使用的作更改
      14.            excelUtil.writeExcel(filePath, userList, User.class);
      15.  
      16.        }
       

      读：
       

      1.        @GetMapping("/readExcel")
      2.        public ResponseBean readExcel(@RequestParam String filePath) {
      3.             
      4.            // 因为我这里是在UserController下写的  因此用的是针对User实体，放入的静态参数是User.class
      5.            List dataList = excelUtil.readExcel(filePath, User.class);
      6.  
      7.            return ResponseBean.success(dataList);
      8.        }
        9.  

        这里提供ResponseBean的返回结果集封装代码：、
         

        1. public class ResponseBean {
        2.  
        3.     /** 200:操作成功  -1：操作失败**/
        4.  
        5.     // http 状态码
        6.     private boolean success;
        7.  
        8.     // 返回的数据
        9.     private T data;
        10.  
        11.     public boolean isSuccess() {
        12.         return success;
        13.     }
        14.  
        15.     public void setSuccess(boolean success) {
        16.         this.success = success;
        17.     }
        18.  
        19.     public T getData() {
        20.         return data;
        21.     }
        22.  
        23.     public void setData(T data) {
        24.         this.data = data;
        25.     }
        26.  
        27.     public static  ResponseBean success(T data) {
        28.         ResponseBean responseBean = new ResponseBean<>();
        29.         responseBean.setSuccess(true);
        30.         responseBean.setData(data);
        31.         return responseBean;
        32.     }
        33.  
        34.     public static  ResponseBean error(T errorData) {
        35.         ResponseBean responseBean = new ResponseBean<>();
        36.         responseBean.setSuccess(false);
        37.         responseBean.setData(errorData);
        38.         return responseBean;
        39.     }
        40.  
        41.     public static  ResponseBean success() {
        42.         ResponseBean responseBean = new ResponseBean<>();
        43.         responseBean.setSuccess(true);
        44.         return responseBean;
        45.     }
        46.  
        47. }
         

        
                
                    
                

                
      9. 

                    相关阅读:
        
                    
vue2点击左侧的树节点（el-tree）定位到对应右侧树形表格(el-table)的位置，树形表格懒加载                            
        
mybatis-plus(mp)使用                            
        
蓝桥杯嵌入式LCD屏幕                            
        
【无标题】                            
        
风控规则引擎（一）：Java 动态脚本                            
        
文生图算法评价                            
        
回应张逸老师（一）圈子文化                            
        
VP牛客小白月赛88（A---F)（收获很多）                            
        
怒刷LeetCode的第8天（Java版）                            
        
C语言王国——深入自定义类型（联合体、枚举）                            
        
                            
                
        10. 
                
      10. 
                    原文地址：https://blog.csdn.net/Kristabo/article/details/136339878
                
        11. 

            
        

        
        
            
          
                
        • 
                    最新文章
                
          • 
                
        • 
                    
攻防演习之三天拿下官网站群                            
          
数据安全治理学习——前期安全规划和安全管理体系建设                            
          
企业安全 | 企业内一次钓鱼演练准备过程                            
          
内网渗透测试 | Kerberos协议及其部分攻击手法                            
          
0day的产生 | 不懂代码的"代码审计"                            
          
安装scrcpy-client模块av模块异常，环境问题解决方案                            
          
leetcode hot100【LeetCode 279. 完全平方数】java实现                            
          
OpenWrt下安装Mosquitto                            
          
AnatoMask论文汇总                            
          
【AI日记】24.11.01 LangChain、openai api和github copilot                            
          
                              
                
          • 
            
        

            
          
                
        • 
                    热门文章
                
          • 
                
        • 
                    
十款代码表白小特效 一个比一个浪漫 赶紧收藏起来吧！！！                            
          
奉劝各位学弟学妹们，该打造你的技术影响力了！                            
          
五年了，我在 CSDN 的两个一百万。                            
          
Java俄罗斯方块，老程序员花了一个周末，连接中学年代！                            
          
面试官都震惊，你这网络基础可以啊！                            
          
你真的会用百度吗？我不信 — 那些不为人知的搜索引擎语法                            
          
心情不好的时候，用 Python 画棵樱花树送给自己吧                            
          
通宵一晚做出来的一款类似CS的第一人称射击游戏Demo！原来做游戏也不是很难，连憨憨学妹都学会了！                            
          
13 万字 C 语言从入门到精通保姆级教程2021 年版                            
          
10行代码集2000张美女图，Python爬虫120例，再上征途                            
          
                              
                
          • 
            
        

        
        
    




    
    
    
    

        
    
        
        
        
            
        
                
        
                    Copyright © 2022 侵权请联系2656653265@qq.com   
                    京ICP备2022015340号-1
                
        
                
        
                    正则表达式工具
                    cron表达式工具
                    密码生成工具
                
        
                
        
                    
                    
        京公网安备 11010502049817号