基于Springboot使用EasyExcel实现Excel操作

最新推荐文章于 2024-07-25 22:33:38 发布
最新推荐文章于 2024-07-25 22:33:38 发布
阅读量418 收藏 1
点赞数 3
文章标签： spring boot excel 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yyb1369584682/article/details/132859033
版权

EasyExcel使用

一、简介

EasyExcel是一个基于Java的、快速、简洁、解决大文件内存溢出的Excel处理工具。他能让你在不用考虑性能、内存的等因素的情况下，快速完成Excel的读、写等功能。EasyExcel官方文档地址（https://easyexcel.opensource.alibaba.com/）

二、使用

1、引入依赖

    <dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>easyexcel</artifactId>
			<version>3.1.1</version>
	</dependency>

2、创建实体类

package com.genersoft.iot.vmp.info.entity;

import com.alibaba.excel.annotation.ExcelIgnore;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.write.style.ColumnWidth;
import com.genersoft.iot.vmp.info.utils.ExcelSelected;
import com.genersoft.iot.vmp.info.utils.HouseStatusConverter;
import com.genersoft.iot.vmp.info.utils.TypeConverter;
import io.swagger.v3.oas.annotations.media.Schema;
import org.springframework.data.annotation.Transient;

import java.util.List;

/**
 * @author xxx
 * @date 2023年04月03日 9:57
 *
 * 房屋基本信息表
 */

@ColumnWidth(12)
public class HouseBaseinfo {

    @Schema(description = "主键")
    @ExcelIgnore
    private Integer id;

    @Schema(description = "市级智慧小区ID")
    @ExcelIgnore
    private String communityId;

    @Transient
    @Schema(description = "市级平台内小区id")
    @ExcelProperty(index = 0,value = "小区名称")
    private String communityName;

    @Schema(description = "唯一标识（hash值）")
    @ExcelIgnore
    private String evtId;

    @Schema(description = "楼栋号")
    @ExcelProperty(index = 1,value = "楼栋号")
    private Integer number;

    @Schema(description = "单元号")
    @ExcelProperty(index = 2,value = "单元号")
    private Integer unit;

    @Schema(description = "楼层")
    @ExcelProperty(index = 3,value = "楼层")
    private Integer floor;

    @Schema(description = "门牌号")
    @ExcelProperty(index = 4,value = "门牌号")
    private Integer room;

    @Schema(description = "居住现状（1、自用 2、租用 3、自住 4、借用 5、空置 6、家庭租住 7、群租）")
    @ExcelSelected(source = {"自用","租用","自住","借用","空置","家庭租住","群租"})
    @ExcelProperty(index = 5,value = "居住现状",converter = HouseStatusConverter.class)
    private Integer status;

    @ExcelSelected(source = {"单元(公寓)楼","简子楼","别墅","平房","自建楼","四合院","其他"})
    @Schema(description = "房屋类别（1、单元(公寓)楼 2、简子楼 3、别墅 4、平房 5、自建楼 6、四合院 7、其他）")
    @ExcelProperty(index = 6,value = "房屋类别",converter = TypeConverter.class)
    private Integer type;

    @Schema(description = "房屋间数")
    @ExcelProperty(index = 7,value = "房屋间数")
    private Integer bedRoom;

    @Schema(description = "房屋面积")
    @ExcelProperty(index = 8,value = "房屋面积")
    private Integer area;

    @Schema(description = "实有人口")
    @ExcelProperty(index = 9,value = "实有人口")
    private Integer people;

    @Schema(description = "标准地址")
    @ExcelProperty(index = 10,value = "标准地址")
    @ColumnWidth(50)
    private String address;

    @Schema(description = "创建时间")
    @ExcelIgnore
    private Long createTime;

    @Schema(description = "更新时间")
    @ExcelIgnore
    private Long updateTime;

}

实体类对应的Excel表格

小区名称楼栋号单元号楼层门牌号居住现状房屋类别房屋间数房屋面积实有人口标准地址

注解解释

@ExcelProperty 用于设置实体类字段在excel中展示

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface ExcelProperty {
    //用于设置Excel列名
    String[] value() default {""};
    //用于设置Excel列序号
    int index() default -1;
    //用于设置Excel列序号，优先级高于index
    int order() default Integer.MAX_VALUE;
    //枚举类型字段转换器
    Class<? extends Converter<?>> converter() default AutoConverter.class;

    /** @deprecated */
    @Deprecated
    String format() default "";
}

@ExcelSelected 用于设置下拉列表

@Documented
@Retention(RetentionPolicy.RUNTIME)  //注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在；
@Target(ElementType.FIELD)  //用此注解用在属性上。
public @interface ExcelSelected {
    /**
     * 固定下拉内容
     */
    String[] source() default {};

    /**
     * 动态下拉内容
     */
    Class<? extends ExcelDynamicSelect>[] sourceClass() default {};

    /**
     * 设置下拉框的起始行，默认为第二行
     */
    int firstRow() default 1;

    /**
     * 设置下拉框的结束行，默认为最后一行
     */
    int lastRow() default 0x10000;
}

@ExcelIgnore 默认所有字段都会和excel去匹配，加了这个注解会忽略该字段

@ColumnWidth(12) 设置列宽

@ContentRowHeight(15) 设置内容的行高

@HeadRowHeight(25) 设置表头的行高

3、创建枚举类

package com.genersoft.iot.vmp.info.entity;

public enum HouseType {

    ONE(1,"单元(公寓)楼"),
    TWO(2,"简子楼"),
    THREE(3,"别墅"),
    FOUR(4,"平房"),
    FIVE(5,"自建楼"),
    SIX(6,"四合院"),
    SEVEN(7,"其他")
    ;
    // 成员变量
    private Integer code;
    private String houseType;

    HouseType(Integer code, String houseType) {
        this.houseType = houseType;
        this.code = code;
    }

    public String getHouseType() {
        return houseType;
    }

    public Integer getCode() {
        return code;
    }
}

4、创建转换器

package com.genersoft.iot.vmp.info.utils;

import cn.hutool.core.util.StrUtil;
import com.alibaba.excel.converters.Converter;
import com.alibaba.excel.converters.ReadConverterContext;
import com.alibaba.excel.converters.WriteConverterContext;
import com.alibaba.excel.enums.CellDataTypeEnum;
import com.alibaba.excel.metadata.data.WriteCellData;
import com.genersoft.iot.vmp.info.entity.HouseType;

/**
 * 房屋类型转换器
 * @author xxx
 * @date 2023年04月17日 9:08
 */
public class TypeConverter implements Converter<Integer> {
    @Override
    public Class<?> supportJavaTypeKey() {
        //对象属性类型
        return Integer.class;
    }

    @Override
    public CellDataTypeEnum supportExcelTypeKey() {
        //CellData属性类型
        return CellDataTypeEnum.STRING;
    }

    @Override
    public Integer convertToJavaData(ReadConverterContext<?> context) throws Exception {
        //CellData转对象属性
        String cellStr = context.getReadCellData().getStringValue();
        if (StrUtil.isEmpty(cellStr)) return null;
        if (HouseType.ONE.getHouseType().equals(cellStr)) {
            return HouseType.ONE.getCode();
        } else if (HouseType.TWO.getHouseType().equals(cellStr)) {
            return HouseType.TWO.getCode();
        } else if (HouseType.THREE.getHouseType().equals(cellStr)) {
            return HouseType.THREE.getCode();
        } else if (HouseType.FOUR.getHouseType().equals(cellStr)) {
            return HouseType.FOUR.getCode();
        } else if (HouseType.FIVE.getHouseType().equals(cellStr)) {
            return HouseType.FIVE.getCode();
        } else if (HouseType.SIX.getHouseType().equals(cellStr)) {
            return HouseType.SIX.getCode();
        } else if (HouseType.SEVEN.getHouseType().equals(cellStr)) {
            return HouseType.SEVEN.getCode();
        } else {
            return null;
        }
    }

    @Override
    public WriteCellData<?> convertToExcelData(WriteConverterContext<Integer> context) throws Exception {
        //对象属性转CellData
        Integer cellValue = context.getValue();
        if (cellValue == null) {
            return new WriteCellData<>("");
        }
        if (cellValue.equals(HouseType.ONE.getCode())) {
            return new WriteCellData<>(HouseType.ONE.getHouseType());
        } else if (cellValue.equals(HouseType.TWO.getCode())) {
            return new WriteCellData<>(HouseType.TWO.getHouseType());
        } else if (cellValue.equals(HouseType.THREE.getCode())) {
            return new WriteCellData<>(HouseType.THREE.getHouseType());
        } else if (cellValue.equals(HouseType.FOUR.getCode())) {
            return new WriteCellData<>(HouseType.FOUR.getHouseType());
        } else if (cellValue.equals(HouseType.FIVE.getCode())) {
            return new WriteCellData<>(HouseType.FIVE.getHouseType());
        } else if (cellValue.equals(HouseType.SIX.getCode())) {
            return new WriteCellData<>(HouseType.SIX.getHouseType());
        } else if (cellValue.equals(HouseType.SEVEN.getCode())) {
            return new WriteCellData<>(HouseType.SEVEN.getHouseType());
        } else {
            return new WriteCellData<>("");
        }
    }
}

5、下载导入模版

@Operation(summary = "下载房屋信息导入模板")
@GetMapping("downloadTemplate")
public void downloadTemplate(HttpServletResponse response) throws IOException {
    houseBaseinfoService.downloadTemplate(response);
}

public void downloadTemplate(HttpServletResponse response) throws IOException {
        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
        response.setCharacterEncoding("utf-8");
        List<HouseBaseinfo> houseBaseinfos = new ArrayList<>();
        HouseBaseinfo houseBaseinfo = new HouseBaseinfo();
        houseBaseinfo.setCommunityName("智慧小区");
        houseBaseinfo.setNumber(1);
        houseBaseinfo.setUnit(2);
        houseBaseinfo.setFloor(3);
        houseBaseinfo.setRoom(1);
        houseBaseinfo.setStatus(1);
        houseBaseinfo.setType(1);
        houseBaseinfo.setBedRoom(3);
        houseBaseinfo.setArea(89);
        houseBaseinfo.setPeople(3);
        houseBaseinfo.setAddress("不用填，后台会自动生成！");
        houseBaseinfos.add(houseBaseinfo);
        try {
            String fileName = URLEncoder.encode("房屋信息导入模板", "UTF-8").replaceAll("\\+", "%20");
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
            response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            response.setCharacterEncoding("utf-8");
            response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
            ExcelWriter excelWriter = EasyExcel.write(response.getOutputStream()).build();
            WriteSheet writeSheet = EasyExcelUtil.writeSelectedSheet(HouseBaseinfo.class, 0, "房屋信息");
            excelWriter.write(houseBaseinfos, writeSheet);
            excelWriter.finish();
        } catch (Exception e) {
            // 重置response
            response.reset();
            response.setContentType("application/json");
            response.setCharacterEncoding("utf-8");
            Map<String, String> map = MapUtils.newHashMap();
            map.put("status", "failure");
            map.put("message", "下载文件失败" + e.getMessage());
            response.getWriter().println(JSON.toJSONString(map));
        }

    }

6、批量导入

@Operation(summary = "批量导入房屋信息")
@PostMapping("importExcel")
public Object importExcel(HttpServletRequest request, HttpServletResponse response, @RequestBody MultipartFile file) throws IOException {
    return houseBaseinfoService.importExcel(file);
}

public Object importExcel(MultipartFile file) throws IOException{
        List<HouseBaseinfo> excelList = null;
        String validate = "";
        //校验文件大小 100M
        boolean size = FileUtil.checkFileSize(file.getSize(), 100, "M");
        if(size == false){
            //文件过大啦，只能100M
            return WVPResult.fail(ErrorCode.ERROR100.getCode(), "文件过大啦，不能超过100M");
        }
        //excel读取数据
        excelList = EasyExcel.read(new BufferedInputStream(file.getInputStream())).head(HouseBaseinfo.class).sheet().doReadSync();
//        if (ExcelList.size() > 1000) {
//            //最多导入1000条哦
//        }
//        // excel数据校验
//        validate = ValidatorUtils.beanValidate(ExcelList);
//        if(!validate.equals("success")){
//            //参数异常提示  如：姓名不能为空哦~
//        }
        //总记录数
        Integer number = 0;
        for (HouseBaseinfo houseBaseinfo : excelList) {
            //根据小区名称查询小区id
            CommunityBaseinfo communityBaseinfo = communityBaseinfoMapper.getCommunityBaseinfoByCommunityName(houseBaseinfo.getCommunityName());
            if(communityBaseinfo == null){
                return WVPResult.fail(ErrorCode.ERROR100.getCode(), "请检查小区名字是否正确");
            }else{
                houseBaseinfo.setCommunityId(communityBaseinfo.getCommunityId());
            }
            Integer result = Integer.valueOf(addHouseBaseinfo(houseBaseinfo).toString());
            number = number+result;
        }
        return WVPResult.success(String.format("成功导入%s条房屋信息",number));
    }
斌果^O^
关注
  • 3
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
SpringBoot整合EasyExcel+MyBatis-Plus实现Excel批量导入和导出
05-03
本文将详细介绍如何使用SpringBoot框架结合EasyExcel和MyBatis-Plus来实现Excel的批量导入和导出，从而提高数据处理效率。 首先，SpringBoot是一个轻量级的Java开发框架，它简化了Spring应用的初始搭建以及开发过程...
案例实战-SpringBoot整合EasyExcel实现列表导出功能
06-03
在本案例实战中，我们将探讨如何使用SpringBoot框架与阿里巴巴的EasyExcel库相结合，实现在Web应用程序中便捷地实现列表数据的导出功能。EasyExcel是一个轻量级的Java处理Excel工具，它提供了简单易用的API，可以...
spring boot-操作excel（EasyExcel 快速开始）/ spring boot接受文件参数 File
西京刀客
03-13 1781
java本身并不支持读取excel，所有读取excel需要借助一些框架。
[SpringBoot实战系列]SpringBoot使用EasyExcel
tttttt521的博客
08-16 1344
目录 开始使用 简单导出excel easyExcel导出带下拉框的excel 问题：EasyExcel创建excel下拉框，下拉框内容过多时不显示 开始使用 导入依赖 <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.2.8</version> </d
【SpringBoot集成EasyExcel】
刘可心的博客
06-14 219
EasyExcel是阿里巴巴开发的一款开源Java库，专门用于处理Excel文件。与传统的POI相比，EasyExcel拥有更简洁、高效的API，使得开发者可以更轻松地实现Excel文件的读取和写入操作。无论是处理小型还是大型Excel文件，EasyExcel都能提供出色的性能和稳定性。
SpringBoot整合Easyexcel实现将数据导出为Excel表格的功能
C_Y_H__的博客
06-18 5539
他能让你在不用考虑性能、内存的等因素的情况下，快速完成Excel的读、写等功能。@ContentFontStyle(fontHeightInPoints = (short) 12) //字体大小。此外，还可以使用@ExcelIgnore注解，表示忽略这个字段，不导出这个字段的数据。主要涉及的数据表有缺陷表、用户表、功能模块表，此处只展示bug表的相关内容。的注解，其中value表示列名，index表示列名的索引值。@ContentRowHeight(15) //内容行高。前端实现见评论区链接。
spring boot导入导出excel,集成EasyExcel
weixin_41463944的博客
11-01 1056
spring boot导入导出excel,集成EasyExcel
springboot使用EasyExcel实现Excel导入导出
qq_41482600的博客
03-08 860
自定义转换器将数据库中表示性别的1、0转换成男、女/*** 性别转换器* */@Override// 实体类中对象属性类型@Override// Excel中对应的CellData(单元格数据)属性类型/*** 将单元格里的数据转为java对象，也就是女转成2，男转成1，用于导入excel时对性别字段进行转换* */@Override// 从CellData中读取数据，判断Excel中的值，将其转换为预期的数值/**
SpringBoot 使用 EasyExcel 实现Excel文件的导入导出
Ethereal的博客
08-16 2009
在项目中，文件导入导出的使用可能非常普遍，本文是SpringBoot 使用 EasyExcel 实现文件的导入导出的一个简单Demo，可以让你快速上手EasyExcel 。
springboot加easyexcel实现excel导出
hkgggh的博客
11-29 559
springboot加easyexcel实现数据导出到Excel表格中
SpringBoot2.7.9 + Vue2 基于easyexcel实现Excel大数据量的导入导出源码（免费下载）
03-13
本项目结合了SpringBoot 2.7.9、Vue2以及Element UI库，利用阿里巴巴的开源组件EasyExcel，实现了对Excel的大数据量导入和导出，并且包含了数据脱敏的处理机制。以下将详细阐述这些知识点。 **1. SpringBoot 2.7.9*...
Spring Boot使用EasyExcel导入导出Excel
12-13
EasyExcel则是阿里巴巴开源的一个处理Excel的工具，它简化了Excel操作的复杂性，使得在Spring Boot中实现Excel的导入导出变得非常容易。本文将深入探讨如何在Spring Boot项目中利用EasyExcel进行高效、便捷的数据...
easyExcel实现大数据导出
11-13
3. **创建写处理器**：`easyExcel`使用`WriteHandler`接口处理写入过程，你可以自定义实现这个接口，以便在导出过程中执行特定操作。例如，你可以实现批量写入，防止数据量过大导致内存溢出。 ```java public class...
Spring boot 配置文件
最新发布
2301_79547900的博客
07-25 444
properties使用key=value的形式配置键类型的配置文件，而yml使用的是树形结构来配置yml层级之间使⽤换⾏缩进的⽅式配置，key和value，之间使⽤": "(英⽂冒号)加空格的⽅式设置，并且空格不可省略。properties是早期默认的配置文件格式，其配置存在一定的冗余，使用yml可以很好解决这些问题。yml和properties可以共存，但建议只使用一种，可以降低故障率。
1.Spring Boot 简介(Spring MVC+Mybatis-plus)
m0_61086522的博客
07-23 776
SpringBoot是Spring的子工程(或是spring的脚手架),快速搭建spring项目,自动配置了Spring 应用程序和第三方库（spring+mybaties+web（servlet）+ reids+ 消息中间件）,而且使用很少xml配文件，提高开发效率。一款基于mvc模式、请求驱动、轻量级web框架（封装了Servlet）给予MVC模式请求驱动轻量级web框架封装了Servlet程序。
Spring Boot多租户配置与实现
weixin_53840353的博客
07-25 1190
多租户架构是一种软件架构模式，其中单个应用程序实例为多个租户（客户）提供服务。每个租户的数据和配置都是隔离的，确保不同租户之间的数据安全和隐私。共享数据库，独立数据表：所有租户共享同一个数据库，但每个租户有独立的数据表。共享数据库，共享数据表：所有租户共享同一个数据库和数据表，通过区分租户标识来隔离数据。独立数据库：每个租户有独立的数据库实例。本文将重点介绍共享数据库，共享数据表的多租户实现方式。
Spring Boot集成Spring Batch快速入门Demo
HBLOG
07-20 1191
Spring Batch 是一个轻量级的开源框架，它提供了一种简单的方式来处理大量的数据。它基于Spring框架，提供了一套批处理框架，可以处理各种类型的批处理任务，如ETL、数据导入/导出、报表生成等。Spring Batch提供了一些重要的概念，如Job、Step、ItemReader、ItemProcessor、ItemWriter等，这些概念可以帮助我们构建可重用的批处理应用程序。
在Spring Boot中实现文件上传与管理
微赚淘客开发者博客
07-20 1306
在现代应用程序中，文件上传与管理是一个常见的需求。在 Spring Boot 中，可以非常方便地实现文件上传和管理。本文将详细介绍如何在 Spring Boot 中实现文件上传功能，包括创建上传接口、文件存储、文件访问等方面的内容。通过配置文件上传、创建文件上传、下载、列表和删除接口，我们可以轻松地处理文件操作。这个 HTML 文件提供了一个简单的文件上传表单，用户可以选择文件并提交上传请求。中添加相关的依赖，以支持文件上传功能。接下来，我们创建一个文件上传的控制器，处理文件上传请求。作为文件上传的对象。
springBoot使用easyExcel上传Excel
05-19
是的，Spring Boot 可以使用 EasyExcel 库来上传 Excel 文件。EasyExcel 是一个基于 Java 的简单、高效的 Excel 处理工具，支持读写 Excel 文件，并且速度非常快。以下是使用 Spring Boot 和 EasyExcel 实现上传 Excel 文件的步骤： 1. 添加 EasyExcel 依赖 在 pom.xml 文件中添加以下依赖： ```xml <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.1.6</version> </dependency> ``` 2. 创建 Excel 文件上传接口 在 Spring Boot 中创建一个接口，用于上传 Excel 文件。例如： ```java @PostMapping("/upload") public String upload(MultipartFile file) throws IOException { InputStream inputStream = file.getInputStream(); EasyExcel.read(inputStream, DemoData.class, new DemoDataListener()).sheet().doRead(); return "success"; } ``` 3. 创建数据实体类 在 Spring Boot 中创建一个数据实体类，用于存储 Excel 文件中的数据。例如： ```java @Data @NoArgsConstructor @AllArgsConstructor public class DemoData { @ExcelProperty(value = "字符串标题", index = 0) private String string; @ExcelProperty(value = "日期标题", index = 1) private Date date; @ExcelProperty(value = "数字标题", index = 2) private Double doubleData; } ``` 4. 创建数据监听器类 在 Spring Boot 中创建一个数据监听器类，用于处理 Excel 文件中的数据。例如： ```java public class DemoDataListener extends AnalysisEventListener<DemoData> { private List<DemoData> list = new ArrayList<>(); @Override public void invoke(DemoData data, AnalysisContext context) { list.add(data); } @Override public void doAfterAllAnalysed(AnalysisContext context) { // 处理数据 System.out.println(list); } } ``` 5. 创建 Excel 模板文件 在 Spring Boot 中创建一个 Excel 模板文件，用于上传数据。例如： | 字符串标题 | 日期标题 | 数字标题 | | ---------- | ---------- | -------- | | Hello | 2022/01/01 | 1.1 | | World | 2022/01/02 | 2.2 | 6. 启动应用程序并测试 启动 Spring Boot 应用程序并测试上传 Excel 文件功能。可以使用 Postman 等工具进行测试。 以上就是使用 Spring Boot 和 EasyExcel 实现上传 Excel 文件的步骤。希望对你有所帮助！
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值