SpringBootEasyPoi動態(tài)導入導出的兩種方式實現方法詳解

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

前言

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

一、基于@Excel的isColumnHidden屬性

我們項目使用的是注解方式導出，只需要在屬性上增加@Excel注解，就可以導出該屬性列。默認大家都會使用了，不會使用的出門右轉去官網教程看看demo。

要動態(tài)導出列，我們需要用到isColumnHidden這個屬性。

可以看到，isColumnHidden中提供的默認值是false，也就是默認全部導出，不隱藏。把值設為true，導出就沒有該列了。所以這個問題就變成，導出要想動態(tài)顯示哪些列，只需要動態(tài)設置isColumnHidden的值就可以實現。

1.1實現原理

JAVA反射機制是在運行狀態(tài)中，對于任意一個實體類，都能夠知道這個類的所有屬性和方法；對于任意一個對象，都能夠調用它的任意方法和屬性；這種動態(tài)獲取信息以及動態(tài)調用對象方法的功能稱為java語言的反射機制。

利用JAVA反射機制。根據反射機制，我們可以拿到一個類的所有屬性和方法，同理，注解也是一個類，也是可以拿到它的屬性和方法，拿到之后就好辦了，直接修改它的默認值，然后根據不同的條件調整，就可以達到一個類實現動態(tài)導出的目的。

1.2實現步驟

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

代碼如下（示例）：

/**

*@description動態(tài)顯示Excel導出列

*@date2025/8/31

publicclassEasyPoiUtilT{

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

publicTt;

publicvoidhiddColumn(StringcolumnName,Booleantarget)throwsException{

if(t==null){

thrownewClassNotFoundException("TARGETOBJECTNOTFOUNT");

if(StringUtils.isEmpty(columnName)){

thrownewNullPointerException("COLUMNNAMENOTNULL");

if(target==null){

target=true;

//獲取目標對象的屬性值

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

//獲取注解反射對象

ExcelexcelAnnon=field.getAnnotation(Excel.class);

//獲取代理

InvocationHandlerinvocationHandler=Proxy.getInvocationHandler(excelAnnon);

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

//因為這個字段是privatefinal修飾，所以要打開權限

excelField.setAccessible(true);

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

memberValues.put("isColumnHidden",target);

}

然后在需要導出的數據中更改對應條件能看到的列，這里以實際項目里的代碼為例

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;

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

try{

easyPoiUtil.hiddColumn("isJoin",value);

}catch(Exceptione){

e.printStackTrace();

}

1.3實現效果

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

二.基于ListExcelExportEntity的導出

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

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

ExcelExportEntity是注解經過處理翻譯成的實體類，兩者幾乎是一對的，所以如果我們要動態(tài)自定義導出列，只要動態(tài)拼裝ExcelExportEntity就可以了

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

/**

*根據條件動態(tài)生成列信息

privateListExcelExportEntitydynaCol(Stringtype){

ListExcelExportEntitycolList=newArrayListExcelExportEntity

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

colList.add(newExcelExportEntity("學號","studNo"));

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

colList.add(newExcelExportEntity("手機號","phoneNumber"));

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

//值替換

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

excelentity.setReplace(isSmsReplace);

colList.add(excelentity);

returncolList;

*導出偽代碼

@GetMapping(value="batchExport")

publicvoidbatchExport(LiveUserliveUser,HttpServletResponseresponse){

//查詢出導出的結果集

ListLiveUserExportVoliveUsers=liveUserService.batchLiveUserExport(liveUser);

//根據條件動態(tài)生成列信息

ListExcelExportEntitybeanList=dynaCol("2");