生成 URL

未匹配的标注
本文档最新版为 10.x,旧版本可能放弃维护,推荐阅读最新版!

生成 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...
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 助手也可用于生成具有多个参数的路由的 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,请使用 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()->addMinutes(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);
}

你可以将 signedIlluminate\Routing\Middleware\ValidateSignature中间件 分配给路由,而不是使用传入请求实例验证签名 URL。如果传入请求没有有效的签名,中间件将自动返回 403 HTTP 响应:

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

如果你的签名 URL 不包含 URL 散列中的域名,则应对中间件提供 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) {
    $exceptions->render(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
{
    /**
     * 处理传入的请求
     *
     * @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 & 中间件优先级

设置 URL 默认值可能会干扰 Laravel 的隐式模型绑定处理。因此,你应该优先执行设置 URL 默认值的中间件,确保它们在 Laravel 自己的 SubstituteBindings 中间件之前被执行。你可以使用应用程序 bootstrap/app.php 文件中的 priority 中间件方法来完成这一点:

->withMiddleware(function (Middleware $middleware) {
    $middleware->priority([
        \Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests::class,
        \Illuminate\Cookie\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \Illuminate\Foundation\Http\Middleware\ValidateCsrfToken::class,
        \Illuminate\Contracts\Auth\Middleware\AuthenticatesRequests::class,
        \Illuminate\Routing\Middleware\ThrottleRequests::class,
        \Illuminate\Routing\Middleware\ThrottleRequestsWithRedis::class,
        \Illuminate\Session\Middleware\AuthenticateSession::class,
        \App\Http\Middleware\SetDefaultLocaleForUrls::class, // [tl! add]
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
        \Illuminate\Auth\Middleware\Authorize::class,
    ]);
})

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://learnku.com/docs/laravel/11.x/ur...

译文地址:https://learnku.com/docs/laravel/11.x/ur...

上一篇 下一篇
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
贡献者:5
讨论数量: 0
发起讨论 只看当前版本


暂无话题~