61. 路由 路由模型绑定

Laravel框架在PHP开发中使用十分广泛,本文主要对Laravel框架中的路由设置作详细的介绍,Laravel的路由配置非常灵活,如何设置好路由对PHP应用来说也是相当关键的。

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

  • Laravel
    为路由模型绑定提供了一个直接自动将模型实例注入到路由中的方法。

  • Laravel
    会自动解析定义在路由或控制器行为中与类型提示的变量名匹配的路由段名称的
    Eloquent 模型。例如:

图片 1

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

基本路由

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

Route::get('api/users/{user}', function (AppUser $user) {
    return $user->email;
});

您的应用程序的绝大多数路由将在 app/routes.php 文件中定义。Laravel
中最简单的路由由一个 URI 和一个闭包调用组成。

Route::group([‘middleware’ => [‘web’]], function () {
    Route::get(‘/user/{id}’,function($id){
        $user = AppUser::findOrFail($id);
        dd($user);
    });
});

在这个例子中,由于 $user 变量被类型提示为 Eloquent 模型
AppUser,变量名称又与 URI 中的 {user} 匹配,因此,Laravel
会自动注入与请求 URI 中传入的 ID
匹配的用户模型实例。如果在数据库中找不到对应的模型实例,将会自动生成 404
异常。

基本 GET 路由

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

  • 如果你想要模型绑定在检索给定的模型类时使用除 id
    之外的数据库字段,你可以在 Eloquent 模型上重写 getRouteKeyName
    方法:
Route::get('/', function()
{
return 'Hello World';
});

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

基本 POST 路由

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

/**
 * 为路由模型获取键名。
 *
 * @return string
 */
public function getRouteKeyName()
{
    return 'slug';
}
Route::post('foo/bar', function()
{
return 'Hello World';
});

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


注册一个路由以响应所有 HTTP 方法

2、隐式路由模型绑定

Route::get('/users/{user}', 'UsersController@show')->name('users.show');

Route::any('foo', function()
{
   return 'Hello World';
});

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

...
use AppModelsUser;
class UsersController extends Controller
{
    public function create()
    {
        return view('users.create');
    }
    public function show(User $user)
    {
        return view('users.show', compact('user'));
    }
}

强制一个路由必须通过 HTTPS 访问

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

在上面代码中,由于 show() 方法传参时声明了类型 —— Eloquent 模型
User,对应的变量名 $user 会匹配路由片段中的 {user},这样,Laravel
会自动注入与请求 URI 中传入的 ID 对应的用户模型实例。

Route::get('foo', array('https', function()
{
    return 'Must be over HTTPS';
}));

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

我们将用户对象 $user 通过
compact
方法转化为一个关联数组,并作为第二个参数传递给 view
方法,将数据与视图进行绑定。

经常您需要根据路由产生 URLs,您可以通过使用 URL::to 方法:

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

在视图模板中就可以使用 {{ $user->name }} 显示数据内容。

$url = URL::to('foo');

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


路由参数

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

  • 要注册显式绑定,使用路由器的 model 方法来为给定参数指定类。在
    RouteServiceProvider 类中的 boot 方法内定义这些显式模型绑定:
Route::get('user/{id}', function($id)
{
return 'User '.$id;
});

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()
{
    parent::boot();

    Route::model('user', AppUser::class);
}
Route::get('user/{name?}', function($name = null)
{
return $name;
});

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

接着,定义一个包含 {user} 参数的路由:

带默认值的可选的路由参数

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

Route::get('profile/{user}', function (AppUser $user) {
    //
});
Route::get('user/{name?}', function($name = 'John')
{
return $name;
});

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

因为我们已经将所有 {user} 参数绑定至 AppUser 模型,所以 User
实例将被注入该路由。例如,profile/1 的请求会注入数据库中 ID 为 1 的 User
实例。

带正则表达式约束的路由

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

  • 如果你想要使用自定义的解析逻辑,就使用 Route::bind 方法。传递到 bind
    方法的闭包会接受 URI
    中大括号对应的值,并且返回你想要在该路由中注入的类的实例:
Route::get('user/{name}', function($name)
{
//
})
->where('name', '[A-Za-z]+');
Route::get('user/{id}', function($id)
{
//
})
->where('id', '[0-9]+');

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

路由过滤器

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

public function boot()
{
    parent::boot();

    Route::bind('user', function ($value) {
        return AppUser::where('name', $value)->first();
    });
}

路由过滤器提供了一种限制访问指定路由的简单的方法,这在您需要为您的站点创建需要认证区域的时候非常有用。Laravel
框架中包含了一些路由过滤器,比如 auth 过滤器、auth.basic 过滤器、guest
过滤器、以及 csrf 过滤器。它们被存放在 app/filters.php 文件中。

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

定义一个路由过滤器

Route::filter('old', function()
{
if (Input::get('age') < 200)
{
return Redirect::to('home');
}
});

如果一个响应从一个路由过滤器中返回,这个响应即被认为是这个请求的响应,路由将不被执行,任何关于这个路由的
after 过滤器也将被取消执行。

为一个路由指定一个路由过滤器

Route::get('user', array('before' => 'old', function()
{
return 'You are over 200 years old!';
}));

为一个路由指定多个路由过滤器

Route::get('user', array('before' => 'auth|old', function()
{
return 'You are authenticated and over 200 years old!';
}));

指定路由过滤器参数

Route::filter('age', function($route, $request, $value)
{
//
});
Route::get('user', array('before' => 'age:200', function()
{
return 'Hello World';
}));

当路由过滤器接收到作为第三个参数的响应 $response:

Route::filter('log', function($route, $request, $response, $value)
{
//
});

基本路由过滤器的模式

您可能希望根据 URI 为一组路由指定过滤器。

Route::filter('admin', function()
{
//
});
Route::when('admin/*', 'admin');

在上面的例子中,admin 过滤器将应用带所有以 admin/
开头的路由。星号作为一个通配符,将适配到所有字符的组合。

您也可以通过指定 HTTP 方法约束模式过滤器:

Route::when('admin/*', 'admin', array('post'));

过滤器类

对于高级的过滤器,您可以使用一个类代替闭包函数。因为过滤器类是位于应用程序之外的
IoC 容器,您能够在过滤器中使用依赖注入,更易于测试。

定义一个过滤器类

class FooFilter {
public function filter()
{
// Filter logic...
}
}

注册一个基于类的过滤器

Route::filter('foo', 'FooFilter');

命名路由

命名路由在更易于在生成跳转或 URLs
时指定路由。您可以像这样为路由指定一个名字:

Route::get('user/profile', array('as' => 'profile', function()
{
//
}));

您也可以为控制器的方法指定路由名字:

Route::get('user/profile', array('as' => 'profile', 'uses' => 
'UserController@showProfile'));

现在您在生成 URLs 或跳转的时候使用路由的名字:

$url = URL::route('profile');
$redirect = Redirect::route('profile');

您可以使用 currentRouteName 方法获取一个路由的名字:

$name = Route::currentRouteName();

路由组

有些时候您可能希望应用过滤器到一组路由。您不必要为每个路由指定过滤器,可以使用路由组:

Route::group(array('before' => 'auth'), function()
{
Route::get('/', function()
{
// Has Auth Filter
});
Route::get('user/profile', function()
{
// Has Auth Filter
});
});

子域名路由

Laravel 路由也能够处理通配符的子域名,并且从域名中获取通配符参数:

注册子域名路由

Route::group(array('domain' => '{account}.myapp.com'), function()
{
Route::get('user/{id}', function($account, $id)
{
//
});
});

路由前缀

一组路由可以通过在属性数组中使用 prefix 选项为路由组添加前缀:

为路由组添加前缀

Route::group(array('prefix' => 'admin'), function()
{
Route::get('user', function()
{
//
});
});

路由模型绑定

模型绑定提供了一个简单的方法向路由中注入模型。比如,不仅注入一个用户的
ID,您可以根据指定的 ID 注入整个用户模型实例。首先使用 Route::model
方法指定所需要的模型:

为模型绑定一个变量

Route::model('user', 'User');

然后, 定义一个包含 {user} 参数的路由:

Route::get('profile/{user}', function(User $user)
{
//
});

因为我们已经绑定 {user} 参数到 User 模型,一个 User
实例将被注入到路由中。因此,比如一个 profile/1 的请求将注入一个 ID 为 1
的 User 实例。

注意: 如果在数据库中没有找到这个模型实例,将引发404错误。

如果您希望指定您自己定义的没有找到的行为,您可以为 model
方法传递一个闭包作为第三个参数:

Route::model('user', 'User', function()
{
throw new NotFoundException;
});

有时您希望使用自己的方法处理路由参数,可以使用 Route::bind 方法:

Route::bind('user', function($value, $route)
{
return User::where('name', $value)->first();
});

引发404错误

有两种方法在路由中手动触发一个404错误。首先,您可以使用 App::abort
方法:

App::abort(404);

其次,您可以抛出一个
SymfonyComponentHttpKernelExceptionNotFoundHttpException
的实例。

更多关于处理404异常和为这些错误使用使用自定义响应的信息可以在 错误
章节中找到。

路由至控制器

Laravel 不仅允许您路由至闭包,也可以路由至控制器类,甚至允许创建
资源控制器.

发表评论

电子邮件地址不会被公开。 必填项已用*标注