Spring Boot 2.X手册：EasyPoi导入导出Excel

easypoi 功能如同名字 easy，主打的功能就是容易，让一个没见接触过 poi 的人员可以方便地写出 Excel 导出、Excel 模板导出、Excel 导入、Word 模板导出，通过简单的注解和模板语言(熟悉的表达式语法)，完成以前复杂的写法。

EasyPoi的官网上是这样介绍的：EasyPoi的目标不是替代poi,而是让一个不懂导入导出的快速使用poi完成Excel和word的各种操作,而不是看很多api才可以完成这样工作。

用过EasyPoi的人才会体会到EasyPoi的便捷，一个Excel的导出基本上两三行代码便可以搞定，除此之外它还支持Word导出。

今天我们用EasyPoi做一个Excel的导入导出的小例子，看看EasyPoi到底怎么使用吧！

工具包导入

目前EasyPoi的最新版本是4.2.0，我在Spring Boot 项目中使用的是4.1.0，在pom文件中引入maven坐标


<!--引入EasyPoi包-->

<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>

编写工具类


package com.easypoi.em;

​

/**

* Excel枚举类型

* @author: brb

* @date: 2020年8月29日

*/

public enum ExcelTypeEnum {

​

  XLS("xls"), XLSX("xlsx");

​

  private String value;

​

  private ExcelTypeEnum(String value) {

      this.value = value;

  }

​

  public String getValue() {

      return value;

  }

​

  public void setValue(String value) {

      this.value = value;

  }

}



package com.easypoi.util;

​

import cn.afterturn.easypoi.excel.ExcelExportUtil;

import cn.afterturn.easypoi.excel.entity.ExportParams;

import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;

import com.easypoi.em.ExcelTypeEnum;

import org.apache.poi.ss.usermodel.Workbook;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.stereotype.Component;

​

import javax.servlet.ServletOutputStream;

import javax.servlet.http.HttpServletResponse;

import java.io.IOException;

import java.net.URLEncoder;

import java.util.List;

import java.util.Map;

​

/**

* Excel导出工具类

* @author brb

* @date 2020年8月29日

*/

@Component

public class ExcelExportUtils {

​

    @Autowired

    private HttpServletResponse response;

​

    /**

    * 导出excel

    * @param list  泛型数据

    * @param pojoClass 需要导出的对象

    * @param title 标题

    * @param sheetName sheet的名称

    * @param fileName  文件名称

    * @param isCreateHeader    是否创建表头

    */

    public void exportExcel(List<?> list, Class<?> pojoClass, String title,

                            String sheetName, String fileName, boolean isCreateHeader) throws IOException {

​

        final ExportParams exportParams = new ExportParams(title, sheetName, ExcelType.XSSF);

        exportParams.setCreateHeadRows(isCreateHeader);

        baseExport(list, pojoClass, fileName, exportParams);

    }

​

    /**

    * 导出Excel

    * @param list  泛型数据

    * @param pojoClass 需要导出的对象

    * @param title 标题

    * @param sheetName sheet的名称

    * @param fileName  文件名称

    */

    public void exportExcel(List<?> list, Class<?> pojoClass, String title,

                            String sheetName, String fileName) throws IOException {

        baseExport(list, pojoClass, fileName, new ExportParams(title, sheetName, ExcelType.XSSF));

    }

​

    /**

    * 导出Excel

    * @param list  泛型数据

    * @param pojoClass 需要导出的对象

    * @param fileName  文件名称

    * @param exportParams  导出文件属性

    */

    public void exportExcel(List<?> list, Class<?> pojoClass, String fileName,

                            ExportParams exportParams) throws IOException {

        baseExport(list, pojoClass, fileName, exportParams);

    }

​

    /**

    * 多个sheet导出

    * @param list

    * @param fileName

    */

    public void exportExcel(List<Map<String, Object>> list,

                            String fileName) throws IOException {

        baseExport(list, fileName);

    }

​

    /**

    * 最基础的对象导出

    * @param list  数据列表

    * @param pojoClass 导出对象

    * @param fileName  文件名称

    * @param exportParams  导出文件属性

    */

    private void baseExport(List<?> list, Class<?> pojoClass,

                            String fileName, ExportParams exportParams) throws IOException {

        final Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);

        downLoadExcel(fileName, workbook);

    }

​

    /**

    * 最基础的多sheet导出

    * @param list  多个不同数据对象的列表

    * @param fileName  文件名称

    */

    private void baseExport(List<Map<String, Object>> list, String fileName) throws IOException {

        final Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);

        downLoadExcel(fileName, workbook);

    }

​

    /**

    * 文件下载

    * @param fileName  文件名称

    * @param workbook  exce对象

    */

    private void downLoadExcel(String fileName, Workbook workbook) throws IOException {

        ServletOutputStream output = null;

        try {

            final String downloadName = URLEncoder

                    .encode(fileName + "." + ExcelTypeEnum.XLSX.getValue(), "UTF-8");

            response.setCharacterEncoding("UTF-8");

            response.setHeader("content-Type", "application/vnd.ms-excel");

            response.setHeader("Content-Disposition", "attachment;filename=" + downloadName);

            output = response.getOutputStream();

            workbook.write(output);

        } catch (final Exception e) {

            throw new IOException(e.getMessage());

        } finally {

            if (output != null) {

                output.flush();

                output.close();

            }

        }

    }

}



package com.easypoi.util;

​

​

import cn.afterturn.easypoi.excel.ExcelImportUtil;

import cn.afterturn.easypoi.excel.entity.ImportParams;

import org.apache.logging.log4j.util.Strings;

import org.springframework.stereotype.Component;

import org.springframework.web.multipart.MultipartFile;

​

import java.io.File;

import java.io.InputStream;

import java.util.List;

​

/**

* Excel导入工具类

* @author brb

* @date 2020年08月29日

*/

@Component

public class ExcelImportUtils {

​

    /**

    * 从指定位置获取文件后进行导入

    * @param filePath

    * @param titleRows

    * @param headerRows

    * @param pojoClass

    * @param <T>

    * @return

    */

    public <T> List<T> importExcel(String filePath, Integer titleRows,

                                  Integer headerRows, Class<?> pojoClass) {

​

        if (Strings.isEmpty(filePath)) {

            return null;

        } else {

            final ImportParams params = new ImportParams();

            //表格标题行数，默认0

            params.setTitleRows(titleRows);

            //表头行数，默认1

            params.setHeadRows(headerRows);

            //是否需要保存上传的Excel

            params.setNeedSave(true);

            //保存上传的Excel目录

            params.setSaveUrl("/excel/");

​

            return ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);

        }

    }

​

    /**

    * 上传文件导入

    * @param file

    * @param titleRows 标题行

    * @param headerRows    表头行

    * @param needVerfiy    是否检验excel内容

    * @param pojoClass 导入的对象

    * @param <T>

    * @return

    * @throws Exception

    */

    public <T> List<T> importExcel(MultipartFile file, Integer titleRows,

                                  Integer headerRows, boolean needVerfiy,

                                  Class<T> pojoClass) throws Exception {

        if (file == null) {

            return null;

        } else {

            return baseImport(file.getInputStream(), titleRows,

                    headerRows, needVerfiy, pojoClass);

        }

    }

​

    /**

    * 最基础导入

    * @param inputStream

    * @param titleRows

    * @param headerRows

    * @param needVerfiy

    * @param pojoClass

    * @param <T>

    * @return

    */

    private <T> List<T> baseImport(InputStream inputStream,

                                  Integer titleRows, Integer headerRows,

                                  boolean needVerfiy, Class<T> pojoClass) throws Exception {

​

        if (inputStream == null) {

            return null;

        } else {

            final ImportParams params = new ImportParams();

            params.setTitleRows(titleRows);

            params.setHeadRows(headerRows);

            params.setSaveUrl("/excel/");

            params.setNeedSave(true);

            params.setNeedVerify(needVerfiy);

​

            return ExcelImportUtil.importExcel(inputStream, pojoClass, params);

        }

    }

}

编写导入导出对象


package com.easypoi.domain;

​

​

import com.baomidou.mybatisplus.annotation.TableName;

import lombok.Data;

​

import java.math.BigDecimal;

import java.util.Date;

​

/**

* UserDomain

* @author brb

* @date 2020年08月30日

*/

@Data

@TableName(value = "e_user")

public class UserDomain {

​

    private Integer userId;

​

    private Integer sex;

​

    private BigDecimal money;

​

    private String userName;

​

    private Float price;

​

    private Date now;

}



package com.easypoi.vo;

​

import cn.afterturn.easypoi.excel.annotation.Excel;

import lombok.Data;

​

import java.io.Serializable;

import java.math.BigDecimal;

import java.text.NumberFormat;

import java.util.Date;

​

/**

* UserVo

* @author brb

* @date 2020年08月30日

*/

@Data

public class UserVo implements Serializable {

​

    private static final long serialVersionUID = -1509488199440369183L;

​

​

    @Excel(name = "用户id", orderNum = "0", width = 15)

    private String userId;

​

    @Excel(name = "性别", orderNum = "1", width = 15, replace = {"男_1", "女_1"}, suffix = "孩")

    private String sex;

​

    @Excel(name = "金钱", orderNum = "2", width = 15)

    private String money;

​

​

    @Excel(name = "用户信息", orderNum = "3", width = 15)

    private String userName;

​

    @Excel(name = "价格", orderNum = "4", width = 15)

    private String price;

​

    @Excel(name = "时间", orderNum = "5", width = 15, format = "yyyy-MM-dd")

    private Date now;

}

编写转换工具


package com.easypoi.dozer;

​

​

import org.dozer.DozerBeanMapper;

import org.springframework.stereotype.Component;

​

import java.util.ArrayList;

import java.util.List;

​

/**

* vo与domain互转工具类

* @author brb

* @date 2020年08月30日

*/

@Component

public class DozerBeanMapperWrapper {

​

    private static DozerBeanMapper dozerBeanMappee = new DozerBeanMapper();

​

    public <T> T mapper(Object source, Class<T> destinationClass) {

        return dozerBeanMappee.map(source, destinationClass);

    }

​

    public void mapper(Object source, Object destinationSource) {

        dozerBeanMappee.map(source, destinationSource);

    }

​

    public <T> List<T> mapperList(List<?> sources, Class<T> destinationClass) {

        List<T> targetList = new ArrayList<T>();

        for (Object source : sources) {

            targetList.add(dozerBeanMappee.map(source, destinationClass));

        }

        return targetList;

    }

​

}

编写测试方法


package com.easypoi.controller;

​

​

import com.easypoi.domain.UserDomain;

import com.easypoi.dozer.DozerBeanMapperWrapper;

import com.easypoi.service.UserService;

import com.easypoi.util.ExcelExportUtils;

import com.easypoi.util.ExcelImportUtils;

import com.easypoi.vo.UserVo;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestParam;

import org.springframework.web.bind.annotation.RestController;

import org.springframework.web.multipart.MultipartFile;

​

import java.io.IOException;

import java.util.List;

​

/**

* excel导出导出

* @author brb

* @date 2020年08月30日

*/

@Api(tags = { "APP服务：数据接口"})

@RestController

@RequestMapping("view/ie")

public class ImportExportController {

​

    @Autowired

    private ExcelExportUtils excelExportUtils;

​

    @Autowired

    private ExcelImportUtils excelImportUtils;

​

​

    @Autowired

    private DozerBeanMapperWrapper dozerBeanMapper;

​

    @Autowired

    private UserService userService;

​

    /**

    * 导出用户信息

    * @throws IOException

    */

    @ApiOperation(value = "导出excel")

    @GetMapping(value = "/exportExcel")

    public void exportExcel() throws IOException {

        //NumberFormat nf = NumberFormat.getNumberInstance()

        final List<UserDomain> userDomainList = userService.list();

        final List<UserVo> userList = dozerBeanMapper.mapperList(userDomainList, UserVo.class);

        excelExportUtils.exportExcel(userList, UserVo.class, "用户信息", "员工信息的sheet", "用户信息表");

    }

​

    /**

    * 导入用户信息

    * @param file

    * @return

    */

    @ApiOperation(value = "导入excel")

    @GetMapping(value = "/importExcel")

    public void importExcel(@RequestParam("file") MultipartFile file) throws Exception {

        final List<UserVo> userList = excelImportUtils.importExcel(file, 1, 1, false, UserVo.class);

        final List<UserDomain> userDomainList = dozerBeanMapper.mapperList(userList, UserDomain.class);

        userService.saveBatch(userDomainList);

        System.out.println(userList.toString());

        System.out.println("----------");

        System.out.println(userDomainList);

    }

}



package com.easypoi.service.impl;

​

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;

import com.easypoi.mapper.UserMapper;

import com.easypoi.domain.UserDomain;

import com.easypoi.service.UserService;

import org.springframework.stereotype.Service;

​

/**

* UserServiceImpl

* @author brb

* @date 2020年08月30日

*/

@Service

public class UserServiceImpl extends ServiceImpl<UserMapper, UserDomain> implements UserService {

}



package com.easypoi.service;

​

​

import com.baomidou.mybatisplus.extension.service.IService;

import com.easypoi.domain.UserDomain;

import org.springframework.stereotype.Service;

​

/**

* UserService

* @author brb

* @date 2020年08月30日

*/

@Service

public interface UserService extends IService<UserDomain> {

}

​



package com.easypoi.mapper;

​

import com.baomidou.mybatisplus.core.mapper.BaseMapper;

import com.easypoi.domain.UserDomain;

​

/**

* UserMapper

* @author brb

* @date 2020年08月30日

*/

public interface UserMapper extends BaseMapper<UserDomain> {

}

导出结果

导出接口测试，直接在浏览器输入地址接口，结果如截图所示：

image

导入结果

把刚刚导出的文件，直接导入进去，这里采用postMan操作，其中红色的圈圈标出来是需要注意的点（导入之前先把数据库中的数据删除，否则的话会报主键冲突）

image

具体的代码我已经放在GitHub上，大家可以关注公众号回复EasyPoi获取代码。

image
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 194,088评论 5赞 459
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 81,715评论 2赞 371
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 141,361评论 0赞 319
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 52,099评论 1赞 263
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 60,987评论 4赞 355
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 46,063评论 1赞 272
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 36,486评论 3赞 381
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 35,175评论 0赞 253
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 39,440评论 1赞 290
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2赞 309
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1赞 326
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,190评论 3赞 312
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 37,550评论 3赞 298
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0赞 17
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1赞 250
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2赞 341
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2赞 335