接口数据使用ThinkPHP5的自定义分页

tp程序自带了分页的功能,用起来很是方便,特别是默认情况下直接连样式都写好了。非常的省心。但这只是对于数据库操作而言。如果我们想要对请求的接口数据进行分页,那么该如何使用paginate方法呢?

知其然

我们首先来查看tp数据的分页流程是怎么样的。先写一个数据库分页的代码

 $page = Db::name("null")
            ->paginate();
        $page->render();

使用ctrl+鼠标左键,进入paginate方法中。

...
        /** @var Paginator $class */
        $class = false !== strpos($config['type'], '\\') ? $config['type'] : '\\think\\paginator\\driver\\' . ucwords($config['type']);
        $page  = isset($config['page']) ? (int) $config['page'] : call_user_func([
            $class,
            'getCurrentPage',
        ], $config['var_page']);

        $page = $page < 1 ? 1 : $page;

        $config['path'] = isset($config['path']) ? $config['path'] : call_user_func([$class, 'getCurrentPath']);

        if (!isset($total) && !$simple) {
            $options = $this->getOptions();

            unset($this->options['order'], $this->options['limit'], $this->options['page'], $this->options['field']);

            $bind    = $this->bind;
            $total   = $this->count();
            $results = $this->options($options)->bind($bind)->page($page, $listRows)->select();
        } elseif ($simple) {
            $results = $this->limit(($page - 1) * $listRows, $listRows + 1)->select();
            $total   = null;
        } else {
            $results = $this->page($page, $listRows)->select();
        }
        return $class::make($results, $listRows, $page, $total, $simple, $config);

这里只粘贴了重要代码。我们看最后一句,$class 的实例化在上面代码块的第一行,这个类就是分页驱动类。调用了make方法。我们再跟踪进make方法进行查看

    public static function make($items, $listRows, $currentPage = null, $total = null, $simple = false, $options = [])
    {
        return new static($items, $listRows, $currentPage, $total, $simple, $options);
    }

我们可以看一下参数名,currentPage,当前页,totoal总共。这里应该就是我们要找的分页方法了。

   /** @var bool 是否为简洁模式 */
    protected $simple = false;

    /** @var Collection 数据集 */
    protected $items;

    /** @var integer 当前页 */
    protected $currentPage;

    /** @var  integer 最后一页 */
    protected $lastPage;

    /** @var integer|null 数据总数 */
    protected $total;

    /** @var  integer 每页的数量 */
    protected $listRows;

    /** @var bool 是否有下一页 */
    protected $hasMore;

    /** @var array 一些配置 */
    protected $options = [
        'var_page' => 'page',
        'path'     => '/',
        'query'    => [],
        'fragment' => '',
    ];

撸起袖子干

我们接下来可以试着写个demo调用一下看看。
make 方法需要传入的参数都已经在paginate类里声明过了。都是汉语注释。

$result = $this->api();
        $total = count($result);
        $page = Paginator::make(null, 10, 0, $total, false, []);
        $this->assign("data", $result);
        $this->assign("page", $page);

我们这里值先尝试进行传递,出错之后再进行修改。访问这个方法。发现系统报错了

Cannot instantiate abstract class think\Paginator

paginator 是一个抽象类,无法实例化,那这个时候我们需要找到他的实现类是哪一个。得益于intellij方便的index功能,我们只需要ctrl+鼠标左键点击Pageinator这个类的名字,我们会发现长长的列表中有一个惊喜

 class Bootstrap extends Paginator

我们实例化Bootstrap试一下。代码如下

  public function page()
    {
        //模拟接口请求
        $result = $this->api();
        $total = count($result);
        $page = Bootstrap::make(null, 10, 0, $total, false, []);
        $this->assign("data", $result);
        $this->assign("page", $page);
        return $this->fetch();
    }


    private function api()
    {
        return ["最后的生还者", "神秘海域", "塞尔达传说", "猎天使魔女", "光环", "极品飞车", "使命召唤", "最后的守护者", "战神", "鬼泣", "仁王",
            "超级马里奥", "地平线-零之曙光", "怪物猎人", "DOOM", "无冬", "风之旅人"];
    }
分页显示

这时候我们发现,我们的分页已经显示出来了,只不过效果很难看。tp分页渲染使用的是bootstrap,从上面类的名字我们也能够看的出来。我们引入bootstrap试试


引入css样式

引入css样式之后,我们发现分页效果已经炫酷了很多了。

满足变态需求

如果是在搜索中用到分页,那么分页之后的url带有搜索关键字就更好了,不然点机第二页,不知到搜索的是什么了就很尴尬。我们看一下make的最后一个参数 option,选项

    /** @var array 一些配置 */
    protected $options = [
        'var_page' => 'page',
        'path'     => '/',
        'query'    => [],
        'fragment' => '',
    ];

这里是一个数组,里面有一个query字段,也是一个数组,那么我们尝试着使用一下这个字段看看效果如何。修改make方法的参数

 $page = Bootstrap::make(null,
            10,
            0,
            $total, 
            false,
            ["query"=>["key"=>"game"]]);

我们传入了query这个字段,看看效果吧


链接中带有关键字

这个时候url里不仅包含了页码,还包含了关键字,PHP端就能方便的知道下一个页面该展示什么了。

make第一个参数,数据集也是很有用的东西,可以实现数据和分页通过一个paginator传递到前端页面,类似于数据库请求那样。我们讲上面的代码简单改动,就可以实现

 public function page()
    {
        //模拟接口请求
        $result = $this->api();
        $total = count($result);
        $page = Bootstrap::make($result,
            10,
            0,
            $total,
            false,
            ["query"=>["key"=>"game"]]);
        //$this->assign("data", $result);
        $this->assign("page", $page);
        return $this->fetch();
    }

这样的话我们还可以少进行一次assign操作。

附上前端页面代码

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8"><!-- 最新版本的 Bootstrap 核心 CSS 文件 -->
    <link rel="stylesheet" href="https://cdn.bootcss.com/bootstrap/3.3.7/css/bootstrap.min.css"
          integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">

    <!-- 可选的 Bootstrap 主题文件(一般不用引入) -->
    <link rel="stylesheet" href="https://cdn.bootcss.com/bootstrap/3.3.7/css/bootstrap-theme.min.css"
          integrity="sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp" crossorigin="anonymous">

    <!-- 最新的 Bootstrap 核心 JavaScript 文件 -->
    <script src="https://cdn.bootcss.com/bootstrap/3.3.7/js/bootstrap.min.js"
            integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa"
            crossorigin="anonymous"></script>
    <title>分页测试</title>
</head>
<body style="border: 25px">
<table class="table-striped table">
    {volist name="page" id="item"}
    <tr>
        <td>{$item}</td>
    </tr>
    {/volist}
</table>
{$page->render()}
</body>
</html>

推荐阅读更多精彩内容