easypoi导出

已于 2023-02-14 10:36:29 修改
阅读量704 收藏 1
点赞数 1
分类专栏： excel导出导入 文章标签： 学习 excel
于 2022-10-20 16:14:15 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_46360888/article/details/127429137
版权
本文详细介绍了Easypoi框架的使用，包括jar包引入、注解@Excel、@ExcelCollection、@ExcelEntity等的解析和功能。通过示例展示了如何进行Excel的一对一、一对多导出，以及大数据量导出。同时还提供了多个sheet导出和自定义列头的实现方法，适合需要进行Excel操作的开发者参考。
摘要由CSDN通过智能技术生成

官方文档：easypoi
1.jar坐标

<!-- https://mvnrepository.com/artifact/cn.afterturn/easypoi-spring-boot-starter -->
		<dependency>
			<groupId>cn.afterturn</groupId>
			<artifactId>easypoi-spring-boot-starter</artifactId>
			<version>4.4.0</version>
		</dependency>

2.注释：
2.1.@Excel

属性类型默认值功能
nameStringnull列名,支持name_id
needMergebooleanfasle是否需要纵向合并单元格(用于含有list中,单个的单元格,合并list创建的多个row)
orderNumString“0”列的排序,支持name_id
replaceString[]{}值得替换 导出是{a_id,b_id} 导入反过来
savePathString“upload”导入文件保存路径,如果是图片可以填写,默认是upload/className/ IconEntity这个类对应的就是upload/Icon/
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[]{}合并单元格依赖关系,比如第二列合并是基于第一列 则{0}就可以了
mergeVerticalbooleanfasle纵向合并内容相同的单元格
fixedIndexint-1对应excel的列,忽略名字
isColumnHiddenbooleanfalse导出隐藏列

2.@ExcelCollection

属性类型默认值功能
idStringnull定义ID
nameStringnull定义集合列名,支持nanm_id
orderNumint0排序,支持name_id
typeClass<?>ArrayList.class导入时创建对象使用

3.@ExcelEntity

属性类型默认值功能
idStringnull定义ID

4.@ExcelIgnore
忽略这个属性,多使用需循环引用中,无需多解释吧^^

5.@ExcelTarget：限定一个到处实体的注解,以及一些通用设置,作用于最外面的实体

属性类型默认值功能
valueStringnull定义ID
heightdouble10设置行高
fontSizeshort11设置文字大小

6.使用举例
6.1:控制层

package com.example.demo.controller;


import cn.afterturn.easypoi.excel.ExcelExportUtil;
import cn.afterturn.easypoi.excel.entity.ExportParams;
import cn.afterturn.easypoi.excel.entity.params.ExcelExportEntity;
import cn.afterturn.easypoi.handler.inter.IWriter;
import com.example.demo.dto.Class;
import com.example.demo.dto.Class1;
import com.example.demo.dto.Student;
import com.google.common.collect.Lists;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.apache.poi.ss.usermodel.Workbook;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;

/**
 * @author leishen
 */
@RestController
@RequestMapping("easypoi/")
@Api(tags = "测试easypoi")
public class EasyPoiExportController {


    /**
     * 使用@Excel注解
     * entity – 表格标题属性
     * pojoClass – Excel对象Class
     * dataSet – Excel对象数据List
     * exportExcel(ExportParams entity, Class<?> pojoClass,Collection<?> dataSet)
     * @param response
     * @throws IOException
     */
    @ApiOperation("一对一导出方法1")
    @GetMapping("test1")
    public void test1(HttpServletResponse response) throws IOException {
        List<Class1> class1List= Lists.newLinkedList();
        Class1 class1=new Class1(1,"1",new Date());
        class1List.add(class1);
        class1=new Class1(2,"2",new Date());
        class1List.add(class1);
        //设置表头
        ExportParams exportParams = new ExportParams();
        exportParams.setTitle("班级信息表");
        Workbook workbook = ExcelExportUtil.exportExcel(exportParams, Class1.class, class1List);
        String fileName="测试.xlsx";
        exportExcel(response, workbook, fileName);
    }

    /**
     *
     * entity – 表格标题属性
     *                                             导出的表格列名  属性名称   列宽
     * entityList – Map对象列表  ExcelExportEntity(String name, Object key, int width)
     * dataSet – Excel对象数据List
     * exportExcel(ExportParams entity, List<ExcelExportEntity> entityList,Collection<?> dataSet)
     * @param response
     * @throws IOException
     */
    @ApiOperation("一对一导出方法2")
    @GetMapping("test12")
    public void test12(HttpServletResponse response) throws IOException {
        List<Class1> class1List= Lists.newLinkedList();
        Class1 class1=new Class1(1,"一年级",new Date());
        class1List.add(class1);
        class1=new Class1(2,"二年级",new Date());
        class1List.add(class1);
        List<ExcelExportEntity> entityList=new ArrayList<>();
        entityList.add(new ExcelExportEntity("班级序号1","classId",20));
        entityList.add(new ExcelExportEntity("班级名称2","name",20));
        //设置表头
        ExportParams exportParams = new ExportParams();
        exportParams.setTitle("班级信息表");
        Workbook workbook = ExcelExportUtil.exportExcel(exportParams, entityList, class1List);
        String fileName="测试.xlsx";
        exportExcel(response, workbook, fileName);
    }

    /**
     * 使用@Excel、@ExcelCollection注解
     * entity – 表格标题属性
     * pojoClass – Excel对象Class
     * dataSet – Excel对象数据List
     * exportExcel(ExportParams entity, Class<?> pojoClass,Collection<?> dataSet)
     * @param response
     * @throws IOException
     */
    @ApiOperation("一对多导出方法")
    @GetMapping("test21")
    public void test21(HttpServletResponse response) throws IOException {
        List<Class> classList= Lists.newLinkedList();
        List<Student> studentList=Lists.newArrayList();
        Student student=new Student("张三",20,"0");
        studentList.add(student);
        student=new Student("李四",21,"1");
        studentList.add(student);
        classList.add(new Class(1, "一年级", studentList));
        classList.add(new Class(2, "二年级", studentList));
        Workbook workbook = ExcelExportUtil.exportExcel(new ExportParams("班级详情","111"), Class.class, classList);
        String fileName="测试.xlsx";
        exportExcel(response, workbook, fileName);
    }
    
    /**
     * 导出多个不同列头的sheet
     * @param response
     * @throws IOException
     */
    @ApiOperation("多个sheet")
    @GetMapping("many")
    public void many(HttpServletResponse response) throws IOException {
        List<Class> classList= Lists.newLinkedList();
        List<Student> studentList=Lists.newArrayList();
        Student student=new Student("张三",20,"0");
        studentList.add(student);
        student=new Student("李四",21,"1");
        studentList.add(student);
        classList.add(new Class(1, "一年级", studentList));
        classList.add(new Class(2, "二年级", studentList));

        List<Map<String, Object>> list=Lists.newArrayList();
        Map<String, List<Class>> classMap = classList.stream().collect(Collectors.groupingBy(Class::getName));
        classMap.forEach((k,v)->{
            Map<String, Object> map= Maps.newHashMap();
            map.put("data", v);
            ExportParams params = new ExportParams(null, k, ExcelType.XSSF);
            if ("一年级".equals(k)) {
                //排除哪些列不导出
                params.setExclusions(new String[]{"班级序号"});
            }
            map.put("title",params);
            map.put("entity",Class.class);
            list.add(map);
        });
        Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.XSSF);
        String fileName="测试.xlsx";
        exportExcel(response, workbook, fileName);
    }

    @ApiOperation("大数据量导出")
    @GetMapping("test3")
    public void test3(HttpServletResponse response) throws IOException {
        List<Class> classList= Lists.newLinkedList();
        List<Student> studentList=Lists.newArrayList();
        Student student=new Student("张三",20,"男");
        studentList.add(student);
        student=new Student("李四",21,"女");
        studentList.add(student);
        classList.add(new Class(1, "一年级", studentList));
        classList.add(new Class(2, "二年级", studentList));
        IWriter<Workbook> workbookIWriter = ExcelExportUtil.exportBigExcel(new ExportParams(), Class.class);
        workbookIWriter.write(classList);
        String fileName="测试.xlsx";
        exportExcel(response, workbookIWriter.get(), fileName);
    }




    /**
     * 下载文件
     * @param response
     * @param workbook
     * @param fileName 文件名
     * @throws IOException
     */
    private static void exportExcel(HttpServletResponse response, Workbook workbook, String fileName) throws IOException {
        response.setCharacterEncoding("UTF-8");
        // 设置响应输出的头类型
        response.setHeader("content-Type", "application/vnd.ms-excel");
        // 下载文件的默认名称
        response.setHeader("Content-Disposition", "attachment;filename="+ URLEncoder.encode(fileName, "UTF-8"));
        OutputStream out = response.getOutputStream();
        workbook.write(out);
        out.flush();
        out.close();
    }
}

6.2.实体类

package com.example.demo.dto;


import cn.afterturn.easypoi.excel.annotation.Excel;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;

@Data
@ApiModel(value = "班级")
@AllArgsConstructor
@NoArgsConstructor
public class Class1 {

    /**
     * 班级id
     */
    @ApiModelProperty(value = "班级id")
    @Excel(name = "班级序号",width = 20)
    private Integer classId;

    /**
     * replace = {"一年级_1","2_二年级"}--->导出是用一年级替换1，用二年级替换2
     * 班级名称
     */
    @ApiModelProperty(value = "班级名称")
    @Excel(name = "班级名称",width = 20,replace = {"一年级_1","二年级_2"})
    private String name;


    /**
     * 创建时间
     */
    @ApiModelProperty(value = "创建时间")
    @Excel(name = "时间",format = "yyyy-MM-dd HH:mm:ss",width = 20)
    private Date createDate;
}

package com.example.demo.dto;


import cn.afterturn.easypoi.excel.annotation.Excel;
import io.swagger.annotations.ApiModel;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@ApiModel("学生")
@AllArgsConstructor
@NoArgsConstructor
public class Student {

    @Excel(name = "姓名",width = 15)
    private String name;

    @Excel(name = "年龄",width = 15)
    private Integer age;

    /**
     * replace ={"男_0","女_1"}-->
     */
    @Excel(name = "性别",width = 15,replace ={"男_0","女_1"})
    private String sex;
}

package com.example.demo.dto;


import cn.afterturn.easypoi.excel.annotation.Excel;
import cn.afterturn.easypoi.excel.annotation.ExcelCollection;
import cn.afterturn.easypoi.excel.annotation.ExcelIgnore;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;
import java.util.List;

@Data
@ApiModel(value = "班级")
@AllArgsConstructor
@NoArgsConstructor
public class Class {

    /**
     * 班级id
     */
    @ApiModelProperty(value = "班级id")
    @Excel(name = "班级序号",width = 20,needMerge = true)
    //不导出== new ExportParams().setExclusions(new String[]{"班级序号"});
    //@ExcelIgnore
    private Integer classId;

    /**
     * 班级名称
     */
    @ApiModelProperty(value = "班级名称")
    @Excel(name = "班级名称",width = 20,needMerge = true)
    private String name;

    @ExcelCollection(name = "学生列表")
    private List<Student> studentList;
}
shmily&&ylimhs
关注
专栏目录
Java Excel导出(包含图片) —— Easypoi
一位帅小伙的博客
05-19 1911
Java Excel导出(包含图片) —— Easypoi Easypoi官网文档：http://doc.wupaas.com/docs/easypoi/easypoi-1c0u6ksp2r091 一、添加 依赖 <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-base</artifactId>
easypoi 导出word并插入echart图片和文件
06-27
在本场景中，我们关注的是如何使用Easypoi导出Word文档，并且在这个文档中插入Echarts生成的图表以及附加文件。Echarts是一个流行的JavaScript数据可视化库，它提供了丰富的图表类型和强大的交互功能，常用于网页...
java导出excel（带图片）
陈一一同学的博客
03-17 6909
先看一下导出效果，
easypoi 导出文本图片Excel
康__的博客
10-12 5665
easypoi 导出文本图片Excel
easypoi 导出图片
f的博客
06-09 2025
使用easypoi导出带有图片的excel文件
EasyPoi导出图片
大话家的博客
09-23 6826
aaa
easypoi导出工具
11-05
easypoi常用导入，导出，工具，引入easypoi包ExcelUtil工具类，可以直接导出查询的数据
使用EasyPOI导出Excel模板数据（含图片）博文源码
09-25
这篇博文的源码提供了一个使用EasyPOI导出包含图片的Excel模板数据的示例，这在报表生成、数据分析和报告制作等场景中非常实用。 首先，我们来看看`ExcelTemplateExportUtil.java`，这个类是导出工具的核心，它实现...
若依使用easypoi导出word文档.docx
04-26
在本场景中，我们将探讨如何使用Easypoi库来实现导出Word文档的功能。Easypoi是一个强大的Java办公组件，能够方便地处理Excel和Word文档，尤其适合于数据批量导入导出和模板生成。 首先，我们需要在项目的`pom.xml`...
easyPOI导出.rar
07-18
【标题】"easyPOI导出.rar"是一个与Java编程相关的压缩包，它包含了使用easyPOI库进行Excel数据导出的功能。EasyPOI是一款基于Apache POI的简化版工具，用于处理Microsoft Office文档，尤其是Excel文件。在Java中，...
JAVA poi 做EXCEL导出(包含图片) 完整版
12-17
需要使用JAVA 做EXCEL导出的同学，有问题尽管私信
java导出图片到excel
10-13
java导出内容以及图片到execl中，由于客户的骚需求，不得不进行一些不情愿的开发。文档仅供思路参考。谢谢
Java导出Excel 带图片
weixin_56233175的博客
02-19 443
【代码】Java导出Excel 带图片。
java导出带图片excel
热门推荐
IT从业者
04-08 2万+
1.导出excel文件效果 2.说明 先要制作一个空的excel模板（也可以全由代码写成，使用excel模板的好处是，不用代码去实现复杂的排版，只需要填写内容就可），注意文件内容不能太大，否则在生成图片时可能会导致内存溢出（内容非常多的建议不要导出带图片的）。 <!-- poi处理 --> <dependency> <groupId>org.apache.poi</groupId> <artifactId&gt...
java导出excel包含图片
xiao190128的专栏
06-09 1461
最近有需要导出用户留言的数据，包含用户留言的上传的照片 在网上找了很多，整合一些，最后实现了业务，导出来有点丑，后续再做优化，代码功能有局限性，看到的小伙伴如果有好的想法可以说说，让我学习学习 最后实现的效果（似乎一个格子不能放多张图片？） 直接上代码： 导入...
Java导出excel带图片（希望能帮助你们节省时间）
最新发布
weixin_44050355的博客
05-29 1052
【代码】Java导出excel带图片（希望能帮助你们节省时间）
Java导出Excel里包含图片(包括GIF)
qianqia_n的博客
05-11 7616
poi导出excel图片
easypoi导出excel时导出图片
来自外太空的鱼-张小张
06-16 415
easypoi导出excel时导出图片
easypoi导出模板
05-09
其中，Easypoi导出模板功能是Easypoi的一项重要特性。它可以根据事先设定好的模板结构，将数据进行规范化的导出。 Easypoi导出模板功能的基本流程如下： 1. 定义导出模板的数据结构 2. 在模板中定义表头、表体等...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值