Springboot整合EasyExcel實現Excel文件上傳方式
一、概念
EasyExcel是一個基于Java的、快速、簡潔、解決大文件內存溢出的Excel處理工具。
它能讓你在不用考慮性能、內存的等因素的情況下,快速完成Excel的讀、寫等功能。
EasyExcel是在盡可能節(jié)約內存的情況下支持讀寫百M的Excel。
二、Excel的上傳(讀Excel)
1.Excel讀取的實現方案
實現Springboot結合EasyExcel實現對Excel中數據的讀取,并且將讀取的數據通過Mybatis-plus保存到Mysql數據庫。
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. 表格和表對應的實體類
既然要讀取Excel,同時存入數據庫,那么就必然需要對應的表,以及表對應的實體類,而Excel也需要對應的實體類。
因為Excel表格會增加一些不必要的字段,而這些字段并不需要存入數據庫中,同理數據庫實體類同樣存在一些字段不是從表格中獲取。
5.1 表格對應的實體類
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;
/**
*接收百分比的數字
*/
@ExcelProperty(index = 7)
@NumberFormat("#.##%")
private String rate;
}5.2 數據庫對應的實體類
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;
}注釋:數據庫實體類的overDate是Date類型,而Excel對應的類中overDate是String類型,只有String去接日期才能格式化。
6. 默認一行行的讀取excel
所以需要創(chuàng)建excel一行一行的回調監(jiān)聽器
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模板的讀取類
* 有個很重要的點,AttdnDataListener不能被Spring管理
* 要每次讀取excel都要new,然后里面用到spring可以構造方法傳進去
* @param excelAttdnOver
* @param analysisContext
*/
/**
* 每隔5條存儲數據庫,實際使用中可以100條,然后清理list ,方便內存回收
*/
private static final int BATCH_COUNT = 100;
private int count = 0;
/**
* 緩存的數據,List<AttdnOver>
*/
private List<AttdnOver> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
private AttdnOverService attdnOverService;
private String month;
public AttdnDataListener(){
}
/**
* 如果使用了spring,請使用這個構造方法。每次創(chuàng)建Listener的時候需要把spring管理的類傳進來
*
*/
public AttdnDataListener(AttdnOverService attdnOverService,String month){
this.attdnOverService = attdnOverService;
this.month = month;
}
/**
* 這個每一條數據解析都會來調用
*
*/
@Override
public void invoke(ExcelAttdnOver excelAttdnOver, AnalysisContext analysisContext) {
log.info("解析到第 {} 條數據:{}", (++count), JSON.toJSONString(excelAttdnOver));
try {
//把表格對應的實體類對象轉化成數據庫表對應的對象
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();
// 存儲完成清理 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);
}
*/
/**
* 所有數據解析完成了 都會來調用
* @param analysisContext
*/
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
log.info("表格中的所有數據解析完成?。?!");
// 這里也要保存數據,確保最后遺留的數據也存儲到數據庫
saveData();
}
/**
* 存儲數據庫
*/
private void saveData() {
log.info("{}條數據,開始存儲數據庫!", cachedDataList.size());
attdnOverService.batchSave(cachedDataList);
log.info("存儲數據庫成功!");
}
}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實現批量插入,并開啟事務
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 {
// 這里 需要指定讀用哪個class去讀,然后讀取第一個sheet 文件流會自動關閉
EasyExcel.read(file.getInputStream(), ExcelAttdnOver.class,new AttdnDataListener(attdnOverService,month))
.sheet().headRowNumber(1).doRead();
return "success";
}
}三、postman測試文件上傳
1. postman設置Header的key=Content-Type
Value=multipart/form-data

2. postman設置Body的key=file
并選擇為File,value選擇目錄

注釋:key=file,此處的file變量與Java代碼的Controller中的MultipartFile file變量名保持一樣,否則不起作用,讀不到文件。
@PostMapping("/upload/{month}") public String upload(MultipartFile file, @PathVariable String month) {}總結
以上為個人經驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關文章
mybatis的insert插入后獲取自增id的方法詳解(從controller到mapper)
這篇文章主要介紹了mybatis的insert插入后獲取自增id的示例代碼,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-10-10

