如何修改Laravel分页首页URL并转换后端API路径至前端路径

针对需要将Laravel分页返回的首页URL去掉?page=1参数，同时把后端API路径替换为前端路径的需求，这里提供两种可行的实现方式：

方式一：自定义分页转换类 #

创建专门的转换类处理分页数据的URL替换逻辑，代码结构清晰，便于后续维护：

1. 创建转换类文件 app/Transformers/CustomPaginationTransformer.php

<?php

namespace App\Transformers;

use Illuminate\Pagination\LengthAwarePaginator;

class CustomPaginationTransformer
{
    public static function transform(LengthAwarePaginator $paginator, string $frontendBaseUrl)
    {
        $paginationData = $paginator->toArray();
        
        // 替换后端API路径为前端路径，同时移除首页的page=1参数
        $firstPageUrl = str_replace(
            [config('app.url') . '/api', '?page=1'],
            [$frontendBaseUrl, ''],
            $paginationData['first_page_url']
        );
        
        // 处理下一页URL，仅替换域名路径
        $nextPageUrl = $paginationData['next_page_url'] 
            ? str_replace(config('app.url') . '/api', $frontendBaseUrl, $paginationData['next_page_url']) 
            : null;
        
        // 替换基础路径
        $path = str_replace(config('app.url') . '/api', $frontendBaseUrl, $paginationData['path']);
        
        return [
            'first_page_url' => $firstPageUrl,
            'from' => $paginationData['from'],
            'next_page_url' => $nextPageUrl,
            'path' => $path,
            'per_page' => $paginationData['per_page'],
            'prev_page_url' => $paginationData['prev_page_url'],
            'to' => $paginationData['to'],
        ];
    }
}

2. 在控制器中调用转换类

<?php

namespace App\Http\Controllers;

use App\Transformers\CustomPaginationTransformer;
use App\Models\Category;

class CategoryController extends Controller
{
    public function show($slug)
    {
        $category = Category::where('slug', $slug)->firstOrFail();
        $items = $category->items()->paginate(25);
        
        // 传入前端基础URL，生成转换后的分页数据
        $transformedData = CustomPaginationTransformer::transform($items, 'http://frontend.example.com');
        
        return response()->json($transformedData);
    }
}

方式二：使用分页宏快速处理 #

如果不想新增类文件，可以通过Laravel的分页宏扩展分页器功能：

1. 在AppServiceProvider的boot方法中注册宏

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use Illuminate\Pagination\LengthAwarePaginator;

class AppServiceProvider extends ServiceProvider
{
    public function boot()
    {
        LengthAwarePaginator::macro('toFrontendJson', function ($frontendBaseUrl) {
            $data = $this->toArray();
            
            // 处理首页URL
            $data['first_page_url'] = str_replace(
                [config('app.url') . '/api', '?page=1'],
                [$frontendBaseUrl, ''],
                $data['first_page_url']
            );
            
            // 处理下一页URL
            $data['next_page_url'] = $data['next_page_url'] 
                ? str_replace(config('app.url') . '/api', $frontendBaseUrl, $data['next_page_url']) 
                : null;
            
            // 替换基础路径
            $data['path'] = str_replace(config('app.url') . '/api', $frontendBaseUrl, $data['path']);
            
            return $data;
        });
    }
}

2. 控制器中直接调用宏

public function show($slug)
{
    $category = Category::where('slug', $slug)->firstOrFail();
    $items = $category->items()->paginate(25);
    
    return response()->json($items->toFrontendJson('http://frontend.example.com'));
}

核心逻辑说明 #

• 移除page=1参数：通过str_replace将首页URL中的?page=1替换为空，实现URL简化
• 路径替换：统一把后端API的基础路径（如http://backend.example.com/api）替换为前端的基础URL
• 空值兼容：对next_page_url做空值判断，避免空字符串替换导致的异常

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