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

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

修改说明

增加了注释,参考附录代码。
此代码的使用场景:在php中curl请求带分页的接口中使用
解决html显示异常,模板中使用raw方法

知其然

我们首先来查看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路径

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

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

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

options 参数中有一个字段时path,上面可以看到默认值为 / 也就是根目录,如果我们传入了这个值,就可以设置分页后的url了

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

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


链接中带有关键字和路径

这个时候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操作。

下面是上面演示用到的代码

附上后端代码

<?php

namespace app\index\controller;

use think\Controller;
use think\paginator\driver\Bootstrap;

class Index extends Controller
{

    /**
     * 这套代码不对数据进行分页处理,只是一个将已经分页后的数据,套用tp的分页方法,可以少一个自己写分页
     * 使用是有场景限制的,建议是在php请求带分页的接口,然后返回数据给html时候使用
     * 直接请求数据库时tp自带分页
     * 前端直接请求接口时前端可以自行分页
     * @return mixed
     */
    public function page()
    {
        $page = input('page');
        //模拟接口请求
        //从接口种获取$page页的数据
        $result = $this->api($page);
        //从接口中获取总数据,这里应该是个固定值,因为查询条件不变的话,总数据一搬不会变。
        //方便演示直接写死了,正常应该是从接口中获取
        $total = 18;
        //进行分页,这里第二个参数是每页数据,应该和接口中的每页数据相同
        //最后一个参数中的path,如果不指定就会从根目录开始
        $page = Bootstrap::make($result,
            10,
            $page,
            $total,
            false,
            ["query" => ["key" => "game"], 'path' => '/index/index/page']);
        //上面第一个参数已经带了数据,所以这个assign可以取消
        //$this->assign("data", $result);
        $this->assign("page", $page);
        return $this->fetch();
    }

    /**
     * @param $page int 页码
     * @return mixed
     * 这里是数据模拟,正常情况下这里可能是curl访问数据接口。
     * 数据分页获取在数据接口请求数据库时候操作
     */
    private function api($page)
    {
        $data = [
            "1" => ["最后的生还者", "神秘海域", "塞尔达传说", "猎天使魔女", "光环", "极品飞车", "使命召唤", "最后的守护者", "战神", "鬼泣", "仁王"],
            "2" => ["超级马里奥", "地平线-零之曙光", "怪物猎人", "DOOM", "无冬", "风之旅人"]
        ];
        return $data[$page];
    }
}

附上前端页面代码

<!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>
<!---如果显示的是html代码,加上raw方法后会正常显示-->
{$page->render()|raw}
</body>
</html>

附上我自己项目中用到的一个分页服务代码

<?php

namespace app\common\service;

use think\paginator\driver\Bootstrap;

class PageService
{
    /**
     * 只负责生成分页信息,不携带数据
     * @param $total 总数据量
     * @param $pageSize 每页大小
     * @param $page 当前页
     * @param $path 路径
     * @param array $query ["query"=>["key"=>"game"]]
     * @return mixed
     */
    public function onlyPage($total, $pageSize, $page, $path, $query = [])
    {
        $page = Bootstrap::make([],
            $pageSize,
            $page,
            $total,
            false,
            ["query" => $query,"path"=>$path]);
        return $page;
    }
}

使用分页工具

//$galley 是接口请求得到的数据,20是接口中数据库分页大小,$page是当前页码
//剩下两个参数分别为路径和查询参数
$pages = (new PageService())->onlyPage($galley['count'],20, $page,
            '/intro/galley/zwgx.html',['galley_cate_id'=>$galley_cate_id]);
        $this->assign("pages", $pages);
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,117评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,963评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,897评论 0 240
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,805评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,208评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,535评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,797评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,493评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,215评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,325评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,971评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2 266

推荐阅读更多精彩内容

  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,293评论 18 399
  • 转 # https://www.cnblogs.com/easypass/archive/2010/12/ 08/...
    吕品㗊阅读 9,612评论 0 44
  • 我们小组走访的第二个孩子,是个准高三学生,一个文文静静的男孩子,除了微笑,除了只有他必须作答的问题,不多说一句...
    老虎妈阅读 325评论 0 0
  • 云的心事,风知道; 亲爱的,你的呢? 天空, 湛蓝, 从清晨到中午至午后; 万里无云,一丝云彩都没来过; 几朵洁白...
    若无闲事阅读 411评论 0 1
  • 美国建国之初宣扬自由平等,追求市场自由,机会平等,市场自由与机会平等相辅相成,效率与平等互相促进。 ...
    meal墨迹阅读 255评论 0 0