您的位置 首页 java

「Java工具类」EasyExcelUtil工具类 excel导入导出工具类 阿里Easy

介绍语

本号主要是 Java 常用关键技术点,通用工具类的分享;以及springboot+springcloud+ Mybatis plus+druid+mysql+ redis +swagger+ maven + docker 等集成框架的技术分享;datax、 kafka 、flink等大数据处理框架的技术分享。文章会不断更新,欢迎码友关注点赞收藏转发!

望各位码友点击关注,冲1000粉。后面会录制一些视频教程,图文和视频结合,比如:图书介绍网站系统、抢购系统、大数据中台系统等。技术才是程序猿的最爱,码友们冲啊

如果码友觉得代码太长,可以从头到尾快速扫射一遍,了解大概即可。觉得有用后再转发收藏,以备不时之需。

正文:

excel 导入导出 工具类,今天整理出来了,看了下项目中用的居然还是1.x版本,整理时升级到easyexcel 3.0.2最新版本,没想到之前封装的一堆代码都不需要,现在这个版本太好用了。大家可以直接使用easyexcel的方法,封装多一层是为了项目更方便使用而已。

例子1

读测试

  @Test
 public  void  readTest(){
     // 读取测试
     String read File  = "D:WorkspaceIdeaProjectsjtool-commonstudent信息表2.xlsx";
     List<Student> data = EasyExcelUtil.read(readFile, Student.class);
     printList(data);
 }
  private   static  void printList(List<?> datas) {
     int i = 0;
     for (Object ob : datas) {
         System.out.println(i++ + "=>" + ob);
     }
 }
 
 // 控制台打印
 17:55:58.240 [main] INFO  - 解析完成!读取10行
 0=>Student(name=张1, age=12, address=深圳0栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)
 1=>Student(name=张1, age=13, address=深圳1栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)
 2=>Student(name=张1, age=14, address=深圳2栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)
 3=>Student(name=张1, age=15, address=深圳3栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)
 4=>Student(name=张1, age=16, address=深圳4栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)
 5=>Student(name=张1, age=17, address=深圳5栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)
 6=>Student(name=张1, age=18, address=深圳6栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)
 7=>Student(name=张1, age=19, address=深圳7栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)
 8=>Student(name=张1, age=20, address=深圳8栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)
 9=>Student(name=张1, age=21, address=深圳9栋大楼, birthday=Wed Nov 03 12:17:46 GMT+08:00 2021)  

例子2

写测试

  @Test
 public void writeTest(){
     // 写入测试
     List<Student> stus = new ArrayList<>();
     for (int i = 0; i < 10; i++) {
         stus.add(new Student("张1", 12 + i, "深圳" + i + "栋大楼", new Date()));
     }
     String file = "student信息表2.xlsx";
     EasyExcelUtil.write(file, stus);
 }
 
 // 控制台无输出,可以在工程跟目录找到导出的文件student信息表2.xlsx  

例子3

直接返回给浏览器下载

  @ request Mapping(value = "/download", method = RequestMethod.GET)
 public String download(HttpServletRequest request, HttpServletResponse response) throws IO Exception  {
 
     // 写入测试
     List<Student> stus = new ArrayList<>();
     for (int i = 0; i < 10; i++) {
         stus.add(new Student("张1", 12 + i, "深圳" + i + "栋大楼", new Date()));
     }
     EasyExcelUtil.download(response, stus, "学生信息表");
     return "";
 }  

例子2和例子3导出的文件内容:

「Java工具类」EasyExcelUtil工具类 excel导入导出工具类 阿里Easy

excel导出内容

工具类源码:

  import com.alibaba. excel .EasyExcel;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import  java x.servlet.http.HttpServletResponse;
 import java.io.*;
 import java.net.URLEncoder;
 import java.util.List;
 
 /**
  * excel工具类
  * easyexcel使用的3.0.2版本,跟以前版本有很大区别,且不兼容1.x版本
  *
  * @author liangxn
  */
 public class EasyExcelUtil {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(EasyExcelUtil.class);
 
     public static <T> List<T> read(String  file Path, final Class<?> clazz) {
         File f = new File(filePath);
         try ( FileInputStream  fis = new FileInputStream(f)) {
             return read(fis, clazz);
         } catch (FileNotFoundException e) {
             LOGGER.error("文件{}不存在", filePath, e);
         } catch (IOException e) {
             LOGGER.error("文件读取出错", e);
         }
 
         return null;
     }
 
     public static <T> List<T> read( InputStream  inputStream, final Class<?> clazz) {
         if (inputStream == null) {
             throw new MyAppRunException("解析出错了,文件流是null");
         }
 
         // 有个很重要的点 DataListener 不能被spring管理,要每次读取excel都要new,然后里面用到 spring 可以 构造方法 传进去
         DataListener<T> listener = new DataListener<>();
 
         // 这里 需要指定读用哪个class去读,然后读取第一个sheet 文件流会自动关闭
         EasyExcel.read(inputStream, clazz, listener).sheet().doRead();
         return listener.getRows();
     }
 
     public static void write(String o UTF ile, List<?> list) {
         Class<?> clazz = list.get(0).getClass();
         // 新版本会自动关闭流,不需要自己操作
         EasyExcel.write(outFile, clazz).sheet().doWrite(list);
     }
 
     public static void write(String outFile, List<?> list, String sheetName) {
         Class<?> clazz = list.get(0).getClass();
         // 新版本会自动关闭流,不需要自己操作
         EasyExcel.write(outFile, clazz).sheet(sheetName).doWrite(list);
     }
 
     public static void write(OutputStream outputStream, List<?> list, String sheetName) {
         Class<?> clazz = list.get(0).getClass();
         // 新版本会自动关闭流,不需要自己操作
         // sheetName为sheet的名字,默认写第一个sheet
         EasyExcel.write(outputStream, clazz).sheet(sheetName).doWrite(list);
     }
 
     /**
      * 文件下载(失败了会返回一个有部分数据的Excel),用于直接把excel返回到浏览器下载
      */
     public static void download(HttpServletResponse response, List<?> list, String sheetName) throws IOException {
         Class<?> clazz = list.get(0).getClass();
 
         // 这里注意 有同学反应使用swagger 会导致各种问题,请直接用浏览器或者用postman
         response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
         response.setCharacterEncoding("utf-8");
         // 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
         String fileName = URLEncoder.encode(sheetName, "UTF-8").replaceAll("+", "%20");
         response.set Header ("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
         EasyExcel.write(response.getOutputStream(), clazz).sheet(sheetName).doWrite(list);
     }
 
 }  

相关的其它类

  import com.alibaba.excel. annotation .ExcelProperty;
 import com.alibaba.excel.annotation.format.DateTimeFormat;
 import lombok.AllArgs Constructor ;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
 import java.util.Date;
 
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
 public class Student {
     @ExcelProperty(value = "姓名", index = 0)
     private String name;
 
     @ExcelProperty(value = "年龄", index = 1)
     private int age;
 
     @ExcelProperty(value = "地址", index = 2)
     private String address;
 
     // easyexcel日期类型不支持LocalDate,只能是Date
     @ExcelProperty(value = "生日", index = 3)
     @DateTimeFormat("yyyy-MM-dd")
     private Date birthday;
 }  
  /**
  * 通用异常类
  */
 public class MyAppRunException  extends  RuntimeException {
 
     public MyAppRunException(String message) {
         super(message);
     }
 
     public MyAppRunException(String message, Throwable cause) {
         super(message, cause);
     }
 
     public MyAppRunException(Throwable cause) {
         super(cause);
     }
 
     protected MyAppRunException(String message,
             Throwable cause,
             boolean enableSuppression,
              boolean  writableStackTrace) {
         super(message, cause, enableSuppression, writableStackTrace);
     }
 
 }  

鄙人编码十年多,在项目中也积累了一些工具类,很多工具类在每个项目都有在用,很实用。大部分是鄙人封装的,有些工具类是同事封装的,有些工具类已经不记得是ctrl+c的还是自己封装的了,现在有空就会总结项目中大部分的工具类,分享给各位码友。如果文章中涉及的代码有侵权行为请通知鄙人处理。

计划是先把工具类整理出来,正所谓工欲善其事,必先利其器。项目中不管是普通单体项目还是多模块maven项目或是分布式微服务,一部分功能模块都是可以重用的,工具类模块就是其中之一。

文章来源:智云一二三科技

文章标题:「Java工具类」EasyExcelUtil工具类 excel导入导出工具类 阿里Easy

文章地址:https://www.zhihuclub.com/194310.shtml

关于作者: 智云科技

热门文章

网站地图