本文运用的emoji:

最近遇到一个需求,需求对页面的列表数据做导出操作,考虑了许多完结方案之后,最终选择了hutool的ExcelWriter + Spring自带的Reflet包来完结这个功用,选用这种方式的首要原因是对现有代码改动较少,而且能够无缝切入系统,完结各个模块的导出操作,规划思路如下:

使用Reflect封装Excel导出工具类

如上图所示,首要咱们界说一个接口,此接口完结Excel导出功用,在ExcelExportService 中完结功用。

话不多说,上代码:

界说ExcelExportEnum

使用Reflect封装Excel导出工具类

在导出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中,供后续代码运用

提取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,供后续调用分页列表接口传递入参匹配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工具包输出到流

// 经过工具类创立writer,默许创立xls格局 
ExcelWriter writer = ExcelUtil.getWriter(); 
//创立xlsx格局的 
//ExcelWriter writer = ExcelUtil.getWriter(true); 
// 一次性写出内容,运用默许款式,强制输出标题 
writer.write(rows, true); 
//out为OutputStream,需求写出到的方针流 
writer.flush(out); 
// 关闭writer,开释内存 
writer.close();

留意ExcelUtil.getWriter()默许创立xls格局的Excel,因而写出到客户端也需求自界说文件名为XXX.xls,否则会呈现文件损坏的提示。 若想生成xlsx格局,请运用ExcelUtil.getWriter(true)创立。


本文正在参加「金石计划 . 瓜分6万现金大奖」