Yii2.0 RESTful Web服务（4）

路由

随着资源和控制器类准备，您可以使用URL如 http://localhost/index.php?r=user/create访问资源，类似于你可以用正常的Web应用程序做法。

在实践中，你通常要用美观的URL并采取有优势的HTTP动词。 例如，请求POST /users意味着访问user/create动作。 这可以很容易地通过配置urlManager应用程序组件来完成 如下所示：

'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        ['class' => 'yii\rest\UrlRule', 'controller' => 'user'],
    ],
]

将enablePrettyUrl设置为true，譬如访问www.xxxxx.com时不会直接显示www.xxxxx.com/site/index.php 而是需要在rules中增加对应的配置。

将enableStrictParsing设置为true，该项表示访问的Url必须至少匹配一个路由规则，否则认定为无效，且在设置enablePrettyUrl为true后生效。

将showScriptName设置为true，表示在Url保留入口脚本index.php。

相比于URL管理的Web应用程序上述主要的新东西是通过RESTful API 请求yii\rest\UrlRule。这个特殊的URL规则类将会 建立一整套子URL规则来支持路由和URL创建的指定的控制器。 例如， 上面的代码中是大致按照下面的规则

:

[
    'PUT,PATCH users/<id>' => 'user/update',
    'DELETE users/<id>' => 'user/delete',
    'GET,HEAD users/<id>' => 'user/view',
    'POST users' => 'user/create',
    'GET,HEAD users' => 'user/index',
    'users/<id>' => 'user/options',
    'users' => 'user/options',
]

该规则支持下面的API末端:

• GET /users: 逐页列出所有用户；
• HEAD /users: 显示用户列表的概要信息；
• POST /users: 创建一个新用户；
• GET /users/123: 返回用户为123的详细信息;
• HEAD /users/123: 显示用户 123 的概述信息;
• PATCH /users/123 and PUT /users/123: 更新用户123;
• DELETE /users/123: 删除用户123;
• OPTIONS /users: 显示关于末端 /users 支持的动词;
• OPTIONS /users/123: 显示有关末端 /users/123 支持的动词。

您可以通过配置 only 和 except 选项来明确列出哪些行为支持， 哪些行为禁用。例如，

[
    'class' => 'yii\rest\UrlRule',
    'controller' => 'user',
    'except' => ['delete', 'create', 'update'],
],

如果UserController是继承自ActiveController，对应的方法的禁用也可以通过yii\rest\ActiveController::actions()方法声明（Yii2.0 RESTful Controller相关）

您也可以通过配置 patterns 或 extraPatterns 重新定义现有的模式或添加此规则支持的新模式。 例如，通过末端 GET /users/search 可以支持新行为 search， 按照如下配置 extraPatterns 选项，

[
    'class' => 'yii\rest\UrlRule',
    'controller' => 'user',
    'extraPatterns' => [
        'GET search' => 'search',
    ],

您可能已经注意到控制器IDuser以复数形式出现在users末端。 这是因为 yii\rest\UrlRule 能够为他们使用的末端全自动复数化控制器ID。 您可以通过设置 yii\rest\UrlRule::pluralize 为false 来禁用此行为，如果您想使用一些特殊的名字您可以通过配置 yii\rest\UrlRule::controller 属性。

yii\rest\UrlRule::controller的值在通常情况下是直接使用了urlManager中配置在rules中的user为前缀，当然Yii2.0也提供了两种自定义方式，一种是传入键值对数组譬如将yii\rest\UrlRule::controller赋值为"['u' => 'user' ]" 这样后续的访问则将u视为控制器id，另外一种则是输入一个数组譬如"['user', 'player']" 这样就会生成所有传入值对应的路由规则。Yii在路由规则这边采用了一种比较简单的的方式进行处理，如果采用简单粗暴的方式，Yii完全可以牺牲一定的开发便利性，在代码层面提高路由规则的性能，例如直接采用正则表达式的方式，但是Yii没有这样做。Yii在urlManager::init()的时候对所有路由进行了缓存，很好的稳定了性能与开发便利性。