SpringBoot集成EasyExcel实现Excel文件导入/出

一,添加依赖

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>最新版本</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </dependency>

二,创建实体类

@ExcelProperty的属性说明
value按列名去匹配Excel数据,如果名字重复,会导致只有一个实体类字段读取到数据
index按列的下标去匹配Excel数据

不建议index和name同时用,要么一个对象只用index,要么一个对象只用name去匹配

@Data
@NoArgsConstructor
@AllArgsConstructor
public class EasyExcelEntity {
    @ExcelProperty("姓名")
    private String name;
    @ExcelProperty("年龄")
    private int age;
    @ExcelProperty("性别")
    private String sex;
}

三,读数据

(1)创建读的监听器

@Slf4j
public class ReadExcelListener implements ReadListener<EasyExcelEntity> {

    private static final int BATCH_NUM = 100;
    private List<EasyExcelEntity> cachedData = ListUtils.newArrayListWithExpectedSize(BATCH_NUM);

    /**
     * 读出Excel文件中的数据并放入cachedData
     */
    @Override
    public void invoke(EasyExcelEntity easyExcelEntity, AnalysisContext analysisContext) {
        cachedData.add(easyExcelEntity);
        if (cachedData.size() >= BATCH_NUM) {
            handlerData();
            cachedData = ListUtils.newArrayListWithExpectedSize(BATCH_NUM);
        }
    }

    /**
     * 所有数据解析完成了都会来调用
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        if (cachedData.size() != 0)
            handlerData();
        log.info("所有数据解析完成!");
    }

    /**
     * 在转换异常获取其他异常下会调用本接口。抛出异常则停止读取。如果这里不抛出异常则继续读取下一行
     */
    @Override
    public void onException(Exception exception, AnalysisContext context) {
        log.error("解析失败,但是继续解析下一行:{}", exception.getMessage());
        // 如果是某一个单元格的转换异常,能获取到具体行号
        // 如果要获取头的信息需配合invokeHeadMap使用
        if (exception instanceof ExcelDataConvertException e) {
           log.error("第{}行,第{}列解析异常,数据为:{}", e.getRowIndex(), e.getColumnIndex(), e.getCellData());
        }
    }

    /**
     * 处理从Excel文件中读取的数据
     */
    public void handlerData() {
        // 处理数据代码逻辑
    }

}

(2)调用读取数据方法

	public static final String XLSX_MIME = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
	
	@PostMapping("/import")
    public Result importExcel(@RequestBody MultipartFile file) throws IOException {
        if (file.isEmpty()) {
            throw new BusinessException("上传文件不能为空", Code.BUS_EXC);
        }
        String oriFileName = file.getOriginalFilename();
        if (XLSX_MIME.equals(file.getContentType())
                && oriFileName != null
                && oriFileName.toLowerCase().endsWith(".xlsx")) {
            ReadExcelListener listener = new ReadExcelListener();
            EasyExcel.read(file.getInputStream(), EasyExcelEntity.class, listener)
                    .sheet()
                    .doRead();
            return new Result(Code.SUCCESS,"导入成功", null);
        } else {
            throw new BusinessException("请上传.xlsx类型文件", Code.BUS_EXC);
        }
    }

四,写数据

	Collection<EasyExcelEntity> data = new ArrayList<>();
	File file = new File("绝对路径或相对路径");
    // 这里需要指定写用哪个class去写,然后写到第一个sheet,名字为模板,然后文件流会自动关闭
    EasyExcel.write(file, EasyExcelEntity.class).sheet("sheet").doWrite(data);
要在Spring Boot集成easyexcel进行导入,您需要进行以下步骤: 1. 首先,您需要在您的项目中添加easyexcel的相关依赖。在您的pom.xml文件中添加以下依赖: ``` <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>2.1.4</version> </dependency> ``` 2. 您需要创建一个控制器类来处理导入请求。在该类中,您可以使用`@PostMapping`注解来处理导入请求,并将上传的文件作为`MultipartFile`参数。在该方法中,您可以调用相应的服务类来处理导入逻辑。以下是一个示例控制器类的代码: ```java @RestController @RequestMapping("/excel") public class ExcelController { @Autowired private ExcelService excelService; @PostMapping("/user/excelImport") public String excelImport(@RequestParam("file") MultipartFile file) throws IOException { excelService.excelImport(file); return "success"; } } ``` 3. 您还需要创建一个服务类来处理导入逻辑。在该类中,您可以使用easyexcel提供的API来读取并处理Excel文件。以下是一个示例服务类的代码: ```java @Service public class ExcelService { public void excelImport(MultipartFile file) throws IOException { // 使用easyexcel API读取并处理Excel文件 InputStream inputStream = file.getInputStream(); EasyExcel.read(inputStream, YourDataClass.class, new YourDataListener()).sheet().doRead(); } } ``` 4. 最后,您还需要创建一个数据监听器类来处理导入Excel数据。您可以在此类中实现`AnalysisEventListener`接口,并重写对应的方法来处理每一行的数据。以下是一个示例数据监听器类的代码: ```java public class YourDataListener extends AnalysisEventListener<YourDataClass> { @Override public void invoke(YourDataClass data, AnalysisContext context) { // 处理每一行的数据 } @Override public void doAfterAllAnalysed(AnalysisContext context) { // 所有数据解析完成后的操作 } } ``` 以上就是在Spring Boot集成easyexcel进行导入的基本步骤。您可以根据您的具体需求进行相应的调整和扩展。<span class="em">1</span><span class="em">2</span><span class="em">3</span><span class="em">4</span>
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

码届艺术家

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值