Vue / 系统课时
封装分页组件
封装分页组件
列表分页容易出现页码、每页数量和请求参数不同步的问题。本课将分页状态统一成受控组件,并约定筛选变化时先回到第一页,再发起一次新的列表请求。
学习目标
- 使用双向绑定统一当前页和每页数量
- 在切换页码或每页数量时只触发一次查询
- 在筛选条件变化后正确重置页码
设计分页状态协议
分页组件只负责交互,不直接请求接口。父页面通过 v-model:page、v-model:page-size 维护状态,组件通过 change 事件把最终的页码和每页数量一次性通知父页面。
每页数量变化时,旧页码可能超出新的总页数,因此组件应把页码重置为 1。筛选条件变化同样由父页面主动重置页码,避免在第 5 页搜索后误以为没有数据。

实现分页组件
以下为片段示例,依赖项目已安装并注册 Element Plus。新建 src/components/AppPagination.vue:
vue
<script setup lang="ts">
const props = withDefaults(
defineProps<{
page: number
pageSize: number
total: number
pageSizes?: number[]
disabled?: boolean
}>(),
{
pageSizes: () => [10, 20, 50, 100],
disabled: false
}
)
const emit = defineEmits<{
'update:page': [value: number]
'update:pageSize': [value: number]
change: [payload: { page: number; pageSize: number }]
}>()
function handlePageChange(nextPage: number) {
emit('update:page', nextPage)
emit('change', { page: nextPage, pageSize: props.pageSize })
}
function handleSizeChange(nextPageSize: number) {
// 每页数量变化后回到第一页,避免页码超出有效范围
emit('update:pageSize', nextPageSize)
emit('update:page', 1)
emit('change', { page: 1, pageSize: nextPageSize })
}
</script>
<template>
<div v-if="total > 0" class="app-pagination">
<el-pagination
:current-page="page"
:page-size="pageSize"
:page-sizes="pageSizes"
:total="total"
:disabled="disabled"
layout="total, sizes, prev, pager, next, jumper"
background
@current-change="handlePageChange"
@size-change="handleSizeChange"
/>
</div>
</template>
<style scoped>
.app-pagination {
display: flex;
justify-content: flex-end;
margin-top: 16px;
}
</style>预期结果:
text
total 大于 0 时显示分页栏;切换页码会更新 page;切换每页数量会更新 pageSize,并把 page 重置为 1。接入列表查询
父页面负责筛选条件和接口调用。下面使用 fetch 演示完整联动,接口约定返回 { items, total }:
vue
<script setup lang="ts">
import { onMounted, reactive, ref } from 'vue'
import AppPagination from '@/components/AppPagination.vue'
interface User {
id: number
name: string
}
const filters = reactive({ keyword: '' })
const page = ref(1)
const pageSize = ref(20)
const total = ref(0)
const rows = ref<User[]>([])
const loading = ref(false)
async function loadUsers(target = { page: page.value, pageSize: pageSize.value }) {
loading.value = true
try {
const params = new URLSearchParams({
keyword: filters.keyword,
page: String(target.page),
pageSize: String(target.pageSize)
})
const response = await fetch(`/api/users?${params.toString()}`)
if (!response.ok) {
throw new Error(`请求失败:${response.status}`)
}
const result = (await response.json()) as { items: User[]; total: number }
rows.value = result.items
total.value = result.total
} finally {
loading.value = false
}
}
function handleSearch() {
page.value = 1
loadUsers({ page: 1, pageSize: pageSize.value })
}
function handlePageChange(payload: { page: number; pageSize: number }) {
loadUsers(payload)
}
onMounted(() => loadUsers())
</script>
<template>
<el-form inline @submit.prevent>
<el-form-item label="关键词">
<el-input v-model="filters.keyword" clearable />
</el-form-item>
<el-form-item>
<el-button type="primary" @click="handleSearch">查询</el-button>
</el-form-item>
</el-form>
<el-table v-loading="loading" :data="rows">
<el-table-column prop="name" label="姓名" />
</el-table>
<AppPagination
v-model:page="page"
v-model:page-size="pageSize"
:total="total"
:disabled="loading"
@change="handlePageChange"
/>
</template>预期结果:
text
首次进入页面请求第 1 页;点击“查询”后页码先重置为 1;切换页码或每页数量时,请求参数与分页栏保持一致。实际接口地址、返回字段和数据类型可能不同,应按项目约定调整。请求期间禁用分页组件,可以减少连续点击导致的重复请求;更严格的场景还可以配合请求取消或序列号,只接收最后一次响应。
避免重复请求
不要同时监听 page、pageSize 并在 change 事件中再次请求,否则一次交互可能触发两次接口调用。推荐由分页组件汇总最终状态,再通过一个 change 事件驱动查询。
筛选条件也不宜使用无节制的深度监听。按钮查询适合后台管理场景;若必须输入即搜索,应增加防抖,并在防抖回调中执行“重置页码再查询”。
按自己的节奏,确认真正理解。