Spring Boot 如何设计一个通用的 Excel 导入导出功能?

图片


以JSON配置的方式去实现通用性和动态调整,当然,这个通用仍然存在一定的局限性,每个项目的代码风格都不同,想要写出一个适合所有项目的通用性模块并不容易,这里的通用局限于其所在项目,所以该功能代码如果不适用于自己的项目,希望可以以此为参考,稍作修改。

那么现在来分析一下,我们会需要哪些JSON配置项。

导出

基础配置项

先从最简单的导出开始,被导出数据应该支持通过业务层查出,如:Service.search(param),这是大前提,然后为了支持显示导出进度,业务层还需要提供数量查询方法,如:Service.count(param),否则无法实现导出进度。

最后导出文件名也可以定制,如:filename

由上可以得出配置项:

  • serviceClazz: 业务类路径,如:com.cc.service.UserService,必填

  • methodName: 查询方法名,如:listByCondition,必填

  • countMethodName: 数量查询方法名,可填,用于支持导出进度

  • filename: 导出文件名

  • searchParams: 查询参数,数组类型,字典元素。用数组是为了支持查询方法需要传多参数的情况

至于查询方法的参数类,不需要填,因为我们可以通过反射去获取到该方法所需要传入的参数类型(注意,以下贴出的是关键代码,仅作参考理解):

Class<?> serviceClass = Class.forName(param.getServiceClazz());

// param为请求参数类
Method searchMethod = ReflectUtil.findMethodByName(serviceClass, param.getMethodName());

// 方法所需要传入的参数列表
Class<?>[] parameterTypes = searchMethod.getParameterTypes();
/**
 * 通过反射从指定类中获取方法对象
 */
public static Method findMethodByName(Class<?> clazz, String name) {
    Method[] methods = clazz.getMethods();
    if (StringUtils.isEmpty(name)) {
        return null;
    }
    for (Method method : methods) {
        if (method.getName().equals(name)) {
            return method;
        }
    }
    return null;
}

现在我们来想想,导出都会有哪些场景:

  • 列表页的分页查询,可能是当前页数据导出,也可能是所有数据导出,这涉及到分页查询

  • 数据总览页的查询,通常是开发者自定义的复杂连表查询,不需要分页

那么本文针对以上两种情况来实现第一版的通用导出功能。

列表页的分页查询

列表页的数据导出分当前页导出和所有数据导出,假设查询流程是这样的:

  • 接口层接收参数:Controller.search(Param param)

  • 业务层调用查询方法:Service.search(param)

  • 持久层访问数据库:Mapper.search(param)

这种情况很简单,但如果流程是这样的:

  • 接口层接收参数:Controller.search(Param param)

  • 业务层调用查询方法:Service.search(new Condition(param))

  • 持久层访问数据库:Mapper.search(condition)

上面代码中,接口请求参数和持久层参数不一致,在业务层经过了包装,那么这种情况也要兼容处理。

但是如果请求参数在业务层经过了包中包中包,那么就算了。

接着是分页参数,我们用pageNum和pageSize来表示页码和数量字段,类似于:

{
    "pageNum": 1,
    "pageSize": 10,
    "name": "老刘" // 此为查询字段,如查询名字为老刘的数据
}

关于当前页导出和所有数据导出,可以用一个bool来表示:onlyCurrentPage,默认false,即导出时会自动分页查询数据,直到所有数据查询完毕,导出所有数据时分页查询很有必要,能提高性能,避免内存溢出,当onlyCurrentPage为true时,则只导出当前页面数据。

得出需要的配置项为:

  • searchParam: 接口分页请求参数,JSON类型,必填

  • conditionClazz: 条件查询类,也可以认为是包装类,如:com.cc.codition.UserCondition,可填

  • onlyCurrentPage: 仅当前页导出,默认false,可填

数据总览页的查询

数据总览数据没有数量查询方法,即Service.count(xxx),也没有分页查询参数,类似于当前页导出,在也只考虑一层包装类的情况下,没有额外的配置项,上面的已经足够了,要注意的就是代码里面得把分页参数剔除掉。

  • 87
    点赞
  • 34
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

「已注销」

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值