Laravel-RestfulAPI 资源控制器

2017-05-11 本文已影响483人科哚洛夫

laravel里有基本控制器和控制器路由。不过我们这里介绍另一种风格－－RESTFul。具体的RESTFul风格及其规范可参考这篇文章：理解RESTful架构

总结一下什么是RESTful架构：

1.每一个URI代表一种资源；
2.客户端和服务器之间，传递这种资源的某种表现层；
3.客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

常见误区：

1.URI包含动词
2.URI中加入版本号

下面我们重点讲解如何创建具有RESTFul风格的控制器

一. 控制器生成

Laravel的资源控制器原生的支持了RESTful架构。其实laravel的资源控制器和其他控制器没什么直接区别，只是对控制器类的方法和结构略有规定，不过我们并不要手动创建资源控制器，我们可以利用laravel的命令行工具——artisan。

到laravel框架项目的根目录下，通过命令行输入命令：

<code>php artisan make:controller MyTestController</code>

注意:在laravel5.1中用php artisan生成的控制器会有默认的方法index、create、show、edit...等等;如果不需要默认的方法，可以通过命令行输入命令：

<code>php artisan make:controller MyTestController --plain</code>

laravel5.2以后生成控制器是默认没有index、create、show、edit..等几个方法的，如果想生成默认的方法可以在laravel框架根目录下，通过命令行输入命令

<code>php artisan make:controller MyTestController --resource</code>

就可以创建一个名为MyTestController的资源控制器，文件默认在app/Http/Controllers下。我们打开MyTestController.php，发现里面已经写好了许多方法，比如index、create、show等等。分别是什么意思？如何在路由定义才能访问到？

我们如果要在路由里定义一个资源控制器只需要一条：

Route::resource('/test', 'MyTestController');

二 .下面介绍下RESTful的跳转规则:


请求URL: /test  
请求方式:GET  
默认进入控制器的方法:index()  
一般用于:页面展示/列表展示

请求URL: /test/creation
请求方式:GET  
默认进入控制器的方法:create()  
一般用于:添加/新建

请求URL: /test  
请求方式:POST  
默认进入控制器的方法:store()

请求URL: /test/{id}/edit  例如: /test/1/edit
请求方式:GET  
默认进入控制器的方法:edit($id)
一般用于:修改页面

请求URL: /test/{id}  
请求方式:PUT  
PUT方法需要定义一个隐藏表单  
<input type="hidden" name="_method" value="PUT"/>  
默认进入控制器的方法:update($id)
一般用于:接收修改的方法

请求URL: /test/{id}  
请求方式:GET  
默认进入控制器的方法:show($id)
一般用于:XX详情

请求URL: /test/{id}  
请求方式:DELETE

PUT方法需要定义一个隐藏表单

<input type="hidden" name="_method" value="DELETE"/>

默认进入控制器的方法:destroy($id)
一般用于:删除
备注：{id}是一个变动的数字,delete()使用要慎用，一般不会去删除数据库数据，而是通过将数据的状态进行修改以此来区分是否删除。

表单伪造 HTML 表单不支持 PUT、PATCH 或者 DELETE 请求方法，因此，当定义 PUT、PATCH 或 DELETE 路由时，需要添加一个隐藏的 _method 字段到表单中，其值被用作该表单的 HTTP 请求方法：

<form action="/foo/bar" method="POST">  
    <input type="hidden" name="_method" value="PUT">
    <input type="hidden" name="_token" value="{{ csrf_token() }}">
</form>

大概举两条解释。我定义了个资源路由

Route::resource('/test', 'MyTestController');

当我访问地址http://www.liutao1995.top/test，相当于访问控制器MyTestController的index方法。
当我访问地址http://www.liutao1995.top/test/creation，就会访问到create方法。
当我通过POST提交数据至地址http://www.liutao1995.top/test，相当于由store方法处理。
现在理解了吗？通过资源控制器，我们很容易实现一个符合RESTful架构的接口，这种很适合作为APP后端开发时使用。这种规范下，不但访问策略清晰易理解，更容易维护。也使你的架构更为合理和现代化。简单举例如果在路由中全部定义
```
  Route::get('/test', 'MyTestController');  
  Route::post('/test', 'MyTestController');  
  Route::get('/testEdit', 'MyTestController@edit');  
  Route::post('/testUp', 'MyTestController@up');  
  Route::controller('/addTest','MyTestController');  
```

和Restful写法(写一个路由可以包含很多种动作,当然有些特定方法不够用的时候也得指定方法)会让臃肿的路由更加简易

    Route::resource('/test', 'TestController');  
    Route::resource('/test_blog', 'TestController@blog');