Yii2.0 RESTful Web服务(3)

在创建资源类和指定资源格输出式化后,下一步就是创建控制器操作将资源通过RESTful APIs展现给终端用户。

Yii
提供两个控制器基类来简化创建RESTful 操作的工作:yii\rest\Controller 和 yii\rest\ActiveController, 两个类的差别是后者提供一系列将资源处理成ActiveRecord(关于ActiveRecord)的操作。
因此如果使用ActiveRecord内置的操作会比较方便,可考虑将控制器类 继承yii\rest\ActiveController,它会让你用最少的代码完成强大的RESTful
APIs.

yii\rest\ActiveController 额外提供一下功能:

  • 一系列常用操作: indexviewcreateupdatedeleteoptions;
  • 对操作和资源进行用户认证.

创建控制器类

当创建一个新的控制器类,控制器类的命名最好使用资源名称的单数格式,例如,提供用户信息的控制器 可命名为UserController.

创建新的操作和Web应用中创建操作类似,唯一的差别是Web应用中调用render()方法渲染一个视图作为返回值, 对于RESTful操作直接返回数据,yii\rest\Controller::serializer
(关于Serializer)和 yii\web\Response 会处理原始数据到请求格式的转换,例如

public function actionView($id)
{
    return User::findOne($id);
}

过滤器

yii\rest\Controller提供的大多数RESTful API功能通过过滤器实现. 特别是以下过滤器会按顺序执行:

  • yii\filters\ContentNegotiator
  • yii\filters\VerbFilter
  • yii\filters\AuthMethod
  • yii\filters\RateLimiter

这些过滤器都在yii\rest\Controller::behaviors()方法中声明, 可覆盖该方法来配置单独的过滤器,禁用某个或增加你自定义的过滤器。 例如,如果你只想用HTTP 基础认证,可编写如下代码:

use yii\filters\auth\HttpBasicAuth;

public function behaviors()
{
    $behaviors = parent::behaviors();
    $behaviors[‘authenticator‘] = [
        ‘class‘ => HttpBasicAuth::className(),
    ];
    return $behaviors;
}

继承 ActiveController

如果你的控制器继承yii\rest\ActiveController,应设置yii\rest\ActiveController::modelClass 属性 为通过该控制器返回给用户的资源类名,该类必须继承yii\db\ActiveRecord.

自定义操作

yii\rest\ActiveController 默认提供一下操作:

  • yii\rest\IndexAction: 按页列出资源;
  • yii\rest\ViewAction: 返回指定资源的详情;
  • yii\rest\CreateAction: 创建新的资源;
  • yii\rest\UpdateAction: 更新一个存在的资源;
  • yii\rest\DeleteAction: 删除指定的资源;
  • yii\rest\OptionsAction: 返回支持的HTTP方法.

所有这些操作通过yii\rest\ActiveController::actions() 方法申明,可覆盖actions()方法配置或禁用这些操作, 如下所示:

public function actions()
{
    $actions = parent::actions();

    // 禁用"delete" 和 "create" 操作
    unset($actions[‘delete‘], $actions[‘create‘]);

    // 使用"prepareDataProvider()"方法自定义数据provider
    $actions[‘index‘][‘prepareDataProvider‘] = [$this, ‘prepareDataProvider‘];

    return $actions;
}

public function prepareDataProvider()
{
    // 为"index"操作准备和返回数据provider
}

执行访问检查

通过RESTful APIs显示数据时,经常需要检查当前用户是否有权限访问和操作所请求的资源, 在yii\rest\ActiveController中,可覆盖yii\rest\ActiveController::checkAccess()方法来完成权限检查。

/**
 * Checks the privilege of the current user. 检查当前用户的权限
 *
 * This method should be overridden to check whether the current user has the privilege
 * to run the specified action against the specified data model.
 * If the user does not have access, a ForbiddenHttpException should be thrown.
 * 本方法应被覆盖来检查当前用户是否有权限执行指定的操作访问指定的数据模型
 * 如果用户没有权限,应抛出一个ForbiddenHttpException异常
 *
 * @param string $action the ID of the action to be executed
 * @param \yii\base\Model $model the model to be accessed. If null, it means no specific model is being accessed.
 * @param array $params additional parameters
 * @throws ForbiddenHttpException if the user does not have access
 */
public function checkAccess($action, $model = null, $params = [])
{
    // 检查用户能否访问 $action 和 $model
    // 访问被拒绝应抛出ForbiddenHttpException
}

checkAccess() 方法默认会被yii\rest\ActiveController默认操作所调用,如果创建新的操作并想执行权限检查, 应在新的操作中明确调用该方法。

相比于Laravel框架的RESTful风格,Yii对于RESTful的封装程度要高的多,譬如说对于接口的声明,Laravel需要在路由设置上花较多的功夫,而Yii的方式则更偏向于RESTful结合MVC的MVC一方,控制器始终占主导地位,由于覆盖了基本的CURD操作,所以说在单表操作的实现方面确实十分简便。

Yii实现的RESTful对于权限的控制是通过ActiveController::checkAccess()的重载实现的,不同的是Laravel则是通过一个Policy的设置,然后在AuthServiceProvider中实现,每一步对应发生的时候都将会检查其安全性,这个也是与ROR多约定少配置的思路吻合的。

时间: 2024-10-11 22:38:15

Yii2.0 RESTful Web服务(3)的相关文章

Yii2.0 RESTful Web服务(4)

路由 随着资源和控制器类准备,您可以使用URL如 http://localhost/index.php?r=user/create访问资源,类似于你可以用正常的Web应用程序做法. 在实践中,你通常要用美观的URL并采取有优势的HTTP动词. 例如,请求POST /users意味着访问user/create动作. 这可以很容易地通过配置urlManager应用程序组件来完成 如下所示: 'urlManager' => [ 'enablePrettyUrl' => true, 'enableSt

Yii2.0 RESTful Web服务(1)

快速入门 Yii 提供了一整套用来简化实现 RESTful 风格的 Web Service 服务的 API. 特别是,Yii 支持以下关于 RESTful 风格的 API: 支持 Active Record 类的通用API的快速原型 涉及的响应格式(在默认情况下支持 JSON 和 XML) 支持可选输出字段的定制对象序列化 适当的格式的数据采集和验证错误 支持 HATEOAS 有适当HTTP动词检查的高效的路由 内置OPTIONS和HEAD动词的支持 认证和授权 数据缓存和HTTP缓存 速率限制

Yii2.0 RESTful Web服务(2)

资源 RESTful 的 API 都是关于访问和操作资源,可将资源看成MVC模式中的Model 在如何代表一个资源没有固定的限定,在Yii中通常使用 yii\base\Model 或它的子类(如 yii\db\ActiveRecord) 代表资源,是为以下原因: yii\base\Model 实现了 yii\base\Arrayable 接口,它允许你通过RESTful API自定义你想要公开的资源数据. yii\base\Model 支持输入验证, 在你的RESTful API需要支持数据输入

Yii2快速构建RESTful Web服务功能简介

Yii2相比Yii1而言,一个重大的改进是内置了功能完备的RESTful支持. 其内置RESTful支持提供了如下功能: 使用ActiveRecord的通用接口来快速构建原型: 应答格式协商(缺省支持 JSON 和 XML): 可定制的对象序列化,支持选择输出哪些列: 请求数据的格式化以及验证错误: 通过HTTP 动词映射实现高效路由: 支持 OPTIONS 和 HEAD 动词: 认证 和 鉴权: 支持 HATEOAS(RESTful的架构约束,超媒体即应用程序状态): 结果缓存,可使用 yii

使用 Jersey 和 Apache Tomcat 构建 RESTful Web 服务

RESTful Web 服务简单介绍 REST 在 2000 年由 Roy Fielding 在博士论文中提出,他是 HTTP 规范 1.0 和 1.1 版的首席作者之中的一个. REST 中最重要的概念是资源(resources),使用全球 ID(通常使用 URI)标识. client应用程序使用 HTTP 方法(GET/ POST/ PUT/ DELETE)操作资源或资源集.RESTful Web 服务是使用 HTTP 和 REST 原理实现的 Web 服务.通常,RESTful Web 服

[译]Spring Boot 构建一个RESTful Web服务

翻译地址:https://spring.io/guides/gs/rest-service/ 构建一个RESTful Web服务 本指南将指导您完成使用spring创建一个“hello world”RESTful Web服务的过程. 你将会构建什么 您将构建一个将接受HTTP GET请求的服务: 您将构建一个将接受HTTP GET请求的服务: http://localhost:8080/greeting 1 1 并且使用JSON的形式进行响应: {"id":1,"conten

分享一个Android和java调用RESTful Web服务的利器Resting

分享一个Android和java调用RESTful Web服务的利器Resting 当我们调用Web服务,往往是最终目标是取HTTP响应,将其转化为将在应用中呈现的值对象.Resting可以用来实现这一功能.Resting,在Java的一个轻量级的REST框架,可用于调用一个RESTful Web服务,并转换成响应来自客户端应用程序定制的Java对象.由于它的简单,resting是适合Android等手持设备. resting目标?暴露简单的get(),post(),put()和delete()

基于jersey和Apache Tomcat构建Restful Web服务(一)

基于jersey和Apache Tomcat构建Restful Web服务(一) 现如今,RESTful架构已然成为了最流行的一种互联网软件架构,它结构清晰.符合标准.易于理解.扩展方便,所以得到越来越多网站的采用.那么问题来了,它是什么呢? 起源 REST(Representational state transfer)在 2000 年由 Roy Fielding 在博士论文中提出,他是 HTTP 规范 1.0 和 1.1 版的首席作者之一. REST 中最重要的概念是资源(resources

基于jersey和Apache Tomcat构建Restful Web服务(二)

基于jersey和Apache Tomcat构建Restful Web服务(二) 上篇博客介绍了REST以及Jersey并使用其搭建了一个简单的“Hello World”,那么本次呢,再来点有趣的东西,当然也是很简单了,仅仅是在路径中包含参数而已了.接下来开始动手实践吧. 在路径中包含参数 接下来就在上次的基础上进行改动即可,或者是再添加一个方法,随意了,这个方法主要就是在路径中加入输入的参数,并且根据参数的不同,它的返回值也不同,返回值为“Hello”+你输入的参数.这里用到了“PathPar