Yii2数据库分页操作方法介绍

Posted 2020-09-30 brucemengbm

本章节将介绍怎样怎样创建一个从数据表 country 中获取国家数据并显示出来的页面。

为了实现这个目标，你将会配置一个数据库连接。创建一个活动记录类，而且创建一个操作及一个视图。

贯穿整个章节，你将会学到：

• 配置一个数据库连接
• 定义一个活动记录类
• 使用活动记录从数据库中查询数据
• 以分页方式在视图中显示数据

请注意，为了掌握本章你应该具备最主要的数据库知识和使用经验。尤其是应该知道怎样创建数据库，怎样通过数据库终端运行 SQL 语句。

准备数据库

首先创建一个名为 yii2basic 的数据库，应用将从这个数据库中获取数据。

你能够创建 SQLite，mysql，PostregSQL，MSSQL 或 Oracle 数据库，Yii 内置多种数据库支持。简单起见后面的内容将以 MySQL 为例做演示。

然后在数据库中创建一个名为 country 的表并插入简单的数据。能够运行以下的语句：

CREATE TABLE `country` (
  `code` CHAR(2) NOT NULL PRIMARY KEY,
  `name` CHAR(52) NOT NULL,
  `population` INT(11) NOT NULL DEFAULT '0'
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

INSERT INTO `Country` VALUES ('AU','Australia',18886000);
INSERT INTO `Country` VALUES ('BR','Brazil',170115000);
INSERT INTO `Country` VALUES ('CA','Canada',1147000);
INSERT INTO `Country` VALUES ('CN','China',1277558000);
INSERT INTO `Country` VALUES ('DE','Germany',82164700);
INSERT INTO `Country` VALUES ('FR','France',59225700);
INSERT INTO `Country` VALUES ('GB','United Kingdom',59623400);
INSERT INTO `Country` VALUES ('IN','India',1013662000);
INSERT INTO `Country` VALUES ('RU','Russia',146934000);
INSERT INTO `Country` VALUES ('US','United States',278357000);

于是便有了一个名为 yii2basic 的数据库，在这个数据库中有一个包括三个字段的数据表 country。表中有十行数据。

配置数据库连接

開始之前，请确保你已经安装了 php PDO 扩展和你所使用的数据库的 PDO 驱动(比如 MySQL 的 pdo_mysql)。对于使用关系型数据库来讲，这是基本要求。

驱动和扩展安装可用后，打开 config/db.php 改动里面的配置參数相应你的数据库配置。

该文件默认包括这些内容：

<?php
return [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=localhost;dbname=yii2basic',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8',
];

config/db/php 是一个典型的基于文件的配置工具。这个文件配置了数据库连接 [[yii\db\Connection]] 的创建和初始化參数。应用的 SQL 查询正是基于这个数据库。

上面配置的数据库连接能够在应用中通过 Yii::$app->db 訪问。

补充：config/db.php 将被包括在应用配置文件 config/web.php 中，后者指定了整个应用怎样初始化。请參考配置章节了解很多其它信息。

创建活动记录

创建一个继承自活动记录类的类 Country。把它放在 models/Country.php。去表示和获取 country 表的数据。

<?php

namespace app\models;

use yii\db\ActiveRecord;

class Country extends ActiveRecord
{
}

这个 Country 类继承自 [[yii\db\ActiveRecord]]。你不用在里面写不论什么代码。

仅仅须要像如今这样。Yii 就能依据类名去推測相应的数据表名。

补充：假设类名和数据表名不能直接相应，能够重写 [[yii\db\ActiveRecord::tableName()|tableName()]] 方法去显式指定相关表名。

<?php
use app\models\Country;

// 获取 country 表的全部行并以 name 排序
$countries = Country::find()->orderBy('name')->all();

// 获取主键为 “US” 的行
$country = Country::findOne('US');

// 输出 “United States”
echo $country->name;

// 改动 name 为 “U.S.A.” 并在数据库中保存更改
$country->name = 'U.S.A.';
$country->save();

补充：活动记录是面向对象、功能强大的訪问和操作数据库数据的方式。你能够在活动记录章节了解很多其它信息。
除此之外你还能够使用还有一种更原生的称做数据訪问对象的方法操作数据库数据。

创建操作

为了向终于用户显示国家数据，你须要创建一个操作。相比之前小节掌握的在 site 控制器中创建操作，在这里为全部和国家有关的数据新建一个控制器更加合理。新控制器名为CountryController。并在当中创建一个 index 操作。例如以下：

<?php

namespace app\controllers;

use yii\web\Controller;
use yii\data\Pagination;
use app\models\Country;

class CountryController extends Controller
{
    public function actionIndex()
    {
        $query = Country::find();

        $pagination = new Pagination([
            'defaultPageSize' => 5,
            'totalCount' => $query->count(),
        ]);

        $countries = $query->orderBy('name')
            ->offset($pagination->offset)
            ->limit($pagination->limit)
            ->all();

        return $this->render('index', [
            'countries' => $countries,
            'pagination' => $pagination,
        ]);
    }
}

把上面的代码保存在 controllers/CountryController.php。

index 操作调用了活动记录 Country::find() 方法。去生成查询语句并从 country 表中取回全部数据。为了限定每一个请求所返回的国家数量，查询在 [[yii\data\Pagination]] 对象的帮助下进行分页。

 Pagination 对象的使命主要有两点：

• 为 SQL 查询语句设置 offset 和 limit 从句，确保每一个请求仅仅需返回一页数据(本例中每页是 5 行)。
• 在视图中显示一个由页码列表组成的分页器，这点将在后面的段落中解释。

在代码末尾，index 操作渲染一个名为 index 的视图，并传递国家数据和分页信息进去。

创建视图

在 views 文件夹下先创建一个名为 country 的子文件夹。这个文件夹存储全部由 country 控制器渲染的视图。在 views/country 文件夹下创建一个名为 index.php 的视图文件。内容例如以下：

<?php
use yii\helpers\html;
use yii\widgets\LinkPager;
?
>
<h1>Countries</h1>
<ul>
<?php foreach ($countries as $country): ?
>
    <li>
        <?
= Html::encode("{$country->name} ({$country->code})") ?
>:
        <?
= $country->population ?
>
    </li>
<?php endforeach; ?>
</ul>

<?= LinkPager::widget(['pagination' => $pagination]) ?
>

这个视图包括两部分用以显示国家数据。第一部分遍历国家数据并以无序 HTML 列表渲染出来。第二部分使用 [[yii\widgets\LinkPager]] 去渲染从操作中传来的分页信息。

小部件LinkPager 显示一个分页button的列表。

点击不论什么一个button都会跳转到相应的分页。

尝试下

浏览器訪问以下的 URL 看看是否能工作：

http://hostname/index.php?r=country/index

国家列表

首先你会看到显示着五个国家的列表页面。

在国家以下。你还会看到一个包括四个button的分页器。

假设你点击button “2”，将会跳转到显示另外五个国家的页面，也就是第二页记录。假设观察细致点你还会看到浏览器的 URL 变成了：

http://hostname/index.php?r=country/index&page=2

在这个场景里，[[yii\data\Pagination|Pagination]] 提供了为数据结果集分页的全部功能：

• 首先 [[yii\data\Pagination|Pagination]] 把 SELECT 的子查询 LIMIT 5 OFFSET 0 数据表示成第一页。因此开头的五条数据会被取出并显示。
• 然后小部件 [[yii\widgets\LinkPager|LinkPager]] 使用 [[yii\data\Pagination::createUrl()|Pagination::createUrl()]] 方法生成的 URL 去渲染翻页button。

  URL 中包括必要的參数 page 才干查询不同的页面编号。

• 假设你点击button “2”，将会发起一个路由为 country/index 的新请求。[[yii\data\Pagination|Pagination]] 接收到 URL 中的 page 參数把当前的页码设为 2。

  新的数据库请求将会以 LIMIT 5 OFFSET 5 查询并显示。

总结

本章节中你学到了怎样使用数据库。

你还学到了怎样取出并使用 [[yii\data\Pagination]] 和 [[yii\widgets\LinkPager]] 显示数据。

下一章中你会学到怎样使用 Yii 中强大的代码生成器 Gii，去帮助你实现一些经常使用的功能需求，比如增查改删(CRUD)数据表中的数据。

其实你之前所写的代码所有都能够由 Gii 自己主动生成。