AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

【Java用法】使用EasyPoi导入与导出Excel文档的解决方案

2023-10-14 359
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 【Java用法】使用EasyPoi导入与导出Excel文档的解决方案

这是另一种写法，与之前的博客【Java用法】使用poi写Java代码导出Excel文档的解决方案，

最终实现的功能都一样。

第一步：添加Maven依赖

<!-- easypoi start -->
<dependency>
  <groupId>cn.afterturn</groupId>
  <artifactId>easypoi-base</artifactId>
  <version>3.3.0</version>
</dependency>
<dependency>
  <groupId>cn.afterturn</groupId>
  <artifactId>easypoi-web</artifactId>
  <version>3.3.0</version>
</dependency>
<dependency>
  <groupId>cn.afterturn</groupId>
  <artifactId>easypoi-annotation</artifactId>
  <version>3.3.0</version>
</dependency>
<!-- easypoi end -->

第二步：添加注解

下面是需要导出的实体类，需要添加 @Excel 注解；该注解类来自于cn.afterturn.easypoi.excel.annotation 包中。以下是我项目中的实体类代码：

package com.iot.wop.hvac.entity;
import cn.afterturn.easypoi.excel.annotation.Excel;
import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
import java.io.Serializable;
import java.util.Date;
/**
 * <p>HvacBrand 此类用于：对接申请实体</p>
 * <p>@author：hujm</p>
 * <p>@date：2021年06月06日 19:43</p>
 * <p>@remark：</p>
 */
@ApiModel(value = "对接申请实体")
@Data
public class HvacJointApply implements Serializable {
    @ApiModelProperty(value = "对接申请编号", example = "1")
    @Excel(name = "申请编号", orderNum = "0", width = 15)
    private Integer id;
    @ApiModelProperty(value = "品牌名称")
    @Excel(name = "品牌名称", orderNum = "1", width = 20)
    private String brandName;
    @ApiModelProperty(value = "暖通类型：1、空调，2、地暖，3、新风")
    @Excel(name = "暖通类型", orderNum = "2", width = 15, replace = {"空调_1", "地暖_2", "新风_3"})
    private Integer hvacType;
    @ApiModelProperty(value = "型号")
    @Excel(name = "型号", orderNum = "3", width = 20)
    private String model;
    @ApiModelProperty(value = "技术负责人姓名")
    @Excel(name = "技术负责人姓名", orderNum = "4", width = 20)
    private String technicalDirectorName;
    @ApiModelProperty(value = "需求时间")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @Excel(name = "需求时间", orderNum = "5", width = 20, format = "yyyy-MM-dd HH:mm:ss")
    private Date demandTime;
    @ApiModelProperty(value = "联系方式")
    @Excel(name = "联系方式", orderNum = "6", width = 20)
    private String contactWay;
    @ApiModelProperty(value = "项目名称")
    @Excel(name = "项目名称", orderNum = "7", width = 20)
    private String projectName;
    @ApiModelProperty(value = "审核状态：1、通过，0、未通过")
    @Excel(name = "审核状态：1、通过，0、未通过", orderNum = "8", width = 15, replace = {"通过_1", "未通过_0"})
    private Integer auditStatus;
    @ApiModelProperty(value = "是否有现场：1、是，0、否；（暖通设备是否可以正常运行）")
    @Excel(name = "是否有现场（暖通设备是否可以正常运行）", orderNum = "9", width = 15, replace = {"是_1", "否_0"})
    private Integer isPresent;
    @ApiModelProperty(value = "申请提交人")
    @Excel(name = "申请提交人手机号", orderNum = "10", width = 20)
    private String createUser;
    @ApiModelProperty(value = "申请提交人姓名")
    @Excel(name = "申请提交人姓名", orderNum = "11", width = 15)
    private String createName;
    @ApiModelProperty(value = "申请提交时间")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @Excel(name = "申请提交时间", orderNum = "12", width = 20, format = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;
    @ApiModelProperty(value = "更新申请人")
    private String updateUser;
    @ApiModelProperty(value = "更新申请人姓名")
    private String updateName;
    @ApiModelProperty(value = "更新时间")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date updateTime;
}

第三步：引入工具类

在项目中引入 EasyPoiUtils.java 工具类。工具类代码详情请查看拓展里的 EasyPoiUtils.java 代码。

第四步：编写导出导入方法

以下分别贴上Controller、Service与ServiceImpl类中的代码：

Controller层中的代码：

@Api(value = "hvacJointApply", tags = "对接申请相关接口")
@RestController
@RequestMapping(value = "/api/joint/apply")
public class HvacJointApplyController extends BaseController {
    @Resource
    private HvacJointApplyService hvacJointApplyService;
    @ApiOperation(value = "导出对接申请")
    @GetMapping("/exportExcel")
    public RestResponse<Nullable> exportWorkOrder(QueryApplyDTO queryApplyDTO, HttpServletResponse response) {
        CurrUserDetails user = getUser();
        RestResponse flag = hvacJointApplyService.exportExcel(user, queryApplyDTO, response);
        return flag;
    }
}

Service层中的代码：

public interface HvacJointApplyService {
    /**
     * 分页查询对接申请列表，用于分页查询对接申请列表
     *
     * @param user          当前登录用户
     * @param queryApplyDTO 查询参数
     * @return 对接申请列表
     */
    Page<HvacJointApplyDTO> pageList(CurrUserDetails user, QueryApplyDTO queryApplyDTO);
    /**
     * 导出对接申请列表
     *
     * @param user          当前登录用户
     * @param queryApplyDTO 查询参数
     * @param response      响应
     * @return 是否导出成功
     */
    RestResponse exportExcel(CurrUserDetails user, QueryApplyDTO queryApplyDTO, HttpServletResponse response);
}

ServiceImpl实现类中的代码：

@Slf4j
@Service
public class HvacJointApplyServiceImpl implements HvacJointApplyService {
    @Resource
    private HvacJointApplyMapper hvacJointApplyMapper;
    @Override
    public Page<HvacJointApplyDTO> pageList(CurrUserDetails user, QueryApplyDTO queryApplyDTO) {
        log.info("E|HvacJointApplyServiceImpl|pageList()|分页对接申请列表，当前登录人【userDetails = {}】", user);
        int pageNum = queryApplyDTO.getPageNum();
        int pageSize = queryApplyDTO.getPageSize();
        PageRequestParams pageRequest = PageRequestParams.of(pageNum, pageSize);
        log.info("E|HvacJointApplyServiceImpl|pageList()|分页对接申请列表，【查询参数 queryApplyDTO = {}】", queryApplyDTO);
        List<HvacJointApply> hvacJointApplyList = hvacJointApplyMapper.pageList(queryApplyDTO, pageRequest);
        Long pageListCount = hvacJointApplyMapper.pageListCount(queryApplyDTO);
        List<HvacJointApplyDTO> jointApplyDTOList = HvacJointApplyDTO.convertToDtoList(hvacJointApplyList);
        Pageable pageable = PageRequest.of(pageNum - 1, pageSize);
        Page<HvacJointApplyDTO> dtoPage = new PageImpl<>(jointApplyDTOList, pageable, pageListCount);
        log.info("E|HvacJointApplyServiceImpl|pageList()|分页查询品牌列表，【查询结果 dtoPage = {}】", dtoPage);
        return dtoPage;
    }
    @Override
    public RestResponse exportExcel(CurrUserDetails user, QueryApplyDTO queryApplyDTO, HttpServletResponse response) {
        log.info("E|HvacJointApplyServiceImpl|exportExcel()|导出对接申请列表，当前登录人【userDetails = {}】", user);
        Page<HvacJointApplyDTO> applyDtoPage = this.pageList(user, queryApplyDTO);
        List<HvacJointApplyDTO> pageContentList = applyDtoPage.getContent();
        // 将pageContentList（Collection类型）的类型转为ArrayList类型
        List<HvacJointApplyDTO> list = new ArrayList<>(pageContentList);
        try {
            EasyPoiUtils.exportExcel(list, "对接申请列表", "对接申请列表",
                    HvacJointApplyDTO.class, "对接申请" + ".xls", response);
            return RestResponse.success(0, "导出对接申请列表成功！", pageContentList);
        } catch (Exception e) {
            log.error("E|HvacJointApplyServiceImpl|exportExcel()|导出对接申请列表失败！【原因 = {}】", e.getMessage());
        }
        return RestResponse.success(-1, "导出对接申请列表失败！", pageContentList);
    }
}

拓展资料：

EasyPoiUtils.java 工具类

package com.iot.daily.common.util;
import cn.afterturn.easypoi.excel.ExcelExportUtil;
import cn.afterturn.easypoi.excel.ExcelImportUtil;
import cn.afterturn.easypoi.excel.entity.ExportParams;
import cn.afterturn.easypoi.excel.entity.ImportParams;
import cn.afterturn.easypoi.excel.entity.enmus.ExcelType;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
/**
 * <p>EasyPoiUtils.java此类用于Excel导入导出</p>
 * <p>@author:lzy</p>
 * <p>@date:2019年1月29日</p>
 * <p>@remark:</p>
 */
@Slf4j
public class EasyPoiUtils {
    /**
     * 功能描述：复杂导出Excel，包括文件名以及表名。创建表头
     *
     * @param list           导出的实体类
     * @param title          表头名称
     * @param sheetName      sheet表名
     * @param pojoClass      映射的实体类
     * @param isCreateHeader 是否创建表头
     * @param fileName
     * @param response
     * @return
     */
    public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,
                                   String fileName, boolean isCreateHeader, HttpServletResponse response) {
        ExportParams exportParams = new ExportParams(title, sheetName);
        exportParams.setCreateHeadRows(isCreateHeader);
        defaultExport(list, pojoClass, fileName, response, exportParams);
    }
    /**
     * 功能描述：复杂导出Excel，包括文件名以及表名,不创建表头
     *
     * @param list      导出的实体类
     * @param title     表头名称
     * @param sheetName sheet表名
     * @param pojoClass 映射的实体类
     * @param fileName
     * @param response
     * @return
     */
    public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,
                                   String fileName, HttpServletResponse response) {
        defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName));
    }
    /**
     * 功能描述：Map 集合导出 多Sheet页 导出
     *
     * @param list     实体集合
     * @param fileName 导出的文件名称
     * @param response
     * @return
     */
    public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
        defaultExport(list, fileName, response);
    }
    /**
     * 功能描述：默认导出方法
     *
     * @param list         导出的实体集合
     * @param fileName     导出的文件名
     * @param pojoClass    pojo实体
     * @param exportParams ExportParams封装实体
     * @param response
     * @return
     */
    private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName,
                                      HttpServletResponse response, ExportParams exportParams) {
        Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);
        if (workbook != null) {
            downLoadExcel(fileName, response, workbook);
        }
    }
    /**
     * 功能描述：Excel导出
     *
     * @param fileName 文件名称
     * @param response
     * @param workbook Excel对象
     * @return
     */
    private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) {
        OutputStream os = null;
        try {
            // 解决文件名中文乱码
            String exportName = new String(fileName.getBytes("UTF-8"), "ISO8859-1");
            // 输出Excel文件
            os = response.getOutputStream();
            response.reset();
            response.setContentType("application/vnd.ms-excel");
            response.setHeader("Content-disposition", "attachment; filename=" + exportName);
            response.setHeader("Pragma", "No-cache");
            workbook.write(os);
            os.close();
        } catch (IOException e) {
            log.error("Excel导出", e);
            throw new RuntimeException(e);
        } finally {
            if (os != null) {
                try {
                    os.close();
                } catch (IOException e) {
                    e.printStackTrace();
                    log.error("IO异常：", e);
                }
            }
        }
    }
    /**
     * 功能描述：默认导出方法
     *
     * @param list     导出的实体集合
     * @param fileName 导出的文件名
     * @param response
     * @return
     */
    private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) {
        Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
        if (workbook != null) {
            downLoadExcel(fileName, response, workbook);
        }
    }
    /**
     * 功能描述：根据文件路径来导入Excel
     *
     * @param filePath   文件路径
     * @param titleRows  表标题的行数
     * @param headerRows 表头行数
     * @param pojoClass  Excel实体类
     * @return
     */
    public static <T> List<T> importExcel(String filePath, Integer titleRows, Integer headerRows, Class<T> pojoClass) {
        //判断文件是否存在
        if (StringUtils.isBlank(filePath)) {
            return null;
        }
        ImportParams params = new ImportParams();
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        List<T> list = null;
        try {
            list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
        } catch (NoSuchElementException e) {
            e.printStackTrace();
            log.error("导入模板不能为空", e);
            throw new RuntimeException("模板不能为空");
        } catch (Exception e) {
            e.printStackTrace();
            log.error("根据文件路径来导入Excel", e);
        }
        return list;
    }
    /**
     * 功能描述：根据接收的Excel文件来导入Excel,并封装成实体类
     *
     * @param file       上传的文件
     * @param titleRows  表标题的行数
     * @param headerRows 表头行数
     * @param pojoClass  Excel实体类
     * @return
     */
    public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass) {
        if (file == null) {
            return null;
        }
        ImportParams params = new ImportParams();
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        List<T> list = null;
        try {
            list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params);
        } catch (NoSuchElementException e) {
            log.error("根据接收的Excel文件来导入Excel:NoSuchElementException,并封装成实体类", e);
            throw new RuntimeException("excel文件不能为空");
        } catch (Exception e) {
            log.error("根据接收的Excel文件来导入Excel,并封装成实体类", e);
            throw new RuntimeException(e.getMessage());
        }
        return list;
    }
    /**
     * 功能描述：根据接收的Excel文件来导入Excel,并封装成实体类
     *
     * @param is         上传的文件
     * @param titleRows  表标题的行数
     * @param headerRows 表头行数
     * @param pojoClass  Excel实体类
     * @param verfiy     是否开启验证
     * @return
     */
    public static <T> List<T> importExcel(InputStream is, Integer titleRows, Integer headerRows, Class<T> pojoClass, boolean verfiy) {
        if (is == null) {
            return null;
        }
        ImportParams params = new ImportParams();
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        params.setNeedVerfiy(verfiy);
        List<T> list = null;
        try {
            list = ExcelImportUtil.importExcel(is, pojoClass, params);
        } catch (NoSuchElementException e) {
            log.error("根据接收的Excel文件来导入Excel:NoSuchElementException,并封装成实体类", e);
            throw new RuntimeException("excel文件不能为空");
        } catch (ClassNotFoundException e) {
            log.error("根据接收的Excel文件来导入Excel,并封装成实体类ClassNotFoundException", e);
            throw new RuntimeException(e.getMessage());
        } catch (Exception e) {
            log.error("根据接收的Excel文件来导入Excel,并封装成实体类", e);
            throw new RuntimeException(e.getMessage());
        }
        return list;
    }
    /**
     * 多sheet封装数据
     *
     * @param data
     * @param entity
     * @param sheetName
     * @return
     */
    public static Map<String, Object> getTestMap(List<?> data, Class<?> entity, String sheetName) {
        Map<String, Object> map = new LinkedHashMap<>();
        map.put("entity", entity);
        ExportParams ep = new ExportParams();
        ep.setSheetName(sheetName);
        map.put("title", ep);
        map.put("data", data);
        return map;
    }
}

 

完结！

 


文章标签：
Java
Maven
关键词：
Java解决方案
Java导出解决方案
excel解决方案
Java EXCEL
Java excel解决方案
No8g攻城狮
目录
相关文章
Codelinghu
|
2月前
|
关系型数据库 MySQL Java
【IDEA】java后台操作mysql数据库驱动常见错误解决方案
【IDEA】java后台操作mysql数据库驱动常见错误解决方案
Codelinghu
76 0
yuanzhengme
|
25天前
|
Java API Apache
Java编程如何读取Word文档里的Excel表格，并在保存文本内容时保留表格的样式？
【10月更文挑战第29天】Java编程如何读取Word文档里的Excel表格，并在保存文本内容时保留表格的样式？
yuanzhengme
105 5
叫个什么名字
|
13天前
|
安全 Java 开发者
Java多线程编程中的常见问题与解决方案
本文深入探讨了Java多线程编程中常见的问题，包括线程安全问题、死锁、竞态条件等，并提供了相应的解决策略。文章首先介绍了多线程的基础知识，随后详细分析了每个问题的产生原因和典型场景，最后提出了实用的解决方案，旨在帮助开发者提高多线程程序的稳定性和性能。
叫个什么名字
50 1
源码星辰
|
19天前
|
人工智能 监控 数据可视化
Java智慧工地信息管理平台源码 智慧工地信息化解决方案SaaS源码 支持二次开发
智慧工地系统是依托物联网、互联网、AI、可视化建立的大数据管理平台，是一种全新的管理模式，能够实现劳务管理、安全施工、绿色施工的智能化和互联网化。围绕施工现场管理的人、机、料、法、环五大维度，以及施工过程管理的进度、质量、安全三大体系为基础应用，实现全面高效的工程管理需求，满足工地多角色、多视角的有效监管，实现工程建设管理的降本增效，为监管平台提供数据支撑。
源码星辰
34 3
最好zzz
|
25天前
|
Java API Apache
Java中Excel导出的高效解决方案：探索JXLS库
【10月更文挑战第29天】
最好zzz
127 2
刘大猫.
|
29天前
|
存储 Java API
Java实现导出多个excel表打包到zip文件中，供客户端另存为窗口下载
Java实现导出多个excel表打包到zip文件中，供客户端另存为窗口下载
刘大猫.
37 4
小王老师呀
|
2月前
|
存储 安全 Java
深入理解Java中的FutureTask：用法和原理
【10月更文挑战第28天】`FutureTask` 是 Java 中 `java.util.concurrent` 包下的一个类，实现了 `RunnableFuture` 接口，支持异步计算和结果获取。它可以作为 `Runnable` 被线程执行，同时通过 `Future` 接口获取计算结果。`FutureTask` 可以基于 `Callable` 或 `Runnable` 创建，常用于多线程环境中执行耗时任务，避免阻塞主线程。任务结果可通过 `get` 方法获取，支持阻塞和非阻塞方式。内部使用 AQS 实现同步机制，确保线程安全。
小王老师呀
57 3
大数据文摘
|
2月前
|
Java
短频快task的java解决方案
本文探讨了Java自带WorkStealingPool的缺陷，特别是在任务中断方面的不足。普通线程池在处理短频快任务时存在锁竞争问题，导致性能损耗。文章提出了一种基于任务窃取机制的优化方案，通过设计合理的窃取逻辑和减少性能损耗，实现了任务的高效执行和资源的充分利用。最后总结了不同场景下应选择的线程池类型。
大数据文摘
38 1
何雨晨
|
2月前
|
存储 前端开发 Java
浅谈Java中文乱码浅析及解决方案
浅谈Java中文乱码浅析及解决方案
何雨晨
78 0
六月的雨在钉钉
|
7月前
|
前端开发 Java
基于Java爬取微博数据(二) 正文长文本+导出数据Excel
【5月更文挑战第12天】基于Java爬取微博数据，正文长文本+导出数据Excel
六月的雨在钉钉
278 5

热门文章

最新文章

  • 1
    【Java】留下没有基础眼泪的面试题
  • 2
    Java实现生产者消费者的四种方法
  • 3
    [零基础学JAVA]Java SE应用部分-35.JAVA类集之四
  • 4
    Java控制内存的功力
  • 5
    对象共享：Java并发环境中的烦心事
  • 6
    Java网络编程：实现HTTP模拟器
  • 7
    Java || 线程 || 大一新生 || 一篇synchronized锁的知识点总结
  • 8
    阿里开发者学院：Java Spring Boot 2.5.x开发实战课程
  • 9
    关于Eclipse提示Failed to create the java virtual machine问题解决办法
  • 10
    java-subString方法易导致内存溢出
  • 1
    java的excel列行合并模版
    45
  • 2
    vue导出excel无法打开问题
    188
  • 3
    aspose实现word，excel等文件预览
    169
  • 4
    java导出复杂excel
    64
  • 5
    excel合并列导出文件
    53
  • 6
    基于jeecgboot的flowable流程任务excel导出功能
    70
  • 7
    C#NPOI操作Excel详解
    860
  • 8
    C# 实现格式化文本导入到Excel
    73
  • 9
    使用JavaScript和XLSX.js将数据导出为Excel文件
    414
  • 10
    DataWorks产品使用合集之在 DataWorks 中将本地数据导入至 Excel 电子表格中如何解决
    123

    • 相关课程

    更多
  • Java面试疑难点解析 - 面试技巧及语言基础
  • Java面试疑难点解析 - Java Web开发
  • Java面试疑难点解析 - 系统架构及项目设计
  • Java编程入门
  • Java面向对象编程
  • Java高级编程

    • 相关电子书

    更多
  • Spring Cloud Alibaba - 重新定义 Java Cloud-Native
  • The Reactive Cloud Native Arch
  • JAVA开发手册1.5.0

    • 相关实验场景

    更多
  • 阿里云平台上进行Java程序的编译与运行
  • 使用Java面向对象编写网络通信程序应用
  • 手动部署Java Web环境（Alibaba Cloud Linux 2）
  • 搭建Java Web开发环境（Anolis OS）
  • RocketMQ中使用Java客户端发送消息和消费的应用
  • 部署基于Dragonwell的Java运行环境
    • 下一篇
    阿里云无影云电脑免费试用，最长可试用3个月