Symfony 6项目集成knpPaginator实现分页报错问题求助

• Bundle版本：x.y.z
• Symfony版本：6.0.4
• PHP版本：8.1.6

项目index页面实现分页功能时KnpPaginator运行报错，多轮调整方案未解决。

1. 确认依赖版本兼容性 #

Symfony 6.0+ 要求knplabs/knp-paginator-bundle版本≥5.8，低版本存在类型声明不兼容问题，会直接触发报错。
执行以下命令检查当前安装版本：
composer show knplabs/knp-paginator-bundle
如果版本不符合要求，执行升级命令：
composer require knplabs/knp-paginator-bundle:^5.8

2. 核对Bundle配置 #

检查config/packages/knp_paginator.yaml配置，删除自定义的多余覆盖项，使用标准配置即可：

knp_paginator:
    page_range: 5
    default_options:
        page_name: page
        sort_field_name: sort
        sort_direction_name: direction
        distinct: true
    template:
        pagination: '@KnpPaginator/Pagination/twitter_bootstrap_v4_pagination.html.twig'
        sortable: '@KnpPaginator/Pagination/sortable_link.html.twig'

3. 修正控制器代码 #

Symfony 6 严格类型模式下，paginate()方法第一个参数必须传入Doctrine\ORM\Query对象，不能直接传入QueryBuilder实例，参考正确写法：

<?php

namespace App\Controller;

use App\Repository\YourEntityRepository;
use Knp\Component\Pager\PaginatorInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

class IndexController extends AbstractController
{
    public function index(
        YourEntityRepository $repo,
        PaginatorInterface $paginator,
        Request $request
    ): Response {
        $query = $repo->createQueryBuilder('e')
            ->orderBy('e.id', 'DESC')
            ->getQuery(); // 必须调用getQuery()拿到Query实例再传入分页方法

        $pagination = $paginator->paginate(
            $query,
            $request->query->getInt('page', 1),
            10 // 每页展示条数
        );

        return $this->render('index/index.html.twig', [
            'pagination' => $pagination
        ]);
    }
}

4. 检查服务配置 #

打开config/services.yaml，删除所有针对Knp\Component\Pager\PaginatorInterface的自定义服务绑定配置，用Bundle默认的自动注入规则即可，错误的服务绑定会导致分页实例化异常。

5. 核对模板渲染代码 #

模板中遍历和分页渲染写法参考：

{# 列表遍历 #}
{% for item in pagination %}
<div>
    {{ item.id }} - {{ item.title }}
</div>
{% endfor %}

{# 分页导航输出 #}
{{ knp_pagination_render(pagination) }}

6. 实体映射校验 #

如果以上步骤调整后仍有数据库相关报错，执行命令校验Doctrine实体映射是否正常：
php bin/console doctrine:schema:validate
根据报错提示修正实体字段映射错误即可。

内容的提问来源于stack exchange，提问作者Spirito