Spring?Boot?+?EasyExcel實現(xiàn)數(shù)據(jù)導(dǎo)入導(dǎo)出
背景
老項目主要采用的POI框架來進行Excel數(shù)據(jù)的導(dǎo)入和導(dǎo)出，但經(jīng)常會出現(xiàn)OOM的情況，導(dǎo)致整個服務(wù)不可用。后續(xù)逐步轉(zhuǎn)移到EasyExcel，簡直不能太好用了。
EasyExcel是阿里巴巴開源插件之一，主要解決了poi框架使用復(fù)雜，sax解析模式不容易操作，數(shù)據(jù)量大起來容易OOM，解決了POI并發(fā)造成的報錯。主要解決方式：通過解壓文件的方式加載，一行一行地加載，并且拋棄樣式字體等不重要的數(shù)據(jù)，降低內(nèi)存的占用。
在之前專門寫過一篇文章《Java 中EasyExcel的使用方式》，介紹EasyExcel功能的基本使用。今天這篇文章，我們基于SpringBoot來實現(xiàn)一下EasyExcel的集成，更加方便大家在實踐中的直接使用。
SpringBoot項目集成
依賴集成
創(chuàng)建一個基礎(chǔ)的SpringBoot項目，比如這里采用SpringBoot 2.7.2版本。
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>EasyExcel在SpringBoot的集成非常方便，只需引入對應(yīng)的pom依賴即可。在上述dependencies中添加EasyExcel的依賴：
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>2.2.11</version>
</dependency>EasyExcel目前穩(wěn)定最新版本2.2.11。
為了方便和簡化代碼編寫，這里同時引入了Lombok的依賴，后續(xù)代碼中也會使用對應(yīng)的注解。
<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.22</version> </dependency>
下面正式開始業(yè)務(wù)相關(guān)代碼的編寫。如果你想直接獲得完整源碼，對照源碼閱讀本篇文章，可在公號「程序新視界」內(nèi)回“1007”獲得完整源碼。
實體類實現(xiàn)
這里創(chuàng)建一個Member，會員的實體類，并在實體類中填寫基礎(chǔ)的個人信息。
@Data
public class Member {
/**
* EasyExcel使用：導(dǎo)出時忽略該字段
*/
@ExcelIgnore
private Integer id;
@ExcelProperty("用戶名")
@ColumnWidth(20)
private String username;
/**
* EasyExcel使用：日期的格式化
*/
@ColumnWidth(20)
@ExcelProperty("出生日期")
@DateTimeFormat("yyyy-MM-dd")
private Date birthday;
/**
* EasyExcel使用：自定義轉(zhuǎn)換器
*/
@ColumnWidth(10)
@ExcelProperty(value = "性別", converter = GenderConverter.class)
private Integer gender;
}為了盡量多的演示EasyExcel的相關(guān)功能，在上述實體類中使用了其常見的一些注解：
- @ExcelIgnore：忽略掉該字段；
- @ExcelProperty("用戶名")：設(shè)置該列的名稱為”用戶名“；
- @ColumnWidth(20)：設(shè)置表格列的寬度為20；
- @DateTimeFormat("yyyy-MM-dd")：按照指定的格式對日期進行格式化；
- @ExcelProperty(value = "性別", converter = GenderConverter.class)：自定義內(nèi)容轉(zhuǎn)換器，類似枚舉的實現(xiàn)，將“男”、“女”轉(zhuǎn)換成“0”、“1”的數(shù)值。
GenderConverter轉(zhuǎn)換器的代碼實現(xiàn)如下：
public class GenderConverter implements Converter<Integer> {
private static final String MAN = "男";
private static final String WOMAN = "女";
@Override
public Class<?> supportJavaTypeKey() {
// 實體類中對象屬性類型
return Integer.class;
}
@Override
public CellDataTypeEnum supportExcelTypeKey() {
// Excel中對應(yīng)的CellData屬性類型
return CellDataTypeEnum.STRING;
}
@Override
public Integer convertToJavaData(CellData cellData, ExcelContentProperty excelContentProperty,
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? GlobalConfiguration globalConfiguration) {
// 從Cell中讀取數(shù)據(jù)
String gender = cellData.getStringValue();
// 判斷Excel中的值，將其轉(zhuǎn)換為預(yù)期的數(shù)值
if (MAN.equals(gender)) {
return 0;
} else if (WOMAN.equals(gender)) {
return 1;
}
return null;
}
@Override
public CellData<?> convertToExcelData(Integer integer, ExcelContentProperty excelContentProperty,
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? GlobalConfiguration globalConfiguration) {
// 判斷實體類中獲取的值，轉(zhuǎn)換為Excel預(yù)期的值，并封裝為CellData對象
if (integer == null) {
return new CellData<>("");
} else if (integer == 0) {
return new CellData<>(MAN);
} else if (integer == 1) {
return new CellData<>(WOMAN);
}
return new CellData<>("");
}
}不同版本中，convertToJavaData和convertToExcelData的方法參數(shù)有所不同，對應(yīng)的值的獲取方式也不同，大家在使用時注意對照自己的版本即可。
業(yè)務(wù)邏輯實現(xiàn)
為方便驗證功能，DAO層的邏輯便不再實現(xiàn)，直接通過Service層來封裝數(shù)據(jù)，先來看導(dǎo)出功能的業(yè)務(wù)類實現(xiàn)。
MemberService實現(xiàn)
定義MemberService接口：
public interface MemberService {
/**
* 獲取所有的成員信息
* @return 成員信息列表
*/
List<Member> getAllMember();
}定義MemberServiceImpl實現(xiàn)類：
@Service("memberService")
public class MemberServiceImpl implements MemberService {
? @Override
public List<Member> getAllMember() {
// 這里構(gòu)造一些測試數(shù)據(jù)，具體業(yè)務(wù)場景可從數(shù)據(jù)庫等其他地方獲取
List<Member> list = new ArrayList<>();
Member member = new Member();
member.setUsername("張三");
member.setBirthday(getDate(1990, 10, 11));
member.setGender(0);
list.add(member);
Member member1 = new Member();
member1.setUsername("王紅");
member1.setBirthday(getDate(1999, 3, 29));
member1.setGender(1);
list.add(member1);
Member member2 = new Member();
member2.setUsername("李四");
member2.setBirthday(getDate(2000, 2, 9));
member2.setGender(0);
list.add(member2);
return list;
}
private Date getDate(int year, int month, int day) {
Calendar calendar = Calendar.getInstance();
calendar.set(year, month, day);
return calendar.getTime();
}
}其中數(shù)據(jù)采用模擬的靜態(tài)數(shù)據(jù)，返回Member列表。
簡單導(dǎo)出實現(xiàn)
在Controller層的實現(xiàn)一個簡單的導(dǎo)出實現(xiàn)：
/**
* 普通導(dǎo)出方式
*/
@RequestMapping("/export1")
public void exportMembers1(HttpServletResponse response) throws IOException {
List<Member> members = memberService.getAllMember();
// 設(shè)置文本內(nèi)省
response.setContentType("application/vnd.ms-excel");
// 設(shè)置字符編碼
response.setCharacterEncoding("utf-8");
// 設(shè)置響應(yīng)頭
response.setHeader("Content-disposition", "attachment;filename=demo.xlsx");
EasyExcel.write(response.getOutputStream(), Member.class).sheet("成員列表").doWrite(members);
}這個實現(xiàn)方式非常簡單直接，使用EasyExcel的write方法將查詢到的數(shù)據(jù)進行處理，以流的形式寫出即可。
在瀏覽器訪問對應(yīng)的鏈接，可下載到如下Excel內(nèi)容：
如果我們需要將導(dǎo)出的Excel進行一些格式化的處理，這就需要用到導(dǎo)出策略的實現(xiàn)了。
自定義導(dǎo)入實現(xiàn)
在EasyExcel執(zhí)行write方法之后，獲得ExcelWriterBuilder類，通過該類的registerWriteHandler方法可以設(shè)置一些處理策略。
這里先實現(xiàn)一個通用的格式策略工具類CommonCellStyleStrategy：
public class CommonCellStyleStrategy {
/**
* 設(shè)置單元格樣式(僅用于示例)
*
* @return 樣式策略
*/
public static HorizontalCellStyleStrategy getHorizontalCellStyleStrategy() {
// 表頭策略
WriteCellStyle headerCellStyle = new WriteCellStyle();
// 表頭水平對齊居中
headerCellStyle.setHorizontalAlignment(HorizontalAlignment.CENTER);
// 背景色
headerCellStyle.setFillForegroundColor(IndexedColors.SKY_BLUE.getIndex());
WriteFont headerFont = new WriteFont();
headerFont.setFontHeightInPoints((short) 15);
headerCellStyle.setWriteFont(headerFont);
// 自動換行
headerCellStyle.setWrapped(Boolean.FALSE);
// 內(nèi)容策略
WriteCellStyle contentCellStyle = new WriteCellStyle();
// 設(shè)置數(shù)據(jù)允許的數(shù)據(jù)格式,這里49代表所有可以都允許設(shè)置
contentCellStyle.setDataFormat((short) 49);
// 設(shè)置背景色: 需要指定 FillPatternType 為FillPatternType.SOLID_FOREGROUND 不然無法顯示背景顏色.頭默認(rèn)了 FillPatternType所以可以不指定
contentCellStyle.setFillPatternType(FillPatternType.SOLID_FOREGROUND);
contentCellStyle.setFillForegroundColor(IndexedColors.GREY_40_PERCENT.getIndex());
// 設(shè)置內(nèi)容靠左對齊
contentCellStyle.setHorizontalAlignment(HorizontalAlignment.LEFT);
// 設(shè)置字體
WriteFont contentFont = new WriteFont();
contentFont.setFontHeightInPoints((short) 12);
contentCellStyle.setWriteFont(contentFont);
// 設(shè)置自動換行
contentCellStyle.setWrapped(Boolean.FALSE);
// 設(shè)置邊框樣式和顏色
contentCellStyle.setBorderLeft(BorderStyle.MEDIUM);
contentCellStyle.setBorderTop(BorderStyle.MEDIUM);
contentCellStyle.setBorderRight(BorderStyle.MEDIUM);
contentCellStyle.setBorderBottom(BorderStyle.MEDIUM);
contentCellStyle.setTopBorderColor(IndexedColors.RED.getIndex());
contentCellStyle.setBottomBorderColor(IndexedColors.GREEN.getIndex());
contentCellStyle.setLeftBorderColor(IndexedColors.YELLOW.getIndex());
contentCellStyle.setRightBorderColor(IndexedColors.ORANGE.getIndex());
// 將格式加入單元格樣式策略
return new HorizontalCellStyleStrategy(headerCellStyle, contentCellStyle);
}
}該類中示例設(shè)置了Excel的基礎(chǔ)格式。
再來實現(xiàn)一個精細(xì)化控制單元格內(nèi)容CellWriteHandler的實現(xiàn)類：
/**
* 實現(xiàn)CellWriteHandler接口, 實現(xiàn)對單元格樣式的精確控制
*
* @author sec
* @version 1.0
* @date 2022/7/31
**/
public class CustomCellWriteHandler implements CellWriteHandler {
/**
* 創(chuàng)建單元格之前的操作
*/
@Override
public void beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Row row,
? ? ? ? ? ? ? ? ? ? ? ? ? ? Head head, Integer integer, Integer integer1, Boolean aBoolean) {
}
/**
* 創(chuàng)建單元格之后的操作
*/
@Override
public void afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, Cell cell,
? ? ? ? ? ? ? ? ? ? ? ? ? Head head, Integer integer, Boolean aBoolean) {
}
/**
* 單元格內(nèi)容轉(zhuǎn)換之后的操作
*/
@Override
public void afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? CellData cellData, Cell cell, Head head, Integer integer, Boolean aBoolean) {
}
/**
* 單元格處理后(已寫入值)的操作
*/
@Override
public void afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder,
? ? ? ? ? ? ? ? ? ? ? ? ? ? List<CellData> list, Cell cell, Head head, Integer integer, Boolean isHead) {
// 設(shè)置超鏈接
if (isHead && cell.getRowIndex() == 0 && cell.getColumnIndex() == 0) {
CreationHelper helper = writeSheetHolder.getSheet().getWorkbook().getCreationHelper();
Hyperlink hyperlink = helper.createHyperlink(HyperlinkType.URL);
hyperlink.setAddress("https://github.com/alibaba/easyexcel");
cell.setHyperlink(hyperlink);
}
// 精確設(shè)置單元格格式
boolean bool = isHead && cell.getRowIndex() == 1;
if (bool) {
// 獲取工作簿
Workbook workbook = writeSheetHolder.getSheet().getWorkbook();
CellStyle cellStyle = workbook.createCellStyle();
Font cellFont = workbook.createFont();
cellFont.setBold(Boolean.TRUE);
cellFont.setFontHeightInPoints((short) 14);
cellFont.setColor(IndexedColors.SEA_GREEN.getIndex());
cellStyle.setFont(cellFont);
cell.setCellStyle(cellStyle);
}
}
}在這里，對單元格表頭的第0個Cell設(shè)置了一個超鏈接。
通過上面的定義兩個策略實現(xiàn)，在導(dǎo)出Excel可以使用上述兩個策略實現(xiàn)：
/**
* 基于策略及攔截器導(dǎo)出
*/
@RequestMapping("/export2")
public void exportMembers2(HttpServletResponse response) throws IOException {
List<Member> members = memberService.getAllMember();
// 設(shè)置文本內(nèi)省
response.setContentType("application/vnd.ms-excel");
// 設(shè)置字符編碼
response.setCharacterEncoding("utf-8");
// 設(shè)置響應(yīng)頭
response.setHeader("Content-disposition", "attachment;filename=demo.xlsx");
EasyExcel.write(response.getOutputStream(), Member.class).sheet("成員列表")
// 注冊通用格式策略
.registerWriteHandler(CommonCellStyleStrategy.getHorizontalCellStyleStrategy())
// 設(shè)置自定義格式策略
.registerWriteHandler(new CustomCellWriteHandler())
.doWrite(members);
}通過瀏覽器，訪問上述接口，導(dǎo)出的Excel格式如下：
可以看出，導(dǎo)出的Excel已經(jīng)附帶了具體的格式。其中表頭“用戶名”上也攜帶了對應(yīng)的超鏈接。其他更精細(xì)化的控制，大家可以在策略類中做進一步的控制。
同步獲取結(jié)果導(dǎo)入實現(xiàn)
所謂的同步獲取結(jié)果導(dǎo)入，就是執(zhí)行導(dǎo)入操作時，將導(dǎo)入內(nèi)容解析封裝成一個結(jié)果列表返回給業(yè)務(wù)，業(yè)務(wù)代碼再對列表中的數(shù)據(jù)進行集中的處理。
先來看同步導(dǎo)入的實現(xiàn)方式。
/**
* 從Excel導(dǎo)入會員列表
*/
@RequestMapping(value = "/import1", method = RequestMethod.POST)
@ResponseBody
public void importMemberList(@RequestPart("file") MultipartFile file) throws IOException {
List<Member> list = EasyExcel.read(file.getInputStream())
.head(Member.class)
.sheet()
.doReadSync();
for (Member member : list) {
System.out.println(member);
}
}注意，在上述代碼中，最終調(diào)用的是doReadSync()方法。
這里直接用PostMan進行相應(yīng)的文件上傳請求：
執(zhí)行導(dǎo)入請求，會發(fā)現(xiàn)控制臺打印出對應(yīng)的解析對象：
Member(id=null, username=張三, birthday=Sun Nov 11 00:00:00 CST 1990, gender=0) Member(id=null, username=王紅, birthday=Thu Apr 29 00:00:00 CST 1999, gender=1) Member(id=null, username=李四, birthday=Thu Mar 09 00:00:00 CST 2000, gender=0)
說明上傳成功，并且解析成功。
基于監(jiān)聽導(dǎo)入實現(xiàn)
上面示例中是基于同步獲取結(jié)果列表的形式進行導(dǎo)入，還有一種實現(xiàn)方式是基于監(jiān)聽器的形式來實現(xiàn)。這種形式可以達到邊解析邊處理業(yè)務(wù)邏輯的效果。
定義Listener：
public class MemberExcelListener extends AnalysisEventListener<Member> {
@Override
public void invoke(Member member, AnalysisContext analysisContext) {
// do something
System.out.println("讀取Member=" + member);
// do something
}
@Override
public void doAfterAllAnalysed(AnalysisContext analysisContext) {
// do something
System.out.println("讀取Excel完畢");
// do something
}
}在MemberExcelListener中可以針對每條數(shù)據(jù)進行對應(yīng)的業(yè)務(wù)邏輯處理。
對外接口實現(xiàn)如下：
/**
* 基于Listener方式從Excel導(dǎo)入會員列表
*/
@RequestMapping(value = "/import2", method = RequestMethod.POST)
@ResponseBody
public void importMemberList2(@RequestPart("file") MultipartFile file) throws IOException {
// 方式一：同步讀取，將解析結(jié)果返回，比如返回List<Member>，業(yè)務(wù)再進行相應(yīng)的數(shù)據(jù)集中處理
// 方式二：對照doReadSync()方法的是最后調(diào)用doRead()方法，不進行結(jié)果返回，而是在MemberExcelListener中進行一條條數(shù)據(jù)的處理；
// 此處示例為方式二
EasyExcel.read(file.getInputStream(), Member.class, new MemberExcelListener()).sheet().doRead();
}這里采用了doRead()方法進行讀取操作。在PostMan中再次上傳Excel，打印日志如下：
讀取Member=Member(id=null, username=張三, birthday=Sun Nov 11 00:00:00 CST 1990, gender=0)
讀取Member=Member(id=null, username=王紅, birthday=Thu Apr 29 00:00:00 CST 1999, gender=1)
讀取Member=Member(id=null, username=李四, birthday=Thu Mar 09 00:00:00 CST 2000, gender=0)
讀取Excel完畢
說明解析成功，并且在解析的過程中，進行了業(yè)務(wù)邏輯的處理。
小結(jié)
文章基于SpringBoot集成EasyExcel的實現(xiàn)展開，為大家講解了EasyExcel在實踐中的具體運用。大家可根據(jù)需要，進行變通處理。同時，基于自定義轉(zhuǎn)換器、自定義策略、自定義監(jiān)聽器等形式達到靈活適用于各種場景。希望本篇文章能給大家?guī)韼椭?/p>
到此這篇關(guān)于Spring Boot + EasyExcel實現(xiàn)數(shù)據(jù)導(dǎo)入導(dǎo)出的文章就介紹到這了,更多相關(guān)Spring Boot 導(dǎo)入導(dǎo)出內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
- SpringBoot EasyPoi動態(tài)導(dǎo)入導(dǎo)出的兩種方式實現(xiàn)方法詳解
- SpringBoot+Vue實現(xiàn)EasyPOI導(dǎo)入導(dǎo)出的方法詳解
- 使用SpringBoot+EasyExcel+Vue實現(xiàn)excel表格的導(dǎo)入和導(dǎo)出詳解
- 使用VUE+SpringBoot+EasyExcel?整合導(dǎo)入導(dǎo)出數(shù)據(jù)的教程詳解
- SpringBoot整合EasyExcel實現(xiàn)文件導(dǎo)入導(dǎo)出
- SpringBoot中EasyExcel實現(xiàn)Excel文件的導(dǎo)入導(dǎo)出
- Spring?boot集成easy?excel實現(xiàn)導(dǎo)入導(dǎo)出功能
相關(guān)文章
這篇文章主要介紹了java?stream使用指南之sorted使用及進階方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-05-05
Spring Boot本身并不直接提供過濾敏感詞的功能,但你可以使用第三方庫或者自定義過濾器來實現(xiàn)這個需求,所以本文給大家介紹了SpringBoot過濾敏感詞的兩種實現(xiàn)方式,感興趣的朋友可以參考下2024-06-06
Spring boot 連接多數(shù)據(jù)源過程詳解
這篇文章主要介紹了Spring boot 連接多數(shù)據(jù)源過程詳解,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-08-08
MyBatis實現(xiàn)表連接查詢寫法(三種對應(yīng)關(guān)系)的方法總結(jié)
這篇文章主要介紹了MyBatis實現(xiàn)表連接查詢寫法(一對一關(guān)系、一對多關(guān)系、多對多關(guān)系)的方法，文中的示例代碼講解詳細(xì)，感興趣的可以了解一下2023-01-01
SpringBoot+jpa配置如何根據(jù)實體類自動創(chuàng)建表
這篇文章主要介紹了SpringBoot+jpa配置如何根據(jù)實體類自動創(chuàng)建表，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-11-11
本文給大家總結(jié)了java中的線程池的相關(guān)問題，非常的詳細(xì)也很實用，有需要的小伙伴可以參考下。2016-03-03
下面小編就為大家?guī)硪黄斦凧ava的線程和線程池。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2021-11-11
有時候，我們使用AOP來進行放的增強，編寫切面類的時候，需要定位在哪個方法上試用該切面進行增強，本片文章主要講解兩種在SpringBoot中定位切點的方法，感興趣的可以了解一下2021-06-06
這篇文章介紹了Java異常區(qū)分和處理的一些經(jīng)驗分享，主要是異常選擇和使用中的一些誤區(qū)總結(jié)與歸納，具有一定參考價值，需要的朋友可以了解下。2017-11-11
這篇文章主要介紹了JVM內(nèi)存結(jié)構(gòu)劃分實例解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-12-12