Laravel 中通过自定义分页器分页方法实现伪静态分页链接以利于 SEO

Posted 2021-02-04 心之所依

我们知道，Laravel 自带的分页器方法包含 simplePaginate 和 paginate 方法，一个返回不带页码的分页链接，另一个返回带页码的分页链接，但是这两种分页链接页码都是以带问号的动态参数形式附加在查询字符串中，形如 https://laravelacademy.org?page=100，但是这种包含动态参数的 URL 格式对 SEO 不友好，我们最好将其转化为 https://laravelacademy.org/page/100 这种不带问号的伪静态分页链接格式，遗憾的是 Laravel 并没有提供对这种伪静态分页链接格式的自定义支持，只好自己动手了。

我们将基于 paginate 方法实现的分页进行扩展，只是修改其分页链接格式，该方法底层调用了 IlluminatePaginationLengthAwarePaginator 类实现分页，所以我们需要自定义一个继承自该分页器类的 app/Utils/AcademyPaginator.php，初始化代码如下：

<?php

namespace AppUtils;

use IlluminateContainerContainer;
use IlluminateDatabaseEloquentBuilder;
use IlluminateSupportStr;
use IlluminatePaginationPaginator;
use IlluminatePaginationLengthAwarePaginator as BasePaginator;

class AcademyPaginator extends BasePaginator
{
}

在 Laravel 自带的分页器中，默认分页链接是通过 url 方法生成并返回的，该方法定义在抽象类 vendor/laravel/framework/src/Illuminate/Pagination/AbstractPaginator.php 中：

/**
 * Get the URL for a given page number.
 *
 * @param  int  $page
 * @return string
 */
public function url($page)
{
    if ($page <= 0) {
        $page = 1;
    }

    // If we have any extra query string key / value pairs that need to be added
    // onto the URL, we will put them in query string form and then attach it
    // to the URL. This allows for extra information like sortings storage.
    $parameters = [$this->pageName => $page];

    if (count($this->query) > 0) {
        $parameters = array_merge($this->query, $parameters);
    }

    return $this->path
                    .(Str::contains($this->path, ‘?‘) ? ‘&‘ : ‘?‘)
                    .http_build_query($parameters, ‘‘, ‘&‘)
                    .$this->buildFragment();
}

它是在这里将分页信息作为查询参数的一部分放到分页链接中，所以我们需要在自定义的 AcademyPaginator 类中重写这个方法覆盖父类实现：

/**
 * 重写页面 URL 实现代码，去掉分页中的问号，实现伪静态链接
 * @param int $page
 * @return string
 */
public function url($page)
{
    if ($page <= 0) {
        $page = 1;
    }

    // 移除路径尾部的/
    $path = rtrim($this->path, ‘/‘);

    // 如果路径中包含分页信息则正则替换页码，否则将页码信息追加到路径末尾
    if (preg_match(‘//page/d+/‘, $path)) {
        $path = preg_replace(‘//page/d+/‘, ‘/page/‘ . $page, $path);
    } else {
        $path .= ‘/page/‘ . $page;
    }
    $this->path = $path;

    if ($this->query) {
        $url = $this->path . (Str::contains($this->path, ‘?‘) ? ‘&‘ : ‘?‘)
            . http_build_query($this->query, ‘‘, ‘&‘)
            . $this->buildFragment();
    } elseif ($this->fragment) {
        $url = $this->path . $this->buildFragment();
    } else {
        $url = $this->path;
    }

    return $url;
}

实现原理很简单，就是判断页面路径中是否已经包含类似 /page/100 这种页码信息，如果不包含，则将其添加到路径中，否则对页码值进行正则替换，最后把新的路径结合之前的查询参数和锚点信息拼接为新的完整分页链接返回给调用方。

除此之外，因为分页链接格式变了，我们还要在 AcademyPaginator 对父类设置当前页码的方法进行重写，还是一个对当前分页链接的正则匹配：

/**
 * 重写当前页设置方法
 *
 * @param  int  $currentPage
 * @param  string  $pageName
 * @return int
 */
protected function setCurrentPage($currentPage, $pageName)
{
    if (!$currentPage && preg_match(‘//page/(d+)/‘, $this->path, $matches)) {
        $currentPage = $matches[1];
    }

    return $this->isValidPageNumber($currentPage) ? (int) $currentPage : 1;
}

至此，我们自定义的分页器类已经编写好了，接下来还要将这个分页器注册到模型类的查询构建器中以便可以像simplePaginate 和 paginate 方法那样在模型实例上调用，这里我们需要借助查询构建器 IlluminateDatabaseEloquentBuilder 提供的静态 macro 方法在运行时动态扩展其提供的方法，我们还是在 AcademyPaginator 中定义这个方法扩展实现：

/**
 * 将新增的分页方法注册到查询构建器中，以便在模型实例上使用
 * 注册方式：
 * 在 AppServiceProvider 的 boot 方法中注册：AcademyPaginator::rejectIntoBuilder();
 * 使用方式：
 * 将之前代码中在模型实例上调用 paginate 方法改为调用 seoPaginate 方法即可：
 * Article::where(‘status‘, 1)->seoPaginate(15, [‘*‘], ‘page‘, page);
 */
public static function injectIntoBuilder()
{
    Builder::macro(‘seoPaginate‘, function ($perPage, $columns, $pageName, $page) {
        $perPage = $perPage ?: $this->model->getPerPage();

        $items = ($total = $this->toBase()->getCountForPagination())
            ? $this->forPage($page, $perPage)->get($columns)
            : $this->model->newCollection();

        $options = [
            ‘path‘ => Paginator::resolveCurrentPath(),
            ‘pageName‘ => $pageName,
        ];

        return Container::getInstance()->makeWith(AcademyPaginator::class, compact(
            ‘items‘, ‘total‘, ‘perPage‘, ‘page‘, ‘options‘
        ));
    });
}

这样，在模型实例上调用 seoPaginate 方法，将通过 AcademyPaginator 进行分页，最后我们在 AppServiceProvider 的 boot 方法中全局调用这个注入：

// 为查询构建器注入自己实现的分页器方法
AcademyPaginator::injectIntoBuilder();

接下来，就可以在自己的代码中编写以下这种代码实现伪静态分页链接了：

$articles = Article::with(‘author‘, ‘category‘)->public()->orderBy(‘id‘, ‘desc‘)->seoPaginate($pageSize, $this->listColumns, ‘page‘, $page);