easyPoi使用教程

最新推荐文章于 2024-08-21 08:37:52 发布
最新推荐文章于 2024-08-21 08:37:52 发布
阅读量3.6k 收藏 6
点赞数 1
分类专栏： 代码文档 文章标签： Java POI Excel servlet web java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/han949417140/article/details/107222958
版权
  1. 添加pom.xml依赖
<dependency>
    <groupId>cn.afterturn</groupId>
    <artifactId>easypoi-spring-boot-starter</artifactId>
    <version>4.1.0</version>
</dependency>
  1. ExcelUtils导入导出excel工具类
package com.yss.dataMiddle.utils;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URLEncoder;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;

import javax.servlet.http.HttpServletResponse;

import org.apache.commons.lang3.StringUtils;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.web.multipart.MultipartFile;

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;

public class ExcelUtils {

    /**
     * excel 导出
     *
     * @param list           数据
     * @param title          标题
     * @param sheetName      sheet名称
     * @param pojoClass      pojo类型
     * @param fileName       文件名称
     * @param isCreateHeader 是否创建表头
     * @param response
     */
    public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName,
                                   boolean isCreateHeader, HttpServletResponse response) throws IOException {
        ExportParams exportParams = new ExportParams(title, sheetName, ExcelType.XSSF);
        exportParams.setCreateHeadRows(isCreateHeader);
        defaultExport(list, pojoClass, fileName, response, exportParams);
    }

    /**
     * excel 导出
     *
     * @param list      数据
     * @param title     标题
     * @param sheetName sheet名称
     * @param pojoClass pojo类型
     * @param fileName  文件名称
     * @param response
     */
    public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass, String fileName,
                                   HttpServletResponse response) throws IOException {
        defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName, ExcelType.XSSF));
    }

    /**
     * excel 导出
     *
     * @param list         数据
     * @param pojoClass    pojo类型
     * @param fileName     文件名称
     * @param response
     * @param exportParams 导出参数
     */
    public static void exportExcel(List<?> list, Class<?> pojoClass, String fileName, ExportParams exportParams,
                                   HttpServletResponse response) throws IOException {
        defaultExport(list, pojoClass, fileName, response, exportParams);
    }

    /**
     * excel 导出
     *
     * @param list     数据
     * @param fileName 文件名称
     * @param response
     */
    public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response)
            throws IOException {
        defaultExport(list, fileName, response);
    }

    /**
     * 默认的 excel 导出
     *
     * @param list         数据
     * @param pojoClass    pojo类型
     * @param fileName     文件名称
     * @param response
     * @param exportParams 导出参数
     */
    private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response,
                                      ExportParams exportParams) throws IOException {
        Workbook workbook = ExcelExportUtil.exportExcel(exportParams, pojoClass, list);
        downLoadExcel(fileName, response, workbook);
    }

    /**
     * 默认的 excel 导出
     *
     * @param list     数据
     * @param fileName 文件名称
     * @param response
     */
    private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response)
            throws IOException {
        Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF);
        downLoadExcel(fileName, response, workbook);
    }

    /**
     * 下载
     *
     * @param fileName 文件名称
     * @param response
     * @param workbook excel数据
     */
    private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook)
            throws IOException {
        try {
            response.setCharacterEncoding("UTF-8");
            response.setHeader("content-Type", "application/vnd.ms-excel");
            response.setHeader("Content-Disposition", "attachment;filename="
                    + URLEncoder.encode(fileName + "." + ExcelTypeEnum.XLSX.getValue(), "UTF-8"));
            workbook.write(response.getOutputStream());
        } catch (Exception e) {
            throw new IOException(e.getMessage());
        }
    }

    /**
     * excel 导入
     *
     * @param filePath   excel文件路径
     * @param titleRows  标题行
     * @param headerRows 表头行
     * @param pojoClass  pojo类型
     * @param <T>
     * @return
     */
    public static <T> List<T> importExcel(String filePath, Integer titleRows, Integer headerRows, Class<T> pojoClass)
            throws IOException {
        if (StringUtils.isBlank(filePath)) {
            return null;
        }
        ImportParams params = new ImportParams();
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        params.setNeedSave(true);
        params.setSaveUrl("/excel/");
        try {
            return ExcelImportUtil.importExcel(new File(filePath), pojoClass, params);
        } catch (NoSuchElementException e) {
            throw new IOException("模板不能为空");
        } catch (Exception e) {
            throw new IOException(e.getMessage());
        }
    }

    /**
     * excel 导入
     *
     * @param file      excel文件
     * @param pojoClass pojo类型
     * @param <T>
     * @return
     */
    public static <T> List<T> importExcel(MultipartFile file, Class<T> pojoClass) throws IOException {
        return importExcel(file, 1, 1, pojoClass);
    }

    /**
     * excel 导入
     *
     * @param file       excel文件
     * @param titleRows  标题行
     * @param headerRows 表头行
     * @param pojoClass  pojo类型
     * @param <T>
     * @return
     */
    public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass)
            throws IOException {
        return importExcel(file, titleRows, headerRows, false, pojoClass);
    }

    /**
     * excel 导入
     *
     * @param file       上传的文件
     * @param titleRows  标题行
     * @param headerRows 表头行
     * @param needVerfiy 是否检验excel内容
     * @param pojoClass  pojo类型
     * @param <T>
     * @return
     */
    public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, boolean needVerfiy,
                                          Class<T> pojoClass) throws IOException {
        if (file == null) {
            return null;
        }
        try {
            return importExcel(file.getInputStream(), titleRows, headerRows, needVerfiy, pojoClass);
        } catch (Exception e) {
            throw new IOException(e.getMessage());
        }
    }

    /**
     * excel 导入
     *
     * @param inputStream 文件输入流
     * @param titleRows   标题行
     * @param headerRows  表头行
     * @param needVerify  是否检验excel内容
     * @param pojoClass   pojo类型
     * @param <T>
     * @return
     */
    public static <T> List<T> importExcel(InputStream inputStream, Integer titleRows, Integer headerRows,
                                          boolean needVerify, Class<T> pojoClass) throws IOException {
        if (inputStream == null) {
            return null;
        }
        ImportParams params = new ImportParams();
        params.setTitleRows(titleRows);
        params.setHeadRows(headerRows);
        params.setSaveUrl("/excel/");
        params.setNeedSave(true);
        params.setNeedVerify(needVerify);
        try {
            return ExcelImportUtil.importExcel(inputStream, pojoClass, params);
        } catch (NoSuchElementException e) {
            throw new IOException("excel文件不能为空");
        } catch (Exception e) {
            throw new IOException(e.getMessage());
        }
    }

    /**
     * Excel 类型枚举
     */
    enum ExcelTypeEnum {
        XLS("xls"), XLSX("xlsx");
        private String value;

        ExcelTypeEnum(String value) {
            this.value = value;
        }

        public String getValue() {
            return value;
        }

        public void setValue(String value) {
            this.value = value;
        }
    }

}
  1. 实体类添加注解@Excel
package com.yss.dataMiddle.entity;

import cn.afterturn.easypoi.excel.annotation.Excel;
import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import java.util.Date;
import com.baomidou.mybatisplus.annotation.TableId;
import java.io.Serializable;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

/**
 * <p>
 * 表分类
 * </p>
 *
 * @author Han LiDong
 * @since 2020-07-08
 */
@TableName("p_table_category")
@ApiModel(value="PTableCategory对象", description="表分类")
public class PTableCategory extends Model<PTableCategory> {

    private static final long serialVersionUID = 1L;

    @ApiModelProperty(value = "id")
    @TableId(value = "id", type = IdType.INPUT)
    @Excel(name = "id", orderNum = "1", width = 15)
    private Integer id;

    @Excel(name = "分类名称", orderNum = "2", width = 15)
    @ApiModelProperty(value = "分类名称")
    private String categoryName;

    @Excel(name = "分类编码", orderNum = "3", width = 15)
    @ApiModelProperty(value = "分类编码")
    private String categoryCode;

    @Excel(name = "排序", orderNum = "4", width = 15)
    @ApiModelProperty(value = "排序")
    private Integer categorySort;

    @Excel(name = "状态", orderNum = "5", width = 15)
    @ApiModelProperty(value = "状态")
    private String status;

    @Excel(name = "优先数据源", orderNum = "6", width = 15)
    @ApiModelProperty(value = "优先数据源")
    private String priorityData;

    @Excel(name = "备注", orderNum = "7", width = 15)
    @ApiModelProperty(value = "备注")
    private String remarks;

    @Excel(name = "创建时间", orderNum = "8", width = 15)
    @ApiModelProperty(value = "创建时间")
    private Date createTime;

    @Excel(name = "更新时间", orderNum = "9", width = 15)
    @ApiModelProperty(value = "更新时间")
    private Date updateTime;

    @Excel(name = "删除标志", orderNum = "10", width = 15)
    @ApiModelProperty(value = "删除标志")
    private String delFlag;


    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }
    public String getCategoryName() {
        return categoryName;
    }

    public void setCategoryName(String categoryName) {
        this.categoryName = categoryName;
    }
    public String getCategoryCode() {
        return categoryCode;
    }

    public void setCategoryCode(String categoryCode) {
        this.categoryCode = categoryCode;
    }
    public Integer getCategorySort() {
        return categorySort;
    }

    public void setCategorySort(Integer categorySort) {
        this.categorySort = categorySort;
    }
    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }
    public String getPriorityData() {
        return priorityData;
    }

    public void setPriorityData(String priorityData) {
        this.priorityData = priorityData;
    }
    public String getRemarks() {
        return remarks;
    }

    public void setRemarks(String remarks) {
        this.remarks = remarks;
    }
    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }
    public Date getUpdateTime() {
        return updateTime;
    }

    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }
    public String getDelFlag() {
        return delFlag;
    }

    public void setDelFlag(String delFlag) {
        this.delFlag = delFlag;
    }

    @Override
    protected Serializable pkVal() {
        return this.id;
    }

    @Override
    public String toString() {
        return "PTableCategory{" +
        "id=" + id +
        ", categoryName=" + categoryName +
        ", categoryCode=" + categoryCode +
        ", categorySort=" + categorySort +
        ", status=" + status +
        ", priorityData=" + priorityData +
        ", remarks=" + remarks +
        ", createTime=" + createTime +
        ", updateTime=" + updateTime +
        ", delFlag=" + delFlag +
        "}";
    }
}
  1. 接口调用生成excel并下载
    @ApiOperation(value="easyExcel测试",notes="easyExcel测试")
    @ApiImplicitParams({
            @ApiImplicitParam(name="id",value="主键",required=true,paramType="query")
    })
    @GetMapping("/easyExcel")
    public void exportExcel(@RequestParam("id")Integer id, HttpServletResponse response) throws IOException {
        List<Integer> list = new ArrayList<>();
        list.add(id);

        List<PTableCategory> categorys = (List<PTableCategory>) pTableCategoryService.listByIds(list);

        List<String> titles = Arrays.asList("主键","分类名称","分类编码","排序","状态","优先数据源","备注","创建时间","更新时间","删除标志");


        ExcelUtils.exportExcel(categorys, "员工信息", "员工信息sheet", PTableCategory.class, "员工信息表", response);

        //ExcelUtils.exportExcel(categorys,"hld", "sheet00",PTableCategory.class,"hldtt",true,response);

参考文章：EasyPoi使用教程

易佰菜鸟
关注
专栏目录
EasyPoi的使用教程以及如何集成入SpringMVC中（详细）
01-17
作为JAVA操作excel表，easypoi首当其冲是具有话语权的，业界使用easypoi的项目数不胜数，如同它的名字一样，非常的简单。整合进入springMVC也是方便快捷
EasyPoi教程
07-20
EasyPoi经典教程 easypoi功能如同名字easy,主打的功能就是容易,让一个没见接触过poi的人员 就可以方便的写出Excel导出,Excel模板导出,Excel导入,Word模板导出,通过简单的注解和模板 语言(熟悉的表达式语法),完成以前...
Java导出ExportParams设置某列颜色
weixin_40319738的博客
07-10 122
Java导出ExportParams设置某列颜色 在使用Java进行数据导出时，我们通常会使用EasyExcel、POI等工具来实现，其中EasyExcel是一款非常强大且易于使用的Java Excel导出工具。在导出Excel文件时，我们有时需要设置某些列的颜色以进行区分或突出显示。本文将介绍如何使用EasyExcel中...
Easypoi使用手册
最新发布
gitblog_00457的博客
08-21 348
Easypoi使用手册 easypoiPOI tool, excel quick import and export, excel template export, word template export, can complete the import and export of Excel in only 5 lines of code, the modification and expo...
EasyPOI使用教程
喬峯焘的博客
07-26 1244
Java EasyPOI使用教程Excel导出1、添加注解类2、引入style3、获取Workbook4、导出Excel5、另外这块再说下背景色6、不多说了 看结果 Excel导出 处女篇 请多支持，3Q！ 1、添加注解类 关于EasyPOI的注解说明 @Excel 作用到filed上面,是对Excel一列的一个描述 @ExcelCollection表示一个集合,主要针对一对多的导出,比如一个老师对应多个科目,科目就可以用集合表示 @ExcelEntity 表示一个继续深入导出的实体,但他没有太多的
EasyPOI 使用教程
一个摩羯座的程序猿
08-28 8044
目录 1. 前传 1.1 前言 1.2 Easypoi介绍 1.3 使用 1.4 测试项目 1.5 可能存在的小坑 2. Excel 注解版 2.1 Excel导入导出 2.2 注解 2.3 注解导出,导入 2.3.1 对象定义 2.3.2 集合定义 2.3.3 图片的导出 2.3.4 Excel导入介绍 2.3.5 Excel导入小功能 2.3.6 图片的导入 2.3.7 Excel多Sheet导出 2.4 注解变种-更自由的导出 2.5 Map导入,自由发挥 2.
EasyPoi 教程
m0_58680865的博客
03-10 9488
文章目录EasyPoi教程文档1. 前传1.1 前言这个服务即将关闭,文档迁移到 http://www.wupaas.com/ 请大家访问最新网站1.2 Easypoi介绍1.3 使用1.4 测试项目1.5 可能存在的小坑2. Excel 注解版2.1 Excel导入导出2.2 注解注解介绍@ExcelTarget@ExcelEntity@ExcelCollection@ExcelIgnore2.3 注解导出,导入2.3.1 对象定义2.3.2 集合定义2.3.3 图片的导出2.3.4 Excel导入介绍2
EasyPoi教程.pdf
09-30
EasyPoi教程.pdf EasyPoi是一款Java库，用于简化Excel、Word、PDF和HTML文件的导入和导出操作。下面是对EasyPoi教程的总结和知识点提炼： 一、EasyPoi简介 EasyPoi是一款开源的Java库，由JueYue开发，旨在简化...
easypoi教程总结
12-03
easypoi教程总结为我们提供了关于easypoi的详细使用教程，涵盖了Excel、Word、HTML、PDF等多种文档的导出和导入操作，以及与Spring MVC框架的集成。通过学习本教程，我们可以快速掌握easypoi的使用，并应用于实际...
EasyPOI实战教程
ctflq的博客
04-12 2099
EasyPOI示例代码
EasyPoi教程_V1.0.html
05-13
EasyPoi教程_V1.0.html
Spring Boot 系列教程 EasyPoi导出Excel下载
12-01
Spring Boot 系列教程 EasyPoi导出Excel下载
EasyPoi-教程
qq_31362933的博客
01-04 1752
easypoi功能如同名字easy,主打的功能就是容易,让一个没见接触过poi的人员就可以方便的写出Excel导出,Excel模板导出,Excel导入,Word模板导出,通过简单的注解和模板语言(熟悉的表达式语法),完成以前复杂的写法**Easypoi 为谁而开发不太熟悉poi的不想写太多重复太多的只是简单的导入导出的喜欢使用模板的都可以使用easypoiEasypoi的目标是什么。
EasyPOI入门
Casual_Lei的博客
06-26 2489
EasyPOI是一个基于Apache POI的Java库，用于简化Excel文档的导入和导出操作。EasyPOI通过注解的方式，极大地减少了代码量和复杂度，使得Excel操作变得更加简单直观。本篇博客将介绍如何使用EasyPOI进行Excel文件的导入和导出操作。通过上述步骤，您可以在 Spring Boot 项目中轻松集成并使用 EasyPOI 来处理 Excel 文件。EasyPOI 提供了丰富的注解和简化的 API，使得 Excel 操作变得更加方便和高效。
EasyPOI实战入门
Java_Fly1的博客
12-02 2017
EasyPOI实战入门入门案例导出
easyPOI基本用法详解
qq_43842093的博客
12-18 5610
文章目录easyPOI基本用法1.Excel文件的简单导入和导出1.1准备工作1.2导入1.3导出1.4图片的导出1.5图片的导入1.6excel模板导出文件1.7excel转html2.Word文件导出2.1使用word模板导出2.2使用word模板导出多页3.excel导入时验证3.1环境准备3.2实战演练3.3注意事项 easyPOI基本用法 参考网址：http://www.wupaas.com/ 1.Excel文件的简单导入和导出 项目源码：https://github.com/zhongyushi
easypoi教程_EasyPoi教程
weixin_39600291的博客
12-22 63
.可编辑简要教程目录简要教程...........................................................................................................................................1前面的话.............................................
EasyPoi教程：快速上手Excel与Word导出与导入
EasyPoi教程V1.0是一个专为不太熟悉POI API、希望进行简单数据导入导出操作，并倾向于使用模板的开发人员设计的工具。它旨在简化在Java中处理Excel（支持xls和xlsx格式）和Word（仅支持docx）文件的操作，特别是通过...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值