SpringBootEasyPoi動(dòng)態(tài)導(dǎo)入導(dǎo)出的兩種方式實(shí)現(xiàn)方法詳解

第SpringBootEasyPoi動(dòng)態(tài)導(dǎo)入導(dǎo)出的兩種方式實(shí)現(xiàn)方法詳解目錄前言一、基于@Excel的isColumnHidden屬性1.1實(shí)現(xiàn)原理1.2實(shí)現(xiàn)步驟1.3實(shí)現(xiàn)效果二.基于ListExcelExportEntity的導(dǎo)出實(shí)現(xiàn)效果總結(jié)

前言

一開(kāi)始為了圖方便，使用的是土方法，即創(chuàng)建多個(gè)不同的實(shí)體類(lèi)，每個(gè)實(shí)體類(lèi)對(duì)應(yīng)不同的列。這樣雖說(shuō)能實(shí)現(xiàn)，但實(shí)在不想多復(fù)制實(shí)體類(lèi)，把代碼堆的和shi山一樣。于是查看官方文檔，里面確實(shí)提供了更加優(yōu)雅的實(shí)現(xiàn)方式。廢話(huà)不多說(shuō)，開(kāi)整。

一、基于@Excel的isColumnHidden屬性

我們項(xiàng)目使用的是注解方式導(dǎo)出，只需要在屬性上增加@Excel注解，就可以導(dǎo)出該屬性列。默認(rèn)大家都會(huì)使用了，不會(huì)使用的出門(mén)右轉(zhuǎn)去官網(wǎng)教程看看demo。

要?jiǎng)討B(tài)導(dǎo)出列，我們需要用到isColumnHidden這個(gè)屬性。

可以看到，isColumnHidden中提供的默認(rèn)值是false，也就是默認(rèn)全部導(dǎo)出，不隱藏。把值設(shè)為true，導(dǎo)出就沒(méi)有該列了。所以這個(gè)問(wèn)題就變成，導(dǎo)出要想動(dòng)態(tài)顯示哪些列，只需要?jiǎng)討B(tài)設(shè)置isColumnHidden的值就可以實(shí)現(xiàn)。

1.1實(shí)現(xiàn)原理

JAVA反射機(jī)制是在運(yùn)行狀態(tài)中，對(duì)于任意一個(gè)實(shí)體類(lèi)，都能夠知道這個(gè)類(lèi)的所有屬性和方法；對(duì)于任意一個(gè)對(duì)象，都能夠調(diào)用它的任意方法和屬性；這種動(dòng)態(tài)獲取信息以及動(dòng)態(tài)調(diào)用對(duì)象方法的功能稱(chēng)為java語(yǔ)言的反射機(jī)制。

利用JAVA反射機(jī)制。根據(jù)反射機(jī)制，我們可以拿到一個(gè)類(lèi)的所有屬性和方法，同理，注解也是一個(gè)類(lèi)，也是可以拿到它的屬性和方法，拿到之后就好辦了，直接修改它的默認(rèn)值，然后根據(jù)不同的條件調(diào)整，就可以達(dá)到一個(gè)類(lèi)實(shí)現(xiàn)動(dòng)態(tài)導(dǎo)出的目的。

1.2實(shí)現(xiàn)步驟

先創(chuàng)建一個(gè)工具類(lèi)，傳入對(duì)象，獲取注解值，并修改。

代碼如下（示例）：

/**

*@description動(dòng)態(tài)顯示Excel導(dǎo)出列

*@date2025/8/31

publicclassEasyPoiUtilT{

*需要被反射的對(duì)象，使用泛型規(guī)范傳入對(duì)象

publicTt;

publicvoidhiddColumn(StringcolumnName,Booleantarget)throwsException{

if(t==null){

thrownewClassNotFoundException("TARGETOBJECTNOTFOUNT");

if(StringUtils.isEmpty(columnName)){

thrownewNullPointerException("COLUMNNAMENOTNULL");

if(target==null){

target=true;

//獲取目標(biāo)對(duì)象的屬性值

Fieldfield=t.getClass().getDeclaredField(columnName);

//獲取注解反射對(duì)象

ExcelexcelAnnon=field.getAnnotation(Excel.class);

//獲取代理

InvocationHandlerinvocationHandler=Proxy.getInvocationHandler(excelAnnon);

FieldexcelField=invocationHandler.getClass().getDeclaredField("memberValues");

//因?yàn)檫@個(gè)字段是privatefinal修飾，所以要打開(kāi)權(quán)限

excelField.setAccessible(true);

MapmemberValues=(Map)excelField.get(invocationHandler);

memberValues.put("isColumnHidden",target);

}

然后在需要導(dǎo)出的數(shù)據(jù)中更改對(duì)應(yīng)條件能看到的列，這里以實(shí)際項(xiàng)目里的代碼為例

publicListExportVobatchLiveUserExport(LiveUserliveUser){

ListExportVovoList=baseMapper.batchLiveUserExport(liveUser);

LiveInfoliveInfo=liveInfoService.getById(liveUser.getLiveId());

if(liveInfo!=null){

LiveSpecialliveSpecial=liveSpecialService.getById(liveInfo.getSpecialId());

if("2".equals(liveSpecial.getLivePlatform())){

setHiddColumn(voList,true);

}else{

setHiddColumn(voList,false);

returnvoList;

privatevoidsetHiddColumn(ListExportVolist,Booleanvalue){

if(CollectionUtil.isNotEmpty(list)){

for(ExportVovo:list){

EasyPoiUtilExportVoeasyPoiUtil=newEasyPoiUtil();

easyPoiUtil.t=vo;

//是否導(dǎo)出參與狀態(tài)一列true導(dǎo)出false不導(dǎo)出

try{

easyPoiUtil.hiddColumn("isJoin",value);

}catch(Exceptione){

e.printStackTrace();

}

1.3實(shí)現(xiàn)效果

可以看到導(dǎo)出的表格，參與狀態(tài)一列，是根據(jù)條件動(dòng)態(tài)顯示了。（其實(shí)也全部導(dǎo)出了，只是隱藏了列，通過(guò)Execl里的設(shè)置還是可以顯示隱藏列的，對(duì)這點(diǎn)有要求的此方式或者不適用）

二.基于ListExcelExportEntity的導(dǎo)出

上面說(shuō)到，利用@Execl的isColumnHidden屬性動(dòng)態(tài)設(shè)置值，只是在導(dǎo)出時(shí)隱藏了該列而已，實(shí)際上也還是全部導(dǎo)出了。

要徹底的不導(dǎo)出，官方也給出了解決方案：基于ListExcelExportEntity的導(dǎo)出

ExcelExportEntity是注解經(jīng)過(guò)處理翻譯成的實(shí)體類(lèi)，兩者幾乎是一對(duì)的，所以如果我們要?jiǎng)討B(tài)自定義導(dǎo)出列，只要?jiǎng)討B(tài)拼裝ExcelExportEntity就可以了

例如上面的栗子，我們只導(dǎo)出姓名，學(xué)號(hào)，手機(jī)號(hào)，通知狀態(tài)四列，代碼如下（示例）：

/**

*根據(jù)條件動(dòng)態(tài)生成列信息

privateListExcelExportEntitydynaCol(Stringtype){

ListExcelExportEntitycolList=newArrayListExcelExportEntity

colList.add(newExcelExportEntity("姓名","realName"));

colList.add(newExcelExportEntity("學(xué)號(hào)","studNo"));

if("2".equals(type)){

colList.add(newExcelExportEntity("手機(jī)號(hào)","phoneNumber"));

ExcelExportEntityexcelentity=newExcelExportEntity("通知狀態(tài)","isSms");

//值替換

String[]isSmsReplace={"未發(fā)送_N","已發(fā)送_Y","_null"};

excelentity.setReplace(isSmsReplace);

colList.add(excelentity);

returncolList;

*導(dǎo)出偽代碼

@GetMapping(value="batchExport")

publicvoidbatchExport(LiveUserliveUser,HttpServletResponseresponse){

//查詢(xún)出導(dǎo)出的結(jié)果集

ListLiveUserExportVoliveUsers=liveUserService.batchLiveUserExport(liveUser);

//根據(jù)條件動(dòng)態(tài)生成列信息

ListExcelExportEntitybeanList=dynaCol("2");