Springboot整合EasyExcel實(shí)現(xiàn)Excel文件上傳方式
更新時(shí)間：2024年07月13日 12:02:47 作者：花果水蓮
這篇文章主要介紹了Springboot整合EasyExcel實(shí)現(xiàn)Excel文件上傳方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
一、概念
EasyExcel是一個(gè)基于Java的、快速、簡(jiǎn)潔、解決大文件內(nèi)存溢出的Excel處理工具。
它能讓你在不用考慮性能、內(nèi)存的等因素的情況下，快速完成Excel的讀、寫等功能。
EasyExcel是在盡可能節(jié)約內(nèi)存的情況下支持讀寫百M(fèi)的Excel。
二、Excel的上傳(讀Excel)
1.Excel讀取的實(shí)現(xiàn)方案
實(shí)現(xiàn)Springboot結(jié)合EasyExcel實(shí)現(xiàn)對(duì)Excel中數(shù)據(jù)的讀取，并且將讀取的數(shù)據(jù)通過(guò)Mybatis-plus保存到Mysql數(shù)據(jù)庫(kù)。
2. maven依賴，pom文件
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.1.1</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.2.8</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.76</version>
</dependency>
</dependencies>3. pom文件，加載xml文件
由于用到MyBatisplus，所以一定不要忘記加下面的這段代碼，否則你的mapper是編譯不到你的classpath中的。
<build>
<!-- 由于用到MyBatis，所以一定不要忘記加下面的這段代碼，否則你的mapper是編譯不到你的classpath中的。-->
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
</resources>
</build>4. application.yml文件配置mybatis-plus
server:
port: 80
spring:
datasource:
druid:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/redhorse?serverTimezone=UTC
username: root
password: root
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl5. 表格和表對(duì)應(yīng)的實(shí)體類
既然要讀取Excel，同時(shí)存入數(shù)據(jù)庫(kù)，那么就必然需要對(duì)應(yīng)的表，以及表對(duì)應(yīng)的實(shí)體類，而Excel也需要對(duì)應(yīng)的實(shí)體類。
因?yàn)镋xcel表格會(huì)增加一些不必要的字段，而這些字段并不需要存入數(shù)據(jù)庫(kù)中，同理數(shù)據(jù)庫(kù)實(shí)體類同樣存在一些字段不是從表格中獲取。
5.1 表格對(duì)應(yīng)的實(shí)體類
package com.atorientsec.entities;
import com.alibaba.excel.annotation.ExcelProperty;
import com.alibaba.excel.annotation.format.DateTimeFormat;
import com.alibaba.excel.annotation.format.NumberFormat;
import lombok.Data;
@Data
public class ExcelAttdnOver {
@ExcelProperty(index =2)
private String department;
@ExcelProperty(index = 0)
private String name;
/**
* 這里用String去接日期，才能格式化，接收年月日的格式
*/
@ExcelProperty(index = 3)
@DateTimeFormat(value = "yyyy-MM-dd")
private String overDate;
@ExcelProperty(index = 4)
private Double overHours;
/**
*接收百分比的數(shù)字
*/
@ExcelProperty(index = 7)
@NumberFormat("#.##%")
private String rate;
}5.2 數(shù)據(jù)庫(kù)對(duì)應(yīng)的實(shí)體類
package com.atorientsec.entities;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
import java.util.Date;
@Data
public class AttdnOver {
@TableId(type = IdType.AUTO)
private Integer id;
private String department;
private String name;
private String attdnMonth;
@DateTimeFormat(pattern = "yyyy-MM-dd")
private Date overDate;
private Double overHours;
private Double rate;
}注釋：數(shù)據(jù)庫(kù)實(shí)體類的overDate是Date類型，而Excel對(duì)應(yīng)的類中overDate是String類型，只有String去接日期才能格式化。
6. 默認(rèn)一行行的讀取excel
所以需要?jiǎng)?chuàng)建excel一行一行的回調(diào)監(jiān)聽(tīng)器
package com.atorientsec.listener;
import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.read.listener.ReadListener;
import com.alibaba.excel.util.ListUtils;
import com.alibaba.fastjson.JSON;
import com.atorientsec.entities.AttdnOver;
import com.atorientsec.entities.ExcelAttdnOver;
import com.atorientsec.service.AttdnOverService;
import lombok.extern.slf4j.Slf4j;
import java.text.SimpleDateFormat;
import java.util.*;
@Slf4j
public class AttdnDataListener implements ReadListener<ExcelAttdnOver> {
/**
* Excel模板的讀取類
* 有個(gè)很重要的點(diǎn)，AttdnDataListener不能被Spring管理
* 要每次讀取excel都要new，然后里面用到spring可以構(gòu)造方法傳進(jìn)去
* @param excelAttdnOver
* @param analysisContext
*/
/**
* 每隔5條存儲(chǔ)數(shù)據(jù)庫(kù)，實(shí)際使用中可以100條，然后清理list ，方便內(nèi)存回收
*/
private static final int BATCH_COUNT = 100;
private int count = 0;
/**
* 緩存的數(shù)據(jù),List<AttdnOver>
*/
private List<AttdnOver> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
private AttdnOverService attdnOverService;
private String month;
public AttdnDataListener(){
}
/**
* 如果使用了spring,請(qǐng)使用這個(gè)構(gòu)造方法。每次創(chuàng)建Listener的時(shí)候需要把spring管理的類傳進(jìn)來(lái)
*
*/
public AttdnDataListener(AttdnOverService attdnOverService,String month){
this.attdnOverService = attdnOverService;
this.month = month;
}
/**
* 這個(gè)每一條數(shù)據(jù)解析都會(huì)來(lái)調(diào)用
*
*/
@Override
public void invoke(ExcelAttdnOver excelAttdnOver, AnalysisContext analysisContext) {
log.info("解析到第 {} 條數(shù)據(jù):{}", (++count), JSON.toJSONString(excelAttdnOver));
try {
//把表格對(duì)應(yīng)的實(shí)體類對(duì)象轉(zhuǎn)化成數(shù)據(jù)庫(kù)表對(duì)應(yīng)的對(duì)象
AttdnOver attdnOver = new AttdnOver();
attdnOver.setDepartment(excelAttdnOver.getDepartment());
attdnOver.setName(excelAttdnOver.getName());
attdnOver.setAttdnMonth(this.month);
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
Date date = sdf.parse(excelAttdnOver.getOverDate());
attdnOver.setOverDate(date);
attdnOver.setOverHours(excelAttdnOver.getOverHours());
attdnOver.setRate(Double.parseDouble(excelAttdnOver.getRate().replace("%", "")));
cachedDataList.add(attdnOver);
if(cachedDataList.size()>=BATCH_COUNT){
saveData();
// 存儲(chǔ)完成清理 list
cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
}
}catch (Exception e){
log.error(e.getMessage());
}
}
/**
* 接收表頭信息
@Override
public void invokeHead(Map<Integer, ReadCellData<?>> headMap, AnalysisContext context) {
Map<Integer,String> StringMap = ConverterUtils.convertToStringMap(headMap,context);
Set<Integer> keySet = StringMap.keySet();
System.out.println("該Excel表頭信息是：");
for(int i=0;i<keySet.size();i++){
System.out.println("第 "+(i+1)+" 列 = "+StringMap.get(i));
}
ReadListener.super.invokeHead(headMap, context);
}
*/
/**
* 所有數(shù)據(jù)解析完成了 都會(huì)來(lái)調(diào)用
* @param analysisContext
*/
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
log.info("表格中的所有數(shù)據(jù)解析完成?。?！");
// 這里也要保存數(shù)據(jù)，確保最后遺留的數(shù)據(jù)也存儲(chǔ)到數(shù)據(jù)庫(kù)
saveData();
}
/**
* 存儲(chǔ)數(shù)據(jù)庫(kù)
*/
private void saveData() {
log.info("{}條數(shù)據(jù)，開始存儲(chǔ)數(shù)據(jù)庫(kù)！", cachedDataList.size());
attdnOverService.batchSave(cachedDataList);
log.info("存儲(chǔ)數(shù)據(jù)庫(kù)成功！");
}
}7. mapper-繼承Mybatis-plus的baseMapper
package com.atorientsec.mapper;
import com.atorientsec.entities.AttdnOver;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface AttdnOverMapper extends BaseMapper<AttdnOver> {
}8. service：Mybatis-plus實(shí)現(xiàn)批量插入，并開啟事務(wù)
package com.atorientsec.service;
import com.atorientsec.entities.AttdnOver;
import com.baomidou.mybatisplus.extension.service.IService;
import org.springframework.transaction.annotation.Transactional;
import java.util.ArrayList;
public interface AttdnOverService extends IService<AttdnOver> {
@Transactional
boolean batchSave(ArrayList<AttdnOver> attdnOverArrayList);
}package com.atorientsec.service.impl;
import com.atorientsec.entities.AttdnOver;
import com.atorientsec.mapper.AttdnOverMapper;
import com.atorientsec.service.AttdnOverService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
import java.util.ArrayList;
@Service
public class AttdnOverServiceImpl extends ServiceImpl<AttdnOverMapper, AttdnOver> implements AttdnOverService {
public boolean batchSave(ArrayList<AttdnOver> attdnOverArrayList){
//saveBatch是mybatisplus的批量插入方法
boolean status = saveBatch(attdnOverArrayList);
return status;
}
}9. Controller：MultipartFile上傳文件
EasyExcel讀文件
package com.atorientsec.controller;
import com.alibaba.excel.EasyExcel;
import com.atorientsec.entities.ExcelAttdnOver;
import com.atorientsec.listener.AttdnDataListener;
import com.atorientsec.service.AttdnOverService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
@RestController
@RequestMapping("/excel")
public class AttdnOverController {
@Autowired
private AttdnOverService attdnOverService;
@PostMapping("/upload/{month}")
public String upload(MultipartFile file, @PathVariable String month) throws IOException {
// 這里 需要指定讀用哪個(gè)class去讀，然后讀取第一個(gè)sheet 文件流會(huì)自動(dòng)關(guān)閉
EasyExcel.read(file.getInputStream(), ExcelAttdnOver.class,new AttdnDataListener(attdnOverService,month))
.sheet().headRowNumber(1).doRead();
return "success";
}
}三、postman測(cè)試文件上傳
1. postman設(shè)置Header的key=Content-Type
Value=multipart/form-data
2. postman設(shè)置Body的key=file
并選擇為File，value選擇目錄
注釋：key=file，此處的file變量與Java代碼的Controller中的MultipartFile file變量名保持一樣，否則不起作用，讀不到文件。
@PostMapping("/upload/{month}") public String upload(MultipartFile file, @PathVariable String month) {}總結(jié)
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
Spring MVC接受表單自動(dòng)封裝特性實(shí)例解析
這篇文章主要介紹了Spring MVC接受表單自動(dòng)封裝特性實(shí)例解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-02-02
本文探討了Java8中CompletableFuture的原理和應(yīng)用,詳解其異步編程能力、工作機(jī)制及實(shí)際使用方法,CompletableFuture通過(guò)鏈?zhǔn)秸{(diào)用和狀態(tài)管理優(yōu)化異步任務(wù),提高Java應(yīng)用的效率和性能2024-09-09
在Spring boot開發(fā)中,需要在application.yml文件里配置數(shù)據(jù)庫(kù)的連接信息,或者在啟動(dòng)時(shí)傳入數(shù)據(jù)庫(kù)密碼,如果不加密,傳明文,數(shù)據(jù)庫(kù)就直接暴露了,下面這篇文章主要給大家介紹了關(guān)于springboot配置加密的正確姿勢(shì),需要的朋友可以參考下2022-11-11
SpringSecurity角色權(quán)限控制(SpringBoot+SpringSecurity+JWT)
本文主要介紹了SpringSecurity角色權(quán)限控制(SpringBoot+SpringSecurity+JWT),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-05-05
SpringBoot集成Sa-Token實(shí)現(xiàn)權(quán)限認(rèn)證流程入門教程
本文詳解SpringBoot集成Sa-Token框架的入門步驟,涵蓋依賴添加、配置設(shè)置、攔截器注冊(cè)、權(quán)限角色邏輯定義、設(shè)備工具類創(chuàng)建及登錄/注銷功能改造,通過(guò)注解實(shí)現(xiàn)鑒權(quán),解決權(quán)限認(rèn)證問(wèn)題,感興趣的朋友跟隨小編一起看看吧2025-09-09
springboot?整合?clickhouse的實(shí)現(xiàn)示例
本文主要介紹了springboot?整合?clickhouse的實(shí)現(xiàn)示例，文中通過(guò)示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-02-02
springboot如何獲取application.yml里值的方法
這篇文章主要介紹了springboot如何獲取application.yml里的值，文章圍繞主題相關(guān)自資料展開詳細(xì)的內(nèi)容介紹，具有一定的參考價(jià)值，需要的小伙伴可以參考一下2022-04-04
修改若依框架Token的過(guò)期時(shí)間問(wèn)題
本文介紹了如何修改若依框架中Token的過(guò)期時(shí)間,通過(guò)修改`application.yml`文件中的配置來(lái)實(shí)現(xiàn),默認(rèn)單位為分鐘,希望此經(jīng)驗(yàn)對(duì)大家有所幫助,也歡迎支持腳本之家2025-02-02
JavaWeb HttpServletResponse對(duì)象及常用方法
這篇文章主要介紹了JavaWeb-HttpServletResponse對(duì)象，本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-03-03
JAVA String.valueOf()方法的用法說(shuō)明
這篇文章主要介紹了JAVA String.valueOf()方法的用法說(shuō)明，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-09-09