生成 URL

未匹配的标注

URL Generation

简介

Laravel 提供了几个辅助函数来为应用程序生成 URL。主要用于在模板和 API 响应中构建 URL 或者在应用程序的其它部分生成重定向响应。

基础

生成 URL

辅助函数 url 可以用于应用的任何一个 URL。 生成的 URL 将自动使用当前请求中的方案 ( HTTP or HTTPS ) 和主机:

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

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

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

访问当前 URL

如果没有给辅助函数 url 提供路径, 则会返回一个 Illuminate\Routing\UrlGenerator 实例,来允许你访问有关当前 URL 的信息:

// 获取当前 URL 没有 query string...
echo url()->current();

// 获取当前 URL 包括 query string...
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 () {
    //
})->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 () {
    //
})->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 Models

您通常会使用 Eloquent 模型 的主键生成 URL。因此,您可以将 Eloquent 模型作为参数值传递。route 辅助函数将自动提取模型的主键:

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

签名 URLs

Laravel 允许你轻松地为命名路径创建「签名」URL,这些 URL 在查询字符串后附加了「签名」哈希,允许 Laravel 验证 URL 自创建以来未被修改过。签名 URL 对于可公开访问但需要一层防止 URL 操作的路由特别有用。

例如,你可以使用签名 URL 来实现通过电子邮件发送给客户的公共「取消订阅」链接。要创建指向路径的签名 URL ,请使用 URL facade 的 signedRoute 方法:

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]
);

验证签名路由请求

要验证传入请求是否具有有效签名,你应该对传入的 Request 调用 hasValidSignature 方法:

use Illuminate\Http\Request;

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

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

或者,你可以将 Illuminate\Routing\Middleware\ValidateSignature 中间件分配给路由。如果它不存在,则应该在 HTTP 内核的 routeMiddleware 数组中为此中间件分配一个键:

/**
 * 路由中间件
 *
 * 这些中间件可以分配给组,也可以单独使用
 *
 * @var array
 */
protected $routeMiddleware = [
    'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
];

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

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

控制器行为的 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');

每次调用route辅助函数时总是需要传递 locale 是很麻烦的。
因此,你可以使用 URL::defaults方法为该参数定义一个默认值,该值将始终在当前请求期间应用。然后就能从 路由中间件 调用此方法来访问当前请求:

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Support\Facades\URL;

class SetDefaultLocaleForUrls
{
    /**
     * 处理传入的请求
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return \Illuminate\Http\Response
     */
    public function handle($request, Closure $next)
    {
        URL::defaults(['locale' => $request->user()->locale]);

        return $next($request);
    }
}

一旦设置了 locale 参数的默认值,在使用辅助函数 route 生成 URL 时,就不需要再传递它的值了。

URL默认值&中间件优先级

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

这个 $middlewarePriority 属性是在基类 Illuminate\Foundation\Http\Kernel 中定义的。你可以从这个类中复制它的定义,并在你的应用程序的 HTTP 内核中重写它,以便修改它:

/**
 * 按优先级排序的中间件列表。
 *
 * 这就可以实现让非全局中间件总是按照给定的顺序运行。
 * 
 * @var array
 */
protected $middlewarePriority = [
    // ...
     \App\Http\Middleware\SetDefaultLocaleForUrls::class,
     \Illuminate\Routing\Middleware\SubstituteBindings::class,
     // ...
];

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

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。
上一篇 下一篇
Summer
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
《G01 Go 实战入门》
从零开始带你一步步开发一个 Go 博客项目,让你在最短的时间内学会使用 Go 进行编码。项目结构很大程度上参考了 Laravel。
贡献者:6
讨论数量: 0
发起讨论 只看当前版本


暂无话题~