URL 生成

简介

Laravel 提供了多个辅助函数来帮助你为应用程序生成 URL。这些辅助函数在模板和 API 响应中构建链接，或在生成重定向响应到应用程序的其他部分时特别有用。

基础用法

生成 URL

url 辅助函数可用于为应用程序生成任意 URL。生成的 URL 将自动使用应用程序当前处理的请求的协议（HTTP 或 HTTPS）和主机：

$post = App\Models\Post::find(1);

echo url("/posts/{$post->id}");

// http://example.com/posts/1

要生成带有查询字符串参数的 URL，可以使用 query 方法：

echo url()->query('/posts', ['search' => 'Laravel']);

// https://example.com/posts?search=Laravel

echo url()->query('/posts?sort=latest', ['search' => 'Laravel']);

// http://example.com/posts?sort=latest&search=Laravel

如果提供的查询字符串参数已存在于路径中，则会覆盖其现有值：

echo url()->query('/posts?sort=latest', ['sort' => 'oldest']);

// http://example.com/posts?sort=oldest

数组值也可以作为查询参数传递。这些值将在生成的 URL 中被正确地键化和编码：

echo $url = url()->query('/posts', ['columns' => ['title', 'body']]);

// http://example.com/posts?columns%5B0%5D=title&columns%5B1%5D=body

echo urldecode($url);

// http://example.com/posts?columns[0]=title&columns[1]=body

访问当前 URL

如果没有向 url 辅助函数提供路径，将返回一个 Illuminate\Routing\UrlGenerator 实例，允许你访问当前 URL 的信息：

// 获取不含查询字符串的当前 URL...
echo url()->current();

// 获取包含查询字符串的当前 URL...
echo url()->full();

这些方法中的每一个也可以通过 URL facade 访问：

use Illuminate\Support\Facades\URL;

echo URL::current();

访问上一个 URL

有时知道用户来自的上一个 URL 是很有帮助的。你可以通过 url 辅助函数的 previous 和 previousPath 方法访问上一个 URL：

// 获取上一个请求的完整 URL...
echo url()->previous();

// 获取上一个请求的路径...
echo url()->previousPath();

或者，通过 session，你可以将上一个 URL 作为 fluent URI 实例访问：

use Illuminate\Http\Request;

Route::post('/users', function (Request $request) {
    $previousUri = $request->session()->previousUri();

    // ...
});

也可以通过 session 检索上一个访问 URL 的路由名称：

$previousRoute = $request->session()->previousRoute();

命名路由的 URL

route 辅助函数可用于生成指向命名路由的 URL。命名路由允许你生成 URL 而无需与路由上定义的实际 URL 耦合。因此，如果路由的 URL 发生变化，无需修改对 route 函数的调用。例如，假设你的应用程序包含如下定义的路由：

Route::get('/post/{post}', function (Post $post) {
    // ...
})->name('post.show');

要生成指向此路由的 URL，可以像这样使用 route 辅助函数：

echo route('post.show', ['post' => 1]);

// http://example.com/post/1

当然，route 辅助函数也可用于为具有多个参数的路由生成 URL：

Route::get('/post/{post}/comment/{comment}', function (Post $post, Comment $comment) {
    // ...
})->name('comment.show');

echo route('comment.show', ['post' => 1, 'comment' => 3]);

// http://example.com/post/1/comment/3

任何与路由定义参数不对应的额外数组元素将被添加到 URL 的查询字符串中：

echo route('post.show', ['post' => 1, 'search' => 'rocket']);

// http://example.com/post/1?search=rocket

Eloquent 模型

你经常会使用 Eloquent 模型的路由键（通常是主键）来生成 URL。因此，你可以将 Eloquent 模型作为参数值传递。route 辅助函数将自动提取模型的路由键：

echo route('post.show', ['post' => $post]);

签名 URL

Laravel 允许你轻松地为命名路由创建"签名" URL。这些 URL 在查询字符串中附加了一个"签名"哈希，允许 Laravel 验证 URL 自创建以来未被修改。签名 URL 对于可公开访问但需要一层防止 URL 篡改保护的路由特别有用。

例如，你可以使用签名 URL 来实现发送给客户的公共"取消订阅"链接。要为命名路由创建签名 URL，请使用 URL facade 的 signedRoute 方法：

use Illuminate\Support\Facades\URL;

return URL::signedRoute('unsubscribe', ['user' => 1]);

你可以通过向 signedRoute 方法提供 absolute 参数来将域名从签名 URL 哈希中排除：

return URL::signedRoute('unsubscribe', ['user' => 1], absolute: false);

如果你想生成一个在指定时间后过期的临时签名路由 URL，可以使用 temporarySignedRoute 方法。当 Laravel 验证临时签名路由 URL 时，它会确保编码在签名 URL 中的过期时间戳尚未超过：

use Illuminate\Support\Facades\URL;

return URL::temporarySignedRoute(
    'unsubscribe', now()->plus(minutes: 30), ['user' => 1]
);

验证签名路由请求

要验证传入请求是否具有有效签名，你应该在传入的 Illuminate\Http\Request 实例上调用 hasValidSignature 方法：

use Illuminate\Http\Request;

Route::get('/unsubscribe/{user}', function (Request $request) {
    if (! $request->hasValidSignature()) {
        abort(401);
    }

    // ...
})->name('unsubscribe');

有时，你可能需要允许应用程序的前端向签名 URL 追加数据，例如在执行客户端分页时。因此，你可以使用 hasValidSignatureWhileIgnoring 方法指定在验证签名 URL 时应忽略的请求查询参数。请记住，忽略参数允许任何人修改请求上的这些参数：

if (! $request->hasValidSignatureWhileIgnoring(['page', 'order'])) {
    abort(401);
}

你也可以将 signed（Illuminate\Routing\Middleware\ValidateSignature）middleware 分配给路由，而不是使用传入的请求实例来验证签名 URL。如果传入请求没有有效签名，middleware 将自动返回 403 HTTP 响应：

Route::post('/unsubscribe/{user}', function (Request $request) {
    // ...
})->name('unsubscribe')->middleware('signed');

如果你的签名 URL 在 URL 哈希中不包含域名，你应该向 middleware 提供 relative 参数：

Route::post('/unsubscribe/{user}', function (Request $request) {
    // ...
})->name('unsubscribe')->middleware('signed:relative');

响应无效的签名路由

当有人访问已过期的签名 URL 时，他们将收到一个 403 HTTP 状态码的通用错误页面。但是，你可以通过在应用程序的 bootstrap/app.php 文件中为 InvalidSignatureException 异常定义自定义"渲染"闭包来自定义此行为：

use Illuminate\Routing\Exceptions\InvalidSignatureException;

->withExceptions(function (Exceptions $exceptions): void {
    $exceptions->render(function (InvalidSignatureException $e) {
        return response()->view('errors.link-expired', status: 403);
    });
})

控制器操作的 URL

action 函数为给定的控制器操作生成 URL：

use App\Http\Controllers\HomeController;

$url = action([HomeController::class, 'index']);

如果控制器方法接受路由参数，你可以将路由参数的关联数组作为函数的第二个参数传递：

$url = action([UserController::class, 'profile'], ['id' => 1]);

Fluent URI 对象

Laravel 的 Uri 类提供了一个方便且流畅的接口，用于通过对象创建和操作 URI。该类封装了底层 League URI 包提供的功能，并与 Laravel 的路由系统无缝集成。

你可以使用静态方法轻松创建 Uri 实例：

use App\Http\Controllers\UserController;
use App\Http\Controllers\InvokableController;
use Illuminate\Support\Uri;

// 从给定字符串生成 URI 实例...
$uri = Uri::of('https://example.com/path');

// 生成指向路径、命名路由或控制器操作的 URI 实例...
$uri = Uri::to('/dashboard');
$uri = Uri::route('users.show', ['user' => 1]);
$uri = Uri::signedRoute('users.show', ['user' => 1]);
$uri = Uri::temporarySignedRoute('user.index', now()->plus(minutes: 5));
$uri = Uri::action([UserController::class, 'index']);
$uri = Uri::action(InvokableController::class);

// 从当前请求 URL 生成 URI 实例...
$uri = $request->uri();

// 从上一个请求 URL 生成 URI 实例...
$uri = $request->session()->previousUri();

一旦你有了 URI 实例，就可以流畅地修改它：

$uri = Uri::of('https://example.com')
    ->withScheme('http')
    ->withHost('test.com')
    ->withPort(8000)
    ->withPath('/users')
    ->withQuery(['page' => 2])
    ->withFragment('section-1');

有关使用 fluent URI 对象的更多信息，请查阅 URI 文档。

默认值

对于某些应用程序，你可能希望为某些 URL 参数指定请求范围的默认值。例如，假设你的许多路由定义了 {locale} 参数：

Route::get('/{locale}/posts', function () {
    // ...
})->name('post.index');

每次调用 route 辅助函数时都传递 locale 是很麻烦的。因此，你可以使用 URL::defaults 方法为此参数定义一个在当前请求期间始终应用的默认值。你可能希望从路由 middleware 中调用此方法，以便可以访问当前请求：

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\URL;
use Symfony\Component\HttpFoundation\Response;

class SetDefaultLocaleForUrls
{
    /**
     * Handle an incoming request.
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        URL::defaults(['locale' => $request->user()->locale]);

        return $next($request);
    }
}

一旦设置了 locale 参数的默认值，你在通过 route 辅助函数生成 URL 时就不再需要传递该值。

URL 默认值与 Middleware 优先级

设置 URL 默认值可能会干扰 Laravel 对隐式模型绑定的处理。因此，你应该优先安排你的 middleware 使设置 URL 默认值的 middleware 在 Laravel 自身的 SubstituteBindings middleware 之前执行。你可以在应用程序的 bootstrap/app.php 文件中使用 priority middleware 方法来实现：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->prependToPriorityList(
        before: \Illuminate\Routing\Middleware\SubstituteBindings::class,
        prepend: \App\Http\Middleware\SetDefaultLocaleForUrls::class,
    );
})