写一个easyexcel的工具类

时间  2019-11-06
标签 一个 easyexcel 工具 繁體版
原文   原文链接

1. 前言

最近阿里开源的excel读写项目EasyExcel又火了起来 . 原来是项目又开始维护了, 从1.x 更新到2.x 了 , 并且迭代迅速 , 目前已经更新到 2.1.0-beta3 版本.html

关于easyexcel , 其主要目的为下降读取excel时的内存损耗 , 简化读写excel的api .java

同时2.x版本提供了不少新功能 , 具体你们能够直接参考官方说明吧 , github文档上写十分详细 (中文) , 这里就不传播一些没啥必要的二三手知识了 , 并且目前该项目还在不停地迭代 , 给contributor一个star也是颇有必要的 . :smile:git

官方地址 : easyexcel仓库地址 , easyexcel官网github


这里我基于easyexcel 2.0.5版本简单封装了一个web读写excel的工具类 , 主要封装了以下功能 :web

  • 经过注解自定义LocalDateTime的读写格式shell

  • 经过注解自定义枚举类型的读写格式数据库

  • 自定义BaseExcelListener抽象类封装了经常使用的数据处理逻辑 , 以及补充读取excel过程当中读取发生错误被跳过的行号记录 .api

  • 封装了web的读写excel操做数组

  • ... (后续会持续更新封装easyexcel提供的api , 但愿可让easyexcel更easy . )app

下面列举主要功能以及相关示例 , 能够直接看源码 , 每一个方法都有写完整的注释 , 若是以为写得还凑合能看的话 , 给我这个刚毕业没多久的小菜鸡点个star呗 :smile: .

附上源码地址 : github.com/aStudyMachi…

2. 主要功能

2.1 创建excel表每行数据与Java模型的映射

easyexcel读写excel能够基于java 模型的方式 , 也可使用List<List<String>> 的方式读写excel , 这里我读写操做使用基于java模型的方式 , 经过java类的属性与excel每一列的数据进行对应

关键注解 : @ExcelProperty , @EnumFormat , @LocalDateTimeFormat

具体如何使用注解创建java模型与Excel表数据的映射能够参考 com.wukun.module.easyexcel.pojo下的两个java模型类Order 类与User类

/** * @author WuKun * @since 2019/10/09 */
@Data
@AllArgsConstructor
@NoArgsConstructor //必需要保证无参构造方法存在,不然会报初始化对象失败
public class User {

    /** * {@code @ExcelIgnore} 用于标识该字段不用作excel读写过程当中的数据转换 */
    @ExcelIgnore
    private Integer userId;

    /** * <pre> * {@code @ExcelIgnore} 中的属性 不建议 index 和 name 同时用 * * 要么一个对象统一只用index表示列号, * 例如 : {@code @ExcelProperty(index = 0)} * * 要么一个对象统一只用value去匹配列名 * 例如 : {@code @ExcelProperty("姓名")} * * 用名字去匹配,这里须要注意,若是名字重复,会致使只有一个字段读取到数据 * </pre> */
    @ExcelProperty("姓名")
    private String name;

    @ExcelProperty("年龄")
    private Integer age;

    @ExcelProperty("地址")
    private String address;

    /** * <pre> * {@code @EnumFormat} 注解 : * 做用 : 与 {@code @ExcelProperty(converter = EnumExcelConverter.class)} 搭配使用 * 转换java枚举与excel中指定的内容 * 属性 : * - value : 要转换的枚举类class对象 * - fromExcel : 指定excel中用户输入的枚举值的名字的字符串形式,与toJavaEnum中指定的枚举值一一对应 * 如下面的示例来讲,fromExcel指定的 "男" 对应 toJavaEnum中的 "MAN" , * 当excel中该列读取到"男" 这个字符串时,会自动转化为枚举{@code GenderEnum.MAN}, * 同理在写excel时,若是该字段为{@code GenderEnum.MAN} 时, 写到excel时则转化为 "男" * - toJavaEnum : 如上所述 * * 注意 : fromExcel 与 toJavaEnum 这两个属性必须同时使用, 并且两个属性的字符串的数组长度必须相同, * 若两个属性都不指定 , 则默认 枚举值名字符串转化为对应的枚举 例如: "MAN" <--> {@code GenderEnum.MAN} * </pre> */
    @EnumFormat(value = GenderEnum.class,
            fromExcel = {"男", "女"},
            toJavaEnum = {"MAN", "WOMAN"}) // "男" <--> GenderEnum.MAN ; "女" <--> GenderEnum.WOMAN
    @ExcelProperty(value = "性别", converter = EnumExcelConverter.class)
    private GenderEnum gender;

    /** * <pre> * {@code @LocalDateTimeFormat} 注解 * 做用: 与 {@code @ExcelProperty(converter = LocalDateTimeExcelConverter.class)} 搭配使用, * 指定导入导出的时间格式. * 属性 : * - value : 日期格式字符串 * </pre> */
    @ExcelProperty(value = "生日", converter = LocalDateTimeExcelConverter.class)
    @LocalDateTimeFormat("yyyy-MM-dd HH:mm:ss")
    private LocalDateTime birthday;
}

复制代码

2.2 导出excel

2.2.1 相关API介绍

web导出excel 根据03 / 07版本分为两个不一样的方法 ,分别为EasyExcelUtil类中如下两个方法 :

  • 导出03版本 : exportExcel2003Format(EasyExcelParams excelParams)

  • 导出07版本 : exportExcel2007Format(EasyExcelParams excelParams)

EasyExcelParams是使用EasyExcel导出excel须要设置的相关参数 , 包括须要导出的List<T>数据以及对应的Java模型 , 使用时根据实际状况设置相应的参数便可.

/** * @author WuKun * @since 2019/10/14 */
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class EasyExcelParams implements Serializable {


    /** * excel文件名（不带拓展名) */
    private String excelNameWithoutExt;
    /** * sheet名称 */
    private String sheetName;

    /** * 数据 */
    private List data;

    /** * 数据模型类型 */
    private Class dataModelClazz;

    /** * 响应 */
    private HttpServletResponse response;


    public EasyExcelParams() {
    }

    /** * 检查不容许为空的属性 * * @return this */
    public EasyExcelParams checkValid() {
        Assert.isTrue(ObjectUtils.allNotNull(excelNameWithoutExt, data, dataModelClazz, response), "导出excel参数不合法!");
        return this;
    }
}
复制代码

2.2.2 导出excel示例

/** * 使用EasyExcelUtils 导出Excel 2007 * * @param response HttpServletResponse * @throws Exception exception */
@GetMapping("/easy2007")
public void easy2007(HttpServletResponse response) throws Exception {
    initData();

    //设置参数
    EasyExcelParams params = new EasyExcelParams().setResponse(response)
        .setExcelNameWithoutExt("Order(xlsx)")
        .setSheetName("第一张sheet")
        .setData(data)
        .setDataModelClazz(Order.class)
        .checkValid();

    long begin = System.currentTimeMillis();
    EasyExcelUtil.exportExcel2007(params);
    long end = System.currentTimeMillis();

    log.info("-----EasyExcelUtils : 导出成功,导出excel花费时间为 : " + ((end - begin) / 1000) + "秒");
}

private void initData() {
    if (CollectionUtils.isEmpty(data)) {
        for (int i = 0; i < 60000; i++) {
            data.add(new Order().setPrice(BigDecimal.valueOf(11.11))
                     .setCreateTime(LocalDateTime.now()).setGoodsName("香蕉")
                     .setOrderId(i)
                     .setNum(11)
                     .setOrderStatus(OrderStatusEnum.PAYED));
        }
    }
}
复制代码

2.3 读取excel

2.3.1 相关API介绍

  • 读取excel时用到的是EasyExcelUtils的readExcel方法 ;
/** * 读取 Excel(支持单个model的多个sheet) * * @param excel 文件 * @param rowModel 实体类映射 * @param listener 用于读取excel的listener */
public static void readExcel(MultipartFile excel, Class rowModel, BaseExcelListener listener) {
    ExcelReader reader = getReader(excel, rowModel, listener);
    try {
        Assert.notNull(reader, "导入Excel失败!");
        Integer totalSheetCount = reader.getSheets().size();
        for (Integer i = 0; i < totalSheetCount; i++) {
            reader.read(EasyExcel.readSheet(i).build());
        }
    } finally {
        // 这里千万别忘记关闭,读的时候会建立临时文件,到时磁盘会崩的
        Optional.ofNullable(reader).ifPresent(ExcelReader::finish);
    }
}
复制代码
  • easyexcel的读取操做须要自建一个类继承AnalysisEventListener抽象类 , 这里我建立BaseExcelListener类继承并重写读取excel的相关方法 , 每一个方法的具体做用可直接查看方法头部注释 , 使用时直接建立一个listener类继承BaseExcelListener便可 , 若是默认的BaseExcelListener不知足需求 , 也能够直接自定义一个Listener 类继承 BaseExcelListener并重写相应方法.
/** * @author WuKun * @since 2019-10-10 * <p> * 因为在实际中可能会根据不一样的业务场景须要的读取到的不一样的excel表的数据进行不一样操做, * 因此这里将{@link BaseExcelListener}做为全部listener的父类,根据读取不一样的java模型自定义一个listener类继承{@link BaseExcelListener}, * 根据不一样的业务场景选择性对如下方法进行重写,具体如{@link OrderListener}所示 * </p> * * <p>若是默认实现的方法不知足业务,则直接自定义一个listener继承{@link BaseExcelListener},重写一遍方法便可.</p> */
@Slf4j
public abstract class BaseExcelListener<Model> extends AnalysisEventListener<Model> {

    /** * 每隔N条存储数据库，实际使用中能够3000条，而后清理list ，方便内存回收 */
    private static final int BATCH_COUNT = 3000;

    /** * 自定义用于暂时存储data。 * 能够经过实例获取该值 * 能够指定AnalysisEventListener的泛型来肯定List的存储类型 */
    @Getter
    private List<Model> data = new ArrayList<>();

    /** * 读取时抛出异常是否继续读取,默认true,表示跳过错误行继续读取 */
    @Setter
    private boolean continueAfterThrowing = true;


    /** * 读取过程当中发生异常被跳过的行数记录 * String 为 sheetNo * List<Integer> 为 错误的行数列表 */
    @Getter
    private Map<String, List<Integer>> errRowsMap = new HashMap<>();

    /** * 每解析一行会回调invoke()方法。 * 若是当前行无数据,该方法不会执行, * 也就是说若是导入的的excel表无数据,该方法不会执行, * 不须要对上传的Excel表进行数据非空判断 * * @param object 当前读取到的行数据对应的java模型对象 * @param context 定义了获取读取excel相关属性的方法 */
    @Override
    public void invoke(Model object, AnalysisContext context) {
        log.info("解析到一条数据:{}", object);
        // 数据存储到list，供批量处理，或后续本身业务逻辑处理。
        data.add(object);

        //若是continueAfterThrowing 为false 时保证数据插入的一致性
        if (data.size() >= BATCH_COUNT && continueAfterThrowing) {
            saveData();
            data.clear();
        }
    }

    /** * 入库,继承该类后实现该方法便可 */
    abstract void saveData();

    /** * 解析监听器 * 每一个sheet解析结束会执行该方法 */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        saveData();
        log.info("/*------- 当前sheet读取完毕,sheetNo : {} , 读取错误的行号列表 : {} -------*/",
                getCurrentSheetNo(context), JSON.toJSONString(errRowsMap));
        data.clear();//解析结束销毁不用的资源
    }

    /** * 在转换异常 获取其余异常下会调用本接口。抛出异常则中止读取。若是这里不抛出异常则 继续读取下一行。 * 若是不重写该方法,默认抛出异常,中止读取 * * @param exception exception * @param context context */
    @Override
    public void onException(Exception exception, AnalysisContext context) {
        if (!continueAfterThrowing) {
            throw new IllegalArgumentException(exception);
        }

        Integer sheetNo = getCurrentSheetNo(context);
        Integer rowIndex = context.readRowHolder().getRowIndex();
        log.error("/*------- 读取发生错误! 错误SheetNo:{},错误行号:{} -------*/ ", sheetNo, rowIndex, exception);

        List<Integer> errRowNumList = errRowsMap.get(String.valueOf(sheetNo));
        if (Objects.isNull(errRowNumList)) {
            errRowNumList = new ArrayList<>();
            errRowNumList.add(rowIndex);
            errRowsMap.put(String.valueOf(sheetNo), errRowNumList);
        } else {
            errRowNumList.add(rowIndex);
        }
    }

    /** * 获取当前读取的sheet no * * @param context * @return */
    private Integer getCurrentSheetNo(AnalysisContext context) {
        return context.readSheetHolder().getSheetNo();
    }

}
复制代码
  • 读取时不区分03或07版本 , 底层会自动判断 ;

2.3.2 读取excel示例

  1. 自定义一个listener类继承BaseExcelListener
package com.luwei.module.easyexcel.listener;

import com.wukun.module.easyexcel.pojo.User;
import lombok.extern.slf4j.Slf4j;

/** * @author WuKun * @since 2019/10/10 */
@Slf4j
public class UserListener extends BaseExcelListener<User> {
    /** * 这里须要注意入库使用到的Service或者DAO层须要使用到的相关方法时, * 不要经过Spring 使用{@code @Autowired}注入,同时该Listener也不要交由Spring IOC进行管理 * 直接经过构造方法传入相关`xxxService` 或者 `xxxMapper` */
    private UserService userService;

    public UserListener(UserService userService) {
        this.userService = userService;
    }
    
    @Override
    void saveData() {
        // 批量插入数据
        userService.saveBatchUsers(this.getData())
        log.info("/*------- 写入数据 -------*/");
    }
}
复制代码
  1. 调用工具方法
@Autowired
private UserService userService;

/** * 读取测试 * * @param excel excel文件 */
@PostMapping("/readExcel")
public void readExcel(@RequestParam MultipartFile excel) {
    EasyExcelUtil.readExcel(excel, User.class, new UserListener(userService));
}
复制代码

3. 注意事项

  • java模型必需要保证无参构造方法存在 , 不然会在读写excel时报没法初始化java模型对象的异常

  • 使用java模型读取excel时不能对Java模型使用@Accessors(chain = true)注解, 会致使数据没法转换 (easyexcel 2.x的API该问题已解决)

  • sheetNo 从 0开始 , 行号不包括表头 , 例如log中打印的是第9行, 实际在excel中对应的是第10行

    2019-10-20 15:34:57.236  INFO 38012 --- [nio-8081-exec-8] c.l.e.listener.BaseExcelListener         : /*------- 当前sheet读取完毕,sheetNo : 1 , 读取错误的行号列表 : {"1":[9]} -------*/
复制代码

    image.png

做者 : 一台学习机

广州芦苇科技Java开发团队

芦苇科技-广州专业互联网软件服务公司

抓住每一处细节 ，创造每个美好

关注咱们的公众号，了解更多

想和咱们一块儿奋斗吗？lagou搜索“ 芦苇科技 ”或者投放简历到 server@talkmoney.cn 加入咱们吧

关注咱们，你的评论和点赞对咱们最大的支持

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程