网址生成

Introduction

Laravel 提供了几个助手来帮助你为你的应用程序生成 URL。这些助手主要用于在模板和 API 响应中构建链接,或者生成对应用程序另一部分的重定向响应。

基础

生成网址

url helper 可用于为您的应用程序生成任意 URL。生成的 URL 将自动使用应用程序正在处理的当前请求的方案(HTTP 或 HTTPS)和主机:

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

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

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

访问当前 URL

如果没有提供路径url 帮手,一个Illuminate\Routing\UrlGenerator 返回实例,允许您访问有关当前 URL 的信息:

// Get the current URL without the query string...
echo url()->current();

// Get the current URL including the query string...
echo url()->full();

// Get the full URL for the previous request...
echo url()->previous();

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

use Illuminate\Support\Facades\URL;

echo URL::current();

命名路由的 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 helper 也可用于为具有多个参数的路由生成 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

雄辩的模型

您通常会使用以下的路由键(通常是主键)生成 URL雄辩的模型.出于这个原因,您可以将 Eloquent 模型作为参数值传递。这route helper 会自动提取模型的路由键:

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

签名网址

Laravel 允许您轻松地为命名路由创建“签名”URL。这些 URL 有一个“签名”散列附加到查询字符串,它允许 Laravel 验证 URL 自创建以来没有被修改。签名 URL 对于可公开访问但需要一层保护以防止 URL 操纵的路由特别有用。

例如,您可以使用签名 URL 来实现通过电子邮件发送给客户的公共“取消订阅”链接。要创建指向命名路由的签名 URL,请使用signedRoute 的方法URL 正面:

use Illuminate\Support\Facades\URL;

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

如果您想生成一个在指定时间后过期的临时签名路由 URL,您可以使用temporarySignedRoute 方法。当 Laravel 验证临时签名的路由 URL 时,它将确保编码到签名 URL 中的过期时间戳没有过去:

use Illuminate\Support\Facades\URL;

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

验证签名的路由请求

要验证传入请求是否具有有效签名,您应该调用hasValidSignature 传入方法Illuminate\Http\Request 实例:

use Illuminate\Http\Request;

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

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

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

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

您可以分配Illuminate\Routing\Middleware\ValidateSignature middleware 到路线。如果它不存在,你可以在你的 HTTP 内核中为这个中间件分配一个别名$middlewareAliases 大批:

/**
 * The application's middleware aliases.
 *
 * Aliases may be used to conveniently assign middleware to routes and groups.
 *
 * @var array<string, class-string|string>
 */
protected $middlewareAliases = [
    'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
];

一旦在内核中注册了中间件,就可以将其附加到路由。如果传入的请求没有有效签名,中间件将自动返回一个403 HTTP 响应:

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

响应无效的签名路由

当有人访问已过期的签名 URL 时,他们将收到一个通用错误页面403 HTTP 状态代码。但是,您可以通过为InvalidSignatureException 异常处理程序中的异常。这个闭包应该返回一个 HTTP 响应:

use Illuminate\Routing\Exceptions\InvalidSignatureException;

/**
 * Register the exception handling callbacks for the application.
 */
public function register(): void
{
    $this->renderable(function (InvalidSignatureException $e) {
        return response()->view('error.link-expired', [], 403);
    });
}

控制器操作的 URL

action 函数为给定的控制器操作生成一个 URL:

use App\Http\Controllers\HomeController;

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

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

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

默认值

对于某些应用程序,您可能希望为某些 URL 参数指定请求范围的默认值。例如,假设您的许多路线定义了一个{locale} 范围:

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

总是通过很麻烦locale 每次你打电话给route 帮手。所以,你可以使用URL::defaults 方法来定义此参数的默认值,该默认值将始终在当前请求期间应用。您可能希望从路由中间件 这样您就可以访问当前请求:

<?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 参数已设置,您不再需要在通过生成 URL 时传递它的值route 帮手。

URL 默认值和中间件优先级

设置 URL 默认值会干扰 Laravel 对隐式模型绑定的处理。因此,你应该优先考虑你的中间件 设置 URL 默认在 Laravel 自己的之前执行SubstituteBindings 中间件。您可以通过确保您的中间件出现在SubstituteBindings 中的中间件$middlewarePriority 应用程序的 HTTP 内核的属性。

$middlewarePriority 属性在基础中定义Illuminate\Foundation\Http\Kernel 班级。您可以从该类复制它的定义并在您的应用程序的 HTTP 内核中覆盖它以修改它:

/**
 * The priority-sorted list of middleware.
 *
 * This forces non-global middleware to always be in the given order.
 *
 * @var array
 */
protected $middlewarePriority = [
    // ...
     \App\Http\Middleware\SetDefaultLocaleForUrls::class,
     \Illuminate\Routing\Middleware\SubstituteBindings::class,
     // ...
];
豫ICP备18041297号-2