URL 生成
介绍
Laravel 提供了几个助手来帮助您为应用程序生成 URL。这些在构建模板和 API 响应中的链接时,或在生成重定向响应到应用程序的其他部分时特别有用。
基础
生成基本 URL
url
助手可用于为您的应用程序生成任意 URL。生成的 URL 将自动使用当前请求的方案(HTTP 或 HTTPS)和主机:
$post = App\Post::find(1);
echo url("/posts/{$post->id}");
// http://example.com/posts/1
访问当前 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 () {
//
})->name('post.show');
要生成此路由的 URL,您可以像这样使用 route
助手:
echo route('post.show', ['post' => 1]);
// http://example.com/post/1
您通常会使用 Eloquent 模型 的主键生成 URL。为此,您可以将 Eloquent 模型作为参数值传递。route
助手将自动提取模型的主键:
echo route('post.show', ['post' => $post]);
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
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
方法:
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
错误响应:
Route::post('/unsubscribe/{user}', function (Request $request) {
// ...
})->name('unsubscribe')->middleware('signed');
控制器动作的 URL
action
函数为给定的控制器动作生成 URL。您无需传递控制器的完整命名空间。相反,传递相对于 App\Http\Controllers
命名空间的控制器类名:
$url = action('HomeController@index');
您也可以使用“可调用”数组语法引用动作:
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);
如果控制器方法接受路由参数,您可以将它们作为函数的第二个参数传递:
$url = action('UserController@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
{
public function handle($request, Closure $next)
{
URL::defaults(['locale' => $request->user()->locale]);
return $next($request);
}
}
一旦为 locale
参数设置了默认值,您在通过 route
助手生成 URL 时不再需要传递其值。