laravel的RESTful实现:RESTful资源控制器-通过laravel 学习RESTful

RESTful 资源控制器

资源控制器让你可以轻松地创建与资源相关的 RESTful 控制器.Laravel 的资源路由将典型的「CURD (增删改查)」路由分配给具有单行代码的控制器。例如,你希望创建一个控制器来处理保存 "照片" 应用的所有 HTTP 请求。使用 Artisan 命令 make:controller ,我们可以快速创建这样一个控制器:

php artisan make:controller PhotoController --resource

这个命令将会生成一个控制器 app/Http/Controllers/PhotoController.php 。其中包括每个可用资源操作的方法。

接下来,你可以给控制器注册一个资源路由:

Route::resource('photos', 'PhotoController');

这个单一的路由声明创建了多个路由来处理资源上的各种行为。用来处理各式各样和相片资源相关的的 RESTful 行为.生成的控制器为每个行为保留了方法,包括了关于处理 HTTP 动词和 URLs 的声明注释。

你可以通过将数组传参到 resources 方法中的方式来一次性的创建多个资源控制器:

 

Route::resources([
    'photos' => 'PhotoController',
    'posts' => 'PostController'
]);

资源控制器操作处理

 

HTTP 方法 URI 动作 含义 路由名称
GET /photos index 查看photos列表 photos.index
GET /photos/create create 打开添加页面 photos.create
POST /photos store 添加保存 photos.store
GET /photos/{photo} show 查看详情 photos.show
GET /photos/{photo}/edit edit 打开编辑页面 photos.edit
PUT/PATCH /photos/{photo} update 编辑保存 photos.update
DELETE /photos/{photo} destroy 删除一个photo photos.destroy

PUT为全部更新,PATCH为部分更新。

指定资源模型

如果你使用了路由模型绑定,并且想在资源控制器的方法中使用类型提示,你可以在生成控制器的时候使用 --model 选项:
php artisan make:controller PhotoController --resource --model=Photo
伪造表单方法
因为 HTML 的表单不能生成 PUTPATCH,和 DELETE 请求,所以你需要添加一个隐藏的 _method 字段来伪造 HTTP 动作。这个 Blade 指令 @method 可以为你创造这个字段:

<form action="/foo/bar" method="POST">
    @method('PUT')
</form>

部分资源路由

当声明资源路由时,你可以指定控制器处理的部分行为,而不是所有默认的行为:

Route::resource('photos', 'PhotoController')->only([
    'index', 'show'
]);

Route::resource('photos', 'PhotoController')->except([
    'create', 'store', 'update', 'destroy'
]);

API 资源路由

当声明用于 APIs 的资源路由时,通常需要排除显示 HTML 模板的路由(如 create 和 edit )。为了方便起见,你可以使用 apiResource 方法自动排除这两个路由:

Route::apiResource('photos', 'PhotoController');

你可以传递一个数组给 apiResources 方法来同时注册多个 API 资源控制器:

Route::apiResources([
    'photos' => 'PhotoController',
    'posts' => 'PostController'
]);

要快速生成不包含 create 或 edit 方法的用于开发接口的资源控制器,请在执行 make:controller 命令时使用 --api 开关:

php artisan make:controller API/PhotoController --api

命名资源路由

默认情况下,所有的资源控制器行为都有一个路由名称。你可以传入 names 数组来覆盖这些名称:

Route::resource('photos', 'PhotoController')->names([
    'create' => 'photos.build'
]);

命名资源路由参数

默认情况下,Route::resource 会根据资源名称的「单数」形式创建资源路由的路由参数。你可以在选项数组中传入 parameters 参数来轻松地覆盖每个资源。parameters 数组应该是资源名称和参数名称的关联数组:

 

Route::resource('users', 'AdminUserController')->parameters([
    'users' => 'admin_user'
]);

上例将会为资源的 show 路由生成如下的 URI :

/users/{admin_user}

本地化资源 URI

默认情况下,Route::resource 将会用英文动词创建资源 URI。如果需要本地化 createedit 行为动作名,可以在 AppServiceProvider boot 中使用 Route::resourceVerbs 方法实现:

 

use Illuminate\Support\Facades\Route;

/**
 * 引导任何应用服务。
 *
 * @return void
 */
public function boot()
{
    Route::resourceVerbs([
        'create' => 'crear',
        'edit' => 'editar',
    ]);
}

动作被自定义后,像 Route::resource('fotos', 'PhotoController') 这样注册的资源路由将会产生如下的 URI:

/fotos/crear

/fotos/{foto}/editar

补充资源控制器

如果你想在默认的资源路由中增加额外的路由,你应该在 Route::resource 之前定义这些路由。否则由 resource 方法定义的路由可能会无意中优先于你补充的路由:

 

Route::get('photos/popular', 'PhotoController@method');

Route::resource('photos', 'PhotoController');

 

以上代码适用于laravel 6.x。

laravel的RESTful实现:RESTful资源控制器-通过laravel 学习RESTful
标签: