URL 生成

Laravel 中文文档 / 基础功能

URL 生成

简介

Laravel 提供了几个方法来帮助您为应用生成 URL。当然,主要用于为模板和 API 响应生成 URL,或者生成到应用的其它部分的重定向响应。

基础

生成基本 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]);

签名的 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]
);

验证签名路由请求

要验证请求是否具有有效的签名,应该调用 RequesthasValidSignature 方法:

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

也可以使用「callable」数组语法来引用操作:

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 方法为该参数定义一个默认值,该值将始终在当前请求期间应用。您可能希望从 路由中间件 中调用该方法,以便可以获取当前请求:

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 时就不再需要传递其值了。

  上一篇 下一篇  

作者:ilaoniu

牛哥,俗称哞哞。单纯的九零后理工小青年。喜欢折腾,爱玩,爱安卓,爱音乐,爱游戏,爱电影,爱旅游...