Laravel 5.2 新特性系列 —— 隐式路由模型绑定功能实现

Laravel 5.1 中已经提供了路由模型绑定功能,而在 Laravel 5.2中,这一功能实现变得更加简单。

1、路由模型绑定的基本使用

通常我们在URL路由中通过如下方式绑定模型:

Route::group(['middleware' => ['web']], function () {
    Route::get('/user/{id}',function($id){
        $user = \App\User::findOrFail($id);
        dd($user);
    });
});

我一般也是这么实现的,但是如果有一种途径可以去掉findOrFail这一行而直接获取$user实例岂不是更好?实际上, 在Laravel中确实可是实现这一目的,在路由的服务提供者RouteServiceProvider中的boot方法里面添加如下这行代码:

public function boot(Router $router)
{
    $router->model('user',User::class);
    parent::boot($router);
}

这意味着无论何时只要路由中包含参数user,其ID值都对应一个App\User实例,这种机制允许我们重写上述代码如下:

Route::group(['middleware' => ['web']], function () {
    Route::get('/user/{user}',function($user){
        dd($user);
    });
});

2、隐式路由模型绑定

在Laravel 5.2中,使用路由模型绑定更加简单,只需要在路由闭包(或控制器方法)中类型声明参数并且将该参数保持和路由参数一致即可,这样该参数被自动被当作路由模型绑定进行处理(不再需要在RouteServiceProvider中调用model方法声明绑定关系):

Route::group(['middleware' => ['web']], function () {
    Route::get('/user/{user}',function(\App\User $user){
        dd($user);
    });
});

打印结果和之前一模一样。

3、路由模型绑定的一些特性

3.1 自定义路由模型绑定逻辑

如果你想要自定义路由模型绑定逻辑以返回所需要的实例,可以传递一个闭包而不是类名作为显式绑定(相对隐式模型绑定,需要在RouteServiceProviderboot方法中定义绑定关系叫做显式绑定)的第二个参数:

public function boot(Router $router)
{
    $router->bind('user',function($value){
        return User::where('name',$value)->where('status',1)->first();
    });
    parent::boot($router);
}

3.2 自定义路由模型绑定异常

你还可以通过传递一个闭包作为第三个参数来自定义路由模型绑定抛出的异常(比如找不到对应模型实例时):

public function boot(Router $router)
{
    $router->bind('user',User::class,function(){
        throw new NotFoundHttpException;
    });
    parent::boot($router);
}

3.3 修改Eloquent模型的“路由键”

默认情况下,Laravel使用URL片段中的id字段进行Eloquent模型匹配,但是如果你想要自定义这个字段,恰如上面自定义路由模型绑定一样,该怎么实现呢?

Eloquent 实现了Illuminate\Contracts\Routing\UrlRoutable接口,这意味着Eloquent对象有一个getRouteKeyName()方法,在该方法中可以定义在URL中使用哪个字段来匹配模型实例,默认是id,你可以在任意Eloquent模型中重写它:

class User extends Model 
{
    public function getRouteKeyName()
    {
        return 'name';
    }
}

现在,你可以使用显式或隐式路由模型绑定,而且可以自定义URL片段中的匹配字段。

学院君

学院君 has written 548 articles

资深PHP工程师,Laravel学院院长