Java利用Reflect實現封裝Excel導出工具類

更新時間：2022年11月07日 14:51:11 作者：Zeuss

這篇文章主要為大家詳細介紹了Java如何利用Reflect實現封裝Excel導出工具類，文中的實現方法講解詳細，具有一定的借鑒價值，需要的可以參考一下

最近遇到一個需求，需要對頁面的列表數據做導出操作,考慮了很多實現方案之后，最終選擇了hutool的ExcelWriter + Spring自帶的ReflectionUtils工具類來實現這個功能，采用這種方式的主要原因是對現有代碼改動較少，并且可以無縫切入系統，實現各個模塊的導出操作，設計思路如下：

如上圖所示，首先我們定義一個接口，此接口完成Excel導出功能，在ExcelExportService 中實現功能。

話不多說，上代碼：

定義ExcelExportEnum

在導出Excel之前，我們需要先定義ExcelExportEnum，此枚舉存儲了我們后端需要導出的模塊和模板名稱

@Getter
@RequiredArgsConstructor
public enum ExcelExportEnum {

/**
 * 模塊
 */
MODULE_A("moduleAService", "模塊A");

private final String key;
private final String name;

}

定義導出方法

校驗入參

首先，我們需要對入參進行校驗，查看傳入的 MODULE_NAME 是否和后端Enum的一致，并且我們需要對參數中的自定義方法名進行提取，我們通過ExcelExportEnum來獲取導出的module的Service名稱

    if (!map.containsKey(MODULE_NAME)) {
        throw new BaseException("缺少參數：moduleName");
    }
    String moduleName = map.get(MODULE_NAME).toString();
    if (!EnumUtil.contains(ExcelExportEnum.class, moduleName)) {
        throw new BaseException("模塊查找失敗");
    }
    String functionName = DEFAULT_FUNCTION_NAME;
    //如果傳了自定義方法名
    if (map.containsKey(CUSTOM_FUNCTION_NAME)) {
        functionName = map.get(CUSTOM_FUNCTION_NAME).toString();
    }
    String serviceName = ExcelExportEnum.valueOf(moduleName).getKey();
    String tableName = ExcelExportEnum.valueOf(moduleName).getName();

利用java反射獲取Service中的所有method

Map<String, Method> methodMap = Arrays.stream(SpringContextHolder.getBean(serviceName).getClass().getMethods()).collect(Collectors.toMap(Method::getName, Function.identity(), (key1, key2) -> key2));

在上述代碼中SpringContextHolder.getBean(serviceName).getClass().getMethods()方法，首先通過getBean來獲取第一步中得到的ServiceName的Java bean。然后通過Class.getMethods()方法獲取此service中的所有方法

最后，使用Arrays.stream方法，將module對應的Service中的所有method獲取到，并放入methodMap中，供后續(xù)代碼使用

提取method中的入參對象，獲取其Class

    Object o;
    try {
        o = methodMap.get(functionName).getParameterTypes()[0].getDeclaredConstructor().newInstance();
    } catch (Exception e) {
        throw new BaseException(e);
    }

通過Method.getParameterTypes()方法，將第二步中獲取的method的入參的Class取到，并賦值給對象Object o，供后續(xù)調用分頁列表接口傳遞入參匹配Class使用

傳入參數，調用導出方法

    Map<String, Object> param = (Map<String, Object>) map.computeIfAbsent(PARAM, k -> new HashMap<String, Object>(4));
    param.put("limit", -1);
    CopyOptions copyOptions = new CopyOptions();
    copyOptions.setIgnoreError(true);
    PageUtils page = (PageUtils) methodMap.get(functionName).invoke(SpringContextHolder.getBean(serviceName), BeanUtil.mapToBean(param, o.getClass(), true, copyOptions));
    if (CollUtil.isEmpty(page.getList())) {
        throw new BaseException("數據獲取失敗");
    }
    Object resultObject = page.getList().get(0);
    ExcelUtils utils = new ExcelUtils(resultObject.getClass());
    utils.exportExcel(page.getList(), response, tableName, moduleName);

可以看到，在上述導出方法中，我們使用了Method.invoke方法，并且設置轉義忽略

注意事項

使用hutool工具包輸出到流

// 通過工具類創(chuàng)建writer，默認創(chuàng)建xls格式 
ExcelWriter writer = ExcelUtil.getWriter(); 
//創(chuàng)建xlsx格式的 
//ExcelWriter writer = ExcelUtil.getWriter(true); 
// 一次性寫出內容，使用默認樣式，強制輸出標題 
writer.write(rows, true); 
//out為OutputStream，需要寫出到的目標流 
writer.flush(out); 
// 關閉writer，釋放內存 
writer.close();

注意 ExcelUtil.getWriter()默認創(chuàng)建xls格式的Excel，因此寫出到客戶端也需要自定義文件名為XXX.xls，否則會出現文件損壞的提示。若想生成xlsx格式，請使用ExcelUtil.getWriter(true)創(chuàng)建。

到此這篇關于Java利用Reflect實現封裝Excel導出工具類的文章就介紹到這了,更多相關Java Reflect封裝Excel導出工具類內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: