7.5.1 分页组件Pagination-Yii2框架从入门到精通(中)

当前位置:　首页>> 技术小册>> Yii2框架从入门到精通(中)

### 7.5.1 分页组件Pagination

在Web开发中，当数据量非常大时，一次性加载所有数据到页面上不仅会导致加载时间过长，还可能因为数据量过大而消耗过多的服务器资源和带宽，进而影响用户体验。为了解决这个问题，分页技术应运而生。Yii2框架作为一个高效、灵活的PHP开发框架，提供了强大的分页组件`Pagination`，帮助开发者轻松实现数据的分页显示。

#### 7.5.1.1 Pagination组件概述

`Pagination`组件是Yii2中用于处理数据分页的一个核心组件，它位于`yii\data`命名空间中。通过该组件，开发者可以指定每页显示的记录数、当前页码等参数，`Pagination`会自动计算出总页数、起始记录位置等信息，并可以根据需要生成分页链接。这些分页链接可以嵌入到视图文件中，以便用户通过点击链接来浏览不同页的数据。

#### 7.5.1.2 配置Pagination组件

在Yii2中，`Pagination`组件可以通过配置数组或直接在控制器中实例化后配置其属性。常见的配置属性包括：

- `pageSize`：每页显示的记录数，默认为20。
- `totalCount`：数据总数，这是分页计算的基础。
- `defaultPageSize`：如果没有明确设置`pageSize`且请求中也没有`per-page`参数时，将使用此值作为每页的记录数。
- `validatePage`：是否验证请求的页码是否有效（例如，不超出总页数范围），默认为true。
- `forcePageParam`：自定义用于传递当前页码的GET参数名，默认为`page`。
- `route`：用于生成分页链接的URL路由信息，可以是字符串或数组。
- `params`：生成分页链接时附加到URL的额外参数。

#### 7.5.1.3 使用Pagination组件实现分页

实现分页通常涉及几个步骤：查询数据总数、配置`Pagination`组件、根据`Pagination`组件的提示获取当前页的数据、在视图中渲染分页链接和数据。

##### 示例场景

假设我们有一个用户表，现在需要根据用户的ID或用户名进行搜索，并显示搜索结果的分页列表。

**步骤1：查询数据总数**

首先，需要查询出符合搜索条件的用户总数。这通常是通过SQL的`COUNT`函数实现的。

```php
$count = User::find()->where(['like', 'username', $search])->count();
```

这里`$search`是用户输入的搜索词，用于过滤用户名。

**步骤2：配置Pagination组件**

在控制器中，根据查询到的总数配置`Pagination`组件。

```php
use yii\data\Pagination;

$pagination = new Pagination([
    'totalCount' => $count,
    'pageSize' => 10, // 每页显示10条记录
]);
```

**步骤3：获取当前页的数据**

使用`Pagination`组件的`offset`和`limit`属性来设置查询的起始位置和记录数，从而获取当前页的数据。

```php
$users = User::find()
    ->where(['like', 'username', $search])
    ->offset($pagination->offset)
    ->limit($pagination->limit)
    ->all();
```

**步骤4：在视图中渲染分页链接和数据**

将`$users`和`$pagination`传递到视图文件中，并使用`LinkPager`小部件来渲染分页链接。

```php
// 控制器中
return $this->render('index', [
    'users' => $users,
    'pagination' => $pagination,
]);

// 视图文件中
use yii\widgets\LinkPager;

// 显示用户数据...

echo LinkPager::widget([
    'pagination' => $pagination,
]);
```

`LinkPager`小部件会根据`$pagination`对象自动生成分页链接，并将其嵌入到HTML中。

#### 7.5.1.4 进阶使用

- **自定义分页样式**：`LinkPager`小部件支持通过配置数组来自定义分页链接的样式，如`options`、`linkOptions`、`prevPageLabel`、`nextPageLabel`等。
- **Ajax分页**：Yii2支持通过Ajax实现无刷新分页。这通常需要在客户端使用JavaScript监听分页链接的点击事件，并发送Ajax请求获取新页的数据，然后更新页面内容。Yii2的`Pjax`小部件可以简化这一过程。
- **结合ActiveDataProvider**：在更复杂的场景中，可以使用`ActiveDataProvider`来替代直接配置`Pagination`。`ActiveDataProvider`不仅包含分页逻辑，还集成了排序和过滤功能，是处理复杂数据列表的推荐方式。

#### 7.5.1.5 总结

Yii2的`Pagination`组件提供了灵活且强大的分页功能，通过简单的配置即可实现数据的分页显示。在实际开发中，根据具体需求选择合适的分页实现方式，可以极大地提升用户体验和系统性能。无论是通过直接配置`Pagination`组件，还是使用`ActiveDataProvider`结合`LinkPager`小部件，Yii2都提供了丰富的API和灵活的配置选项，以满足不同场景下的分页需求。

该分类下的相关小册推荐：

PHP8入门与项目实战（1）

HTTP权威指南

PHP程序员面试笔试真题与解析

PHP8入门与项目实战（3）

PHP高并发秒杀入门与实战

PHP合辑2-高级进阶

Swoole入门教程

Laravel(10.x)从入门到精通(十三)

Shopify应用实战开发

Laravel(10.x)从入门到精通(十)

Laravel(10.x)从入门到精通(九)

全栈工程师修炼指南