JeecgBoot Vue3 实现前端分页不重复请求接口的解决方案

背景介绍

在JeecgBoot Vue3 3.6.0版本中，默认的分页组件实现方式是每次翻页都会向服务器发送新的请求获取数据。这种设计在大多数场景下是合理的，因为它可以避免一次性加载大量数据导致的前端性能问题。然而，在某些特定业务场景下，我们需要一次性获取所有数据并在前端进行分页展示，这时就需要对默认的分页行为进行改造。

问题分析

传统JeecgBoot的分页实现存在以下特点：

1. 每次翻页都会触发新的API请求
2. 分页参数(pageNo, pageSize)会作为请求参数发送到后端
3. 后端根据分页参数返回对应的数据片段

当我们需要实现前端分页时，需要解决以下技术难点：

1. 如何一次性获取所有数据
2. 如何在前端实现分页逻辑
3. 如何保持原有分页组件的UI和交互不变

解决方案

方案一：修改API请求逻辑

1. 重写列表查询方法： 在Vue组件中，可以重写列表查询方法，使其只在第一次加载时获取全部数据，后续翻页操作不再触发API请求。

// 在data中增加缓存变量
data() {
  return {
    allData: [], // 存储所有数据
    isFirstLoad: true // 标记是否首次加载
  }
}

// 修改加载方法
async loadData(arg) {
  if(this.isFirstLoad) {
    // 首次加载获取所有数据
    const res = await getAction(this.url.list, {pageNo: 1, pageSize: 9999})
    if(res.success) {
      this.allData = res.result.records || []
      this.dataSource = this.getPageData(1) // 获取第一页数据
    }
    this.isFirstLoad = false
  }
  // 非首次加载不执行任何操作
}

// 前端分页方法
getPageData(pageNo) {
  const start = (pageNo - 1) * this.ipagination.pageSize
  const end = start + this.ipagination.pageSize
  return this.allData.slice(start, end)
}

2. 监听分页变化： 监听分页参数变化，当页码变化时从缓存数据中获取对应页的数据。

watch: {
  'ipagination.current'(val) {
    this.dataSource = this.getPageData(val)
  }
}

方案二：使用JeecgBoot内置功能

JeecgBoot Vue3版本其实已经内置了对前端分页的支持，可以通过配置实现：

1. 在列表配置中设置： 在组件的created或mounted钩子中添加以下配置：

this.defFlag = true // 启用默认查询
this.loadAllData = true // 加载所有数据

2. 修改分页配置： 调整分页配置对象，添加前端分页相关参数：

this.ipagination = {
  current: 1,
  pageSize: 10,
  pageSizeOptions: ['10', '20', '30'],
  showTotal: (total, range) => {
    return range[0] + '-' + range[1] + ' 共' + total + '条'
  },
  showQuickJumper: true,
  showSizeChanger: true,
  total: 0,
  frontPaging: true // 关键参数，启用前端分页
}

注意事项

1. 数据量控制： 前端分页适合数据量不大的场景，建议在数据量小于1000条时使用此方案。对于大数据量，仍推荐使用后端分页。

2. 性能优化： 当数据量较大时，可以考虑以下优化措施：

   • 使用虚拟滚动代替传统分页
   • 对列表数据进行懒加载
   • 使用Web Worker处理大数据

3. 状态保持： 如果需要在页面跳转后保持分页状态，需要将当前页码和分页大小存储在Vuex或本地存储中。

最佳实践

在实际项目中，推荐采用以下实现方式：

1. 创建混合(mixin)： 可以创建一个专门用于前端分页的mixin，方便在多个组件中复用。

// frontPagingMixin.js
export default {
  data() {
    return {
      allData: [],
      isFrontPaging: true
    }
  },
  methods: {
    async loadAllDataOnce() {
      if(this.isFrontPaging && this.allData.length === 0) {
        const res = await getAction(this.url.list, {pageNo: 1, pageSize: 9999})
        if(res.success) {
          this.allData = res.result.records || []
          this.ipagination.total = this.allData.length
          this.dataSource = this.getPageData(1)
        }
      }
    },
    getPageData(pageNo) {
      const start = (pageNo - 1) * this.ipagination.pageSize
      const end = start + this.ipagination.pageSize
      return this.allData.slice(start, end)
    }
  }
}

2. 在组件中使用： 在需要前端分页的组件中引入该mixin：

import frontPagingMixin from './mixins/frontPagingMixin'

export default {
  mixins: [frontPagingMixin],
  // ...其他组件代码
}

通过以上方案，我们可以在JeecgBoot Vue3项目中实现前端分页功能，既满足了业务需求，又保持了良好的用户体验。