EasyPOI处理excel、CSV导入导出

已于 2023-09-04 15:58:07 修改
阅读量2.1k 收藏 4
点赞数
分类专栏： 报表技术 文章标签： java
于 2023-08-30 10:34:07 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_53951384/article/details/132576082
版权

1 简介

使用POI在导出导出excel、导出csv、word时代码有点过于繁琐，好消息是近两年在开发市场上流行一种简化POI开发的类库：easyPOI。从名称上就能发现就是为了简化开发。

能干什么？

Excel的快速导入导出,Excel模板导出,Word模板导出,可以仅仅5行代码就可以完成Excel的导入导出,修改导出格式简单粗暴,快速有效。

为谁而开发？

不太熟悉poi的
不想写太多重复太多的
只是简单的导入导出的
喜欢使用模板的
都可以使用easypoi

目标是什么？
Easypoi的目标不是替代poi,而是让一个不懂导入导出的快速使用poi完成Excel和word的各种操作,而不是看很多api才可以完成这样工作。

再次强调一下easyPOI完全替代不了POI！

需要的依赖

把项目中的poi的依赖去除

<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-base</artifactId>
    <version>4.1.0</version>
</dependency>
<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-web</artifactId>
    <version>4.1.0</version>
</dependency>
<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-annotation</artifactId>
    <version>4.1.0</version>
</dependency>

或SpringBoot

<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-spring-boot-starter</artifactId>
    <version>4.1.0</version>
</dependency>

2 注解方式导出Excel表

第一步：修改实体类，添加注解

其中主要用到的注解是@Excel注解，更详细的说明请看这里 (按住ctrl点击)

此处注意必须要有空构造函数，否则会报错“对象创建错误”

package com.itheima.pojo;
import cn.afterturn.easypoi.excel.annotation.Excel;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.opencsv.bean.CsvBindByName;
import lombok.Data;
import tk.mybatis.mapper.annotation.KeySql;
import javax.persistence.Id;
import javax.persistence.Table;
import java.util.Date;
import java.util.List;
/**
 * 员工
 */
@Data
@Table(name="tb_user")
public class User {
    @Id
    @KeySql(useGeneratedKeys = true)
    @Excel(name = "编号", orderNum = "0", width = 5)
    private Long id;         //主键
    @Excel(name = "员工名", orderNum = "1", width = 15)
    private String userName; //员工名
    @Excel(name = "手机号", orderNum = "2", width = 15)
    private String phone;    //手机号
    @Excel(name = "省份名", orderNum = "3", width = 15)
    private String province; //省份名
    @Excel(name = "城市名", orderNum = "4", width = 15)
    private String city;     //城市名
    @Excel(name = "工资", orderNum = "5", width = 10)
    private Integer salary;   // 工资
    @JsonFormat(pattern="yyyy-MM-dd")
    @Excel(name = "入职日期",  format = "yyyy-MM-dd",orderNum = "6", width = 15)
    private Date hireDate; // 入职日期
    private String deptId;   //部门id
    @Excel(name = "出生日期",  format = "yyyy-MM-dd",orderNum = "7", width = 15)
    private Date birthday; //出生日期
    @Excel(name = "照片", orderNum = "10",width = 15,type = 2)
    private String photo;    //一寸照片
    @Excel(name = "现在居住地址", orderNum = "9", width = 30)
    private String address;  //现在居住地址

    private List<Resource> resourceList; //办公用品

}

第二步：UserController添加方法

@GetMapping(value = "/downLoadWithEasyPOI",name = "使用EasyPOI下载Excel")
public void downLoadWithEasyPOI(HttpServletRequest request,HttpServletResponse response) throws Exception{
    userService.downLoadXlsxWithEayPoi(request,response);
}

第三步：UserService实现方法

public void downLoadXlsxWithEayPoi(HttpServletRequest request, HttpServletResponse response) throws Exception {
    //        查询用户数据
    List<User> userList = userMapper.selectAll();
    //指定导出的格式是高版本的格式
    ExportParams exportParams = new ExportParams("员工信息", "数据",ExcelType.XSSF);
    //        直接使用EasyPOI提供的方法
    Workbook workbook = ExcelExportUtil.exportExcel(exportParams, User.class, userList);
    String filename="员工信息.xlsx";
    //            设置文件的打开方式和mime类型
    ServletOutputStream outputStream = response.getOutputStream();
    response.setHeader( "Content-Disposition", "attachment;filename="  + new String(filename.getBytes(),"ISO8859-1"));
    response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
    workbook.write(outputStream);
}

3 注解方式导入

有导出就应该有导入，我们就把刚才导出的数据库导入到表中

Excel导入时需要的参数类ImportParams常用设置说明

  1. 读取指定的sheet 比如要读取上传得第二个sheet 那么需要把startSheetIndex = 1 就可以了
  2. 读取几个sheet 比如读取前2个sheet,那么 sheetNum=2 就可以了
  3. 读取第二个到第五个sheet 设置 startSheetIndex = 1 然后sheetNum = 4
  4. 读取全部的sheet sheetNum 设置大点就可以了
  5. 保存Excel 设置 needVerfiy = true,默认保存的路径为upload/excelUpload/Test/yyyyMMddHHmss 保存名称上传时间五位随机数 如果自定义路径 修改下saveUrl 就可以了,同时saveUrl也是图片上传时候的保存的路径
  6. 判断一个Excel是不是合法的Excel importFields 设置下值,就是表示表头必须至少包含的字段,如果缺一个就是不合法的excel,不导入
  7. 图片的导入

有图片的导出就有图片的导入,导入的配置和导出是一样的,但是需要设置保存路径 1.设置保存路径saveUrl 默认为"upload/excelUpload" 可以手动修改 ImportParams 修改下就可以了

第一步：修改实体类，表明哪些需要导入

package com.itheima.pojo;
import cn.afterturn.easypoi.excel.annotation.Excel;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import tk.mybatis.mapper.annotation.KeySql;

import javax.persistence.Id;
import javax.persistence.Table;
import java.util.Date;
import java.util.List;
/**
 * 员工
 */
@Data
@Table(name="tb_user")
public class User {
    @Id
    @KeySql(useGeneratedKeys = true)
    @Excel(name = "编号", orderNum = "0", width = 5)
    private Long id;         //主键
    @Excel(name = "员工名", orderNum = "1", width = 15,isImportField="true")
    private String userName; //员工名
    @Excel(name = "手机号", orderNum = "2", width = 15,isImportField="true")
    private String phone;    //手机号
    @Excel(name = "省份名", orderNum = "3", width = 15,isImportField="true")
    private String province; //省份名
    @Excel(name = "城市名", orderNum = "4", width = 15,isImportField="true")
    private String city;     //城市名
    @Excel(name = "工资", orderNum = "5", width = 10, type=10, isImportField="true") //type=10表示会导出数字
    private Integer salary;   // 工资
    @JsonFormat(pattern="yyyy-MM-dd")
    @Excel(name = "入职日期",  format = "yyyy-MM-dd",orderNum = "6", width = 15,isImportField="true")
    private Date hireDate; // 入职日期
    private String deptId;   //部门id
    @Excel(name = "出生日期",  format = "yyyy-MM-dd",orderNum = "7", width = 15,isImportField="true")
    private Date birthday; //出生日期
    @Excel(name = "照片", orderNum = "10",width = 15,type = 2,isImportField="true",savePath = "D:\\java_report\\workspace\\user_management\\src\\main\\resources\\static\\user_photos\\")
    private String photo;    //一寸照片
    @Excel(name = "现在居住地址", orderNum = "9", width = 30,isImportField="true")
    private String address;  //现在居住地址

    private List<Resource> resourceList; //办公用品

}

第二步：修改UserController中的导入方法

@PostMapping(value = "/uploadExcle", name = "上传用户数据")
public void uploadExcle(MultipartFile file) throws Exception{
    //        userService.uploadExcle(file);
    userService.uploadExcleWithEasyPOI(file);
}

第三步：在UserService中添加使用easyPOI导入的方法

public void uploadExcleWithEasyPOI(MultipartFile file) throws Exception {

    ImportParams importParams = new ImportParams();
    importParams.setTitleRows(1); //有多少行的标题
    importParams.setHeadRows(1);//有多少行的头
    List<User> userList = ExcelImportUtil.importExcel(file.getInputStream(),User.class,importParams);

    System.out.println(userList);
    for (User user : userList) {
        user.setId(null);
        userMapper.insertSelective(user);
    }
}

4 模板方式导出数据

模板是处理复杂Excel的简单方法，复杂的Excel样式，可以用Excel直接编辑，完美的避开了代码编写样式的雷区，同时指令的支持，也提了模板的有效性
采用的写法是{{}}代表表达式，然后根据表达式里面的数据取值

关于样式问题
easypoi不会改变excel原有的样式

需求：导出用户的详细信息，这个功能我们做过，今天我们使用easyPOI的方式再做一次

第一步：制作模板

这个模板和我们做的userInfo2.xlsx模板一样，只是这个变量使用了{{}}包起来了
在这里插入图片描述

第二步：放到项目中

在这里插入图片描述

第三步：改写UserController中导出用户信息的方法

@GetMapping(value = "/download",name = "导出用户详细信息")
public void downLoadUserInfoWithTempalte(Long id,HttpServletRequest request,HttpServletResponse response) throws Exception{
    //        userService.downLoadUserInfoWithTempalte(id,request,response);
    //        userService.downLoadUserInfoWithTempalte2(id,request,response);
    userService.downLoadUserInfoWithEastPOI(id,request,response);
}

第四步：完成UserService中的方法

public void downLoadUserInfoWithEastPOI(Long id, HttpServletRequest request, HttpServletResponse response) throws Exception  {
    //        获取模板的路径
    File rootPath = new File(ResourceUtils.getURL("classpath:").getPath()); //SpringBoot项目获取根目录的方式
    File templatePath = new File(rootPath.getAbsolutePath(),"/excel_template/userInfo3.xlsx");
    //        读取模板文件
    TemplateExportParams params = new TemplateExportParams(templatePath.getPath(),true);

    //        查询用户，转成map
    User user = userMapper.selectByPrimaryKey(id);
    Map<String, Object> map = EntityUtils.entityToMap(user);
    ImageEntity image = new ImageEntity();
    //        image.setHeight(640); //测试发现 这里设置了长度和宽度在合并后的单元格中没有作用
    //        image.setWidth(380);
    image.setRowspan(4);//向下合并三行
    image.setColspan(2);//向右合并两列
    image.setUrl(user.getPhoto());
    map.put("photo", image);
    Workbook workbook = ExcelExportUtil.exportExcel(params, map);

    //            导出的文件名称
    String filename="用户详细信息数据.xlsx";
    //            设置文件的打开方式和mime类型
    ServletOutputStream outputStream = response.getOutputStream();
    response.setHeader( "Content-Disposition", "attachment;filename="  + new String(filename.getBytes(),"ISO8859-1"));
    response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
    workbook.write(outputStream);
}

5 导出CSV

csv的导出基本上和excel的导出一致,大体参数也是一致的

CsvExportParams 的参数描述如下

属性类型默认值功能
encodingStringUTF8文件编码
spiltMarkString,分隔符
textMarkString“字符串识别,可以去掉,需要前后一致
titleRowsint0表格头,忽略
headRowsint1标题
exclusionsString[]0忽略的字段

需求：改写之前使用OpenCSV导出csv文件

第一步：修改UserController方法

@GetMapping(value = "/downLoadCSV",name = "导出用户数据到CSV文件中")
public void downLoadCSV(HttpServletResponse response) throws Exception{
    //        userService.downLoadCSV(response);
    userService.downLoadCSVWithEasyPOI(response);
}

第二步：完成UserService方法

public void downLoadCSVWithEasyPOI(HttpServletResponse response) throws Exception {
        ServletOutputStream outputStream = response.getOutputStream();
//            文件名
        String filename="百万数据.csv";
//            设置两个头 一个是文件的打开方式 一个是mime类型
        response.setHeader( "Content-Disposition", "attachment;filename="  + new String(filename.getBytes(),"ISO8859-1"));
        response.setContentType("application/csv");
//            创建一个用来写入到csv文件中的writer
        CsvExportParams params = new CsvExportParams();
//        设置忽略的列
        params.setExclusions(new String[]{"照片"}); //这里写表头 中文
        List<User> list = userMapper.selectAll();
        CsvExportUtil.exportCsv(params, User.class, list, outputStream);
    }

说明：从上述的代码中你会发现，如果需要导出几百万数据时不可能全部加载到一个List中的，所以easyPOI的方式导出csv是支持不了太大的数据量的，如果导出几百万条数据还是得选择OpenCSV方式导出。

Excel注解详细

属性类型类型说明
nameStringnull列名
needMergebooleanfasle纵向合并单元格
orderNumString“0”列的排序,支持name_id
replaceString[]{}值得替换 导出是{a_id,b_id} 导入反过来
savePathString“upload”导入文件保存路径
typeint1导出类型 1 是文本 2 是图片,3 是函数,10 是数字 默认是文本
widthdouble10列宽
heightdouble10列高,后期打算统一使用@ExcelTarget的height,这个会被废弃,注意
isStatisticsbooleanfasle自动统计数据,在追加一行统计,把所有数据都和输出这个处理会吞没异常,请注意这一点
isHyperlinkbooleanfalse超链接,如果是需要实现接口返回对象
isImportFieldbooleantrue校验字段,看看这个字段是不是导入的Excel中有,如果没有说明是错误的Excel,读取失败,支持name_id
exportFormatString“”导出的时间格式,以这个是否为空来判断是否需要格式化日期
importFormatString“”导入的时间格式,以这个是否为空来判断是否需要格式化日期
formatString“”时间格式,相当于同时设置了exportFormat 和 importFormat
databaseFormatString“yyyyMMddHHmmss”导出时间设置,如果字段是Date类型则不需要设置 数据库如果是string类型,这个需要设置这个数据库格式,用以转换时间格式输出
numFormatString“”数字格式化,参数是Pattern,使用的对象是DecimalFormat
imageTypeint1导出类型 1 从file读取 2 是从数据库中读取 默认是文件 同样导入也是一样的
suffixString“”文字后缀,如% 90 变成90%
isWrapbooleantrue是否换行 即支持\n
mergeRelyint[]{}合并单元格依赖关系,比如第二列合并是基于第一列 则{1}就可以了
mergeVerticalbooleanfasle纵向合并内容相同的单元格
清梦压星河_Ciao
关注
专栏目录
EasyPoi实现Excel数据导入
BroRiver
05-10 1289
EasyPoi是一个基于Java的Excel导入导出框架，主要提供了Excel读取、写入等基本功能，并且支持通过注解来定义Excel文件的格式。
使用EasyPoi实现Excel文件导入
m0_74268633的博客
03-14 1889
使用EasyPoi将Excel文件中的数据导入数据库并显示的实现过程。
easyexcel 3.0.5 导入导出csv格式文本问题总结
最新发布
weixin_43995512的博客
09-01 1441
String[] content = {"张三", "18", "男", "" + LocalDateTime.now()};// 例如:UTF-8,UTF-16BE.String[] content = {"张三", "18", "男", "" + LocalDateTime.now()};// list.add(new dmeo("王二麻","11","qdddzhangsan展示柜"));String[] headers = {"姓名", "年龄", "性别", "日期"};
【easypoi】easypoi导入csv格式的文件
JeffHan^_^的博客
09-01 2689
我在这里写导入的时候，遇到了一个我百思不得其解的问题，导入的数据行数是对的，但是所有的数据都是null，网上搜了一下，根本搜不到解决方案，于是下载源码一步一步调试，终于发现问题，发现CSV的表头导入的时候全部乱码了，和注解里的文字注释根本对应不上，所以导入的数据全部是null。各位如果也出现类型的情况，用notepad打开你的文件，看看你的文件编码是什么，这里设置一下，再导入就好了。这里使用的注解就和导入Excel时的一摸一样，不需要做什么特殊处理。...
POI操作（xls、csv、txt）
IT_CREATE的博客
08-26 8980
介绍一下POI操作的一个非常好的工具，easyPOI，网址：http://easypoi.mydoc.io/#category_49976 poi的基本操作：https://www.cnblogs.com/gdwkong/p/8669220.html 上面的链接介绍了如何对导入导出xls格式的excel文件进行操作，但是有时候我们在实际中不仅要支持xls等传统的报表格式进行导入导出操作，还需要...
poi导出cvs文件
08-12
NULL 博文链接：https://x125858805.iteye.com/blog/2279050
easypoi导出工具
11-05
easypoi常用导入，导出，工具，引入easypoi包ExcelUtil工具类，可以直接导出查询的数据
EasyPoi实现简单的Excel导出、导入
2301_81922209的博客
04-17 1826
EasyPoi实现Excel导出、导入。下面这种方式不需要模板，更加方便但是不能进行复杂的导出。
easy-poi导入excel数据
greenhandp的博客
07-02 787
使用easy-poi导入excel数据
easypoi导入excel
jah
12-06 8565
easypoi导入excel
easypoi导入导出实例
10-24
它提供了方便快捷的Excel导入导出功能，使得在Java应用中处理Excel数据变得非常简单。在这个“easypoi导入导出实例”中，我们能够看到一个完整的项目示例，包括了必要的代码和一个名为"user.xls"的Excel模板文件，...
easy-poi导入导出excel实例
03-15
easy-poi导入导出excel实例,包含所需jar包,可直接使用
报表技术POI&EasyPOI导入导出操作Excel、Word、CSV(讲义、源码、资料).zip
11-19
6. **资源利用**：提供的"报表技术POI&EasyPOI导入导出操作Excel、Word、CSV(讲义、源码、资料)"压缩包，包含了课程的讲义、源代码和相关资料，是学习和实践POI及EasyPOI的好资源。通过学习这些材料，你可以深入理解...
Spring Boot进阶(07)：如何使用EasyPoi实现Java中Excel的导入导出？完整教程请收藏，让你的Excel操作更高效！
**My Coding Family**
09-02 3086
集成EasyPoi，实现Excel的导入导出，一文教你学会。
Spring Boot 集成 easypoi实现excel的导入导出、excel导入导出含图片
12程序猿的博客
09-19 3681
Spring Boot 集成 easypoi实现excel的导入导出、excel导入导出含图片
easypoi导出csv文件，wps打开正常，excel2016打开乱码解决方案
Troub_cy的博客
09-26 1479
使用easypoi csv文件导出打开乱码处理
使用easypoi将数据导入excel中
weixin_44740485的博客
05-12 3921
本文介绍如何使用easypoi将数据当如到excel中； 官方文档：http://easypoi.mydoc.io/ 里面有介绍easypoi的注解使用等。 poi的依赖 <!--easypoi的依赖--> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-base</artifactId>
easypoi 导入excel
weixin_42563880的博客
12-16 703
easypoi 导入excelmaven工具类Excel实体类（注意这里注解中的值对应 Excel表格中列名）调用样例 maven x<dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-spring-boot-starter</artifactId> <version>4.2.0</version> </dependency> <
使用EasyPoi导入、导出excel
weixin_39527642的博客
02-16 5649
使用EasyPoi导入、导出excel
java csv导入导出
06-11
Java 中可以使用开源库 Apache Commons CSV 来实现 CSV 的导入和导出。以下是一个简单的示例代码，演示如何在 Java 中使用 Apache Commons CSV 来导入和导出 CSV 文件： 导入 CSV 文件示例代码： ```java import java.io.BufferedReader; import java.io.FileReader; import java.io.IOException; import org.apache.commons.csv.CSVFormat; import org.apache.commons.csv.CSVParser; import org.apache.commons.csv.CSVRecord; public class CSVReader { public static void main(String[] args) { String csvFile = "data.csv"; try (BufferedReader br = new BufferedReader(new FileReader(csvFile)); CSVParser parser = new CSVParser(br, CSVFormat.DEFAULT)) { for (CSVRecord record : parser) { String id = record.get(0); String name = record.get(1); String age = record.get(2); // 处理 CSV 数据 // ... } } catch (IOException e) { e.printStackTrace(); } } } ``` 导出 CSV 文件示例代码： ```java import java.io.FileWriter; import java.io.IOException; import org.apache.commons.csv.CSVFormat; import org.apache.commons.csv.CSVPrinter; public class CSVWriter { public static void main(String[] args) { String csvFile = "data.csv"; try (FileWriter writer = new FileWriter(csvFile); CSVPrinter printer = new CSVPrinter(writer, CSVFormat.DEFAULT)) { printer.printRecord("1", "John", "Doe"); printer.printRecord("2", "Jane", "Doe"); printer.printRecord("3", "Bob", "Smith"); } catch (IOException e) { e.printStackTrace(); } } } ``` 在实际的应用中，需要根据实际需求进行修改和完善。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值