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

更新時間：2022年09月24日 10:19:36 作者：Java升級之路

項目里使用的是EasyPoi來處理導入導出功能的。近日因業(yè)務需求調(diào)整，一些導出功能的導出列需要根據(jù)不同的條件動態(tài)導出

前言

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

一、基于@Excel的 isColumnHidden 屬性

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

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

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

1.1 實現(xiàn)原理

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

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

1.2 實現(xiàn)步驟

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

代碼如下（示例）：

/**
 * @description  動態(tài)顯示Excel導出列
 * @date 2022/8/31
 */
public class EasyPoiUtil<T> {
    /**
     * 需要被反射的對象，使用泛型規(guī)范傳入對象
     */
    public T t;
    public void hiddColumn(String columnName, Boolean target) throws Exception {
        if (t == null) {
            throw new ClassNotFoundException("TARGET OBJECT NOT FOUNT");
        }
        if (StringUtils.isEmpty(columnName)) {
            throw new NullPointerException("COLUMN NAME NOT NULL");
        }
        if (target == null) {
            target = true;
        }
        // 獲取目標對象的屬性值
        Field field = t.getClass().getDeclaredField(columnName);
        // 獲取注解反射對象
        Excel excelAnnon = field.getAnnotation(Excel.class);
        // 獲取代理
        InvocationHandler invocationHandler = Proxy.getInvocationHandler(excelAnnon);
        Field excelField = invocationHandler.getClass().getDeclaredField("memberValues");
        // 因為這個字段是 private final 修飾，所以要打開權限
        excelField.setAccessible(true);
        Map memberValues = (Map) excelField.get(invocationHandler);
        memberValues.put("isColumnHidden", target);
    }
}

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

public List<ExportVo> batchLiveUserExport(LiveUser liveUser) {
        List<ExportVo> voList = baseMapper.batchLiveUserExport(liveUser);
        LiveInfo liveInfo = liveInfoService.getById(liveUser.getLiveId());
        if (liveInfo != null) {
            LiveSpecial liveSpecial = liveSpecialService.getById(liveInfo.getSpecialId());
            if ("2".equals(liveSpecial.getLivePlatform())) {
                setHiddColumn(voList,true);
            } else {
                setHiddColumn(voList,false);
            }
        }
        return voList;
    }
    private void setHiddColumn(List<ExportVo> list, Boolean value) {
        if (CollectionUtil.isNotEmpty(list)) {
            for (ExportVo vo : list) {
                EasyPoiUtil<ExportVo> easyPoiUtil = new EasyPoiUtil<>();
                easyPoiUtil.t = vo;
                // 是否導出 參與狀態(tài) 一列  true 導出   false 不導出
                try {
                    easyPoiUtil.hiddColumn("isJoin", value);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
    }

1.3 實現(xiàn)效果

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

二. 基于List< ExcelExportEntity > 的導出

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

要徹底的不導出，官方也給出了解決方案：基于List< ExcelExportEntity> 的導出

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

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

   /**
     * 根據(jù)條件動態(tài)生成列信息
     **/
    private List<ExcelExportEntity> dynaCol(String type) {
        List<ExcelExportEntity> colList = new ArrayList<ExcelExportEntity>();
        colList.add(new ExcelExportEntity("姓名", "realName"));
        colList.add(new ExcelExportEntity("學號", "studNo"));
        if ("2".equals(type)) {
            colList.add(new ExcelExportEntity("手機號", "phoneNumber"));
            ExcelExportEntity excelentity = new ExcelExportEntity("通知狀態(tài)", "isSms");
            // 值替換
            String[] isSmsReplace = {"未發(fā)送_N", "已發(fā)送_Y","_null"};
            excelentity.setReplace(isSmsReplace);
            colList.add(excelentity);
        }
        return colList;
    }
    /**
     * 導出 偽代碼
     **/
    @GetMapping(value = "batchExport")
    public void batchExport(LiveUser liveUser, HttpServletResponse response){
        // 查詢出導出的結果集
        List<LiveUserExportVo> liveUsers = liveUserService.batchLiveUserExport(liveUser);
        // 根據(jù)條件動態(tài)生成列信息
        List<ExcelExportEntity> beanList = dynaCol("2");
        // 導出
        ExcelUtil.exportExcelX(liveUsers, beanList,"名單.xls",  response,new ExportParams("名單", "名單"));
    }